Package org.codelibs.fess.api.v2.handlers

Class V2JsonBody

java.lang.Object

org.codelibs.fess.api.v2.handlers.V2JsonBody

public class V2JsonBody
extends Object

Reads a JSON-encoded request body into a Map and returns it.

Rejects payloads larger than maxBytes, content types other than application/json, and malformed JSON. The empty body is treated as an empty map so callers do not need to null-check before lookups.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	V2JsonBody.MalformedJsonException	Thrown when the request body is not parseable as JSON.
static class	V2JsonBody.PayloadTooLargeException	Thrown when the request body exceeds the configured maximum byte size.
static class	V2JsonBody.UnsupportedMediaTypeException	Thrown when the request Content-Type is not application/json.

Constructor Summary

Constructors

Constructor	Description
V2JsonBody()	Creates the v2 JSON body reader.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	read(jakarta.servlet.http.HttpServletRequest req, int maxBytes)	Reads a JSON-encoded request body into a Map<String, Object>.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

V2JsonBody

public V2JsonBody()

Creates the v2 JSON body reader. Registered as the DI component v2JsonBody and obtained via ComponentUtil.getV2JsonBody().

Method Details

read

public Map<String,Object> read(jakarta.servlet.http.HttpServletRequest req,
 int maxBytes)
                        throws IOException

Reads a JSON-encoded request body into a Map<String, Object>.

Enforces the following rules before parsing:

1. Content-Type required: a null or absent Content-Type header is rejected with V2JsonBody.UnsupportedMediaTypeException.
2. application/json only: any Content-Type whose base media type is not application/json is rejected with V2JsonBody.UnsupportedMediaTypeException.
3. UTF-8 charset only: if the Content-Type includes an explicit charset parameter, it must be utf-8 (case-insensitive); any other charset is rejected with V2JsonBody.UnsupportedMediaTypeException.
4. Size limit: bodies longer than maxBytes are rejected with V2JsonBody.PayloadTooLargeException.
5. BOM stripping: a leading UTF-8 BOM (0xEF 0xBB 0xBF) is silently removed before parsing so that editor-generated JSON files are accepted.

Parameters:

req - the incoming HTTP request

maxBytes - maximum accepted body length in bytes

Returns:

parsed body as a map; an empty body returns an empty (immutable) map

Throws:

V2JsonBody.UnsupportedMediaTypeException - if the Content-Type is absent, not application/json, or specifies a non-UTF-8 charset

V2JsonBody.PayloadTooLargeException - if the body exceeds maxBytes

V2JsonBody.MalformedJsonException - if the body is not valid JSON

IOException - if reading the request stream fails