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

Class V2JsonRequestParams

java.lang.Object

org.codelibs.fess.entity.SearchRequestParams

org.codelibs.fess.api.v2.handlers.V2JsonRequestParams

public class V2JsonRequestParams
extends SearchRequestParams

Search request parameters for the /api/v2 surface.

Mirrors v1's SearchApiManager.JsonRequestParams inner class so the underlying SearchHelper.search(org.codelibs.fess.entity.SearchRequestParams, org.codelibs.fess.entity.SearchRenderData, org.dbflute.optional.OptionalThing<org.codelibs.fess.mylasta.action.FessUserBean>) contract stays stable across versions. Promoted to a top-level class so individual v2 handlers (search, scroll, …) can construct it without depending on the monolithic manager. The wire-level parameter names match v1 exactly (q, start, num, offset, ex_q, fields.*, as.*, lang, sort, sdh) so existing clients keep working.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	V2JsonRequestParams.InvalidOffsetException	Thrown by getOffset() or getStartPosition() when the offset / start parameter is present but negative.
static class	V2JsonRequestParams.InvalidPageSizeException	Thrown by getPageSize() when the num parameter is present but <= 0.

Nested classes/interfaces inherited from class org.codelibs.fess.entity.SearchRequestParams

SearchRequestParams.SearchRequestType

Field Summary

Fields inherited from class org.codelibs.fess.entity.SearchRequestParams

AS_EPQ, AS_FILETYPE, AS_NQ, AS_OCCURRENCE, AS_OQ, AS_Q, AS_SITESEARCH, AS_TIMESTAMP

Constructor Summary

Constructors

Constructor	Description
V2JsonRequestParams(jakarta.servlet.http.HttpServletRequest request, org.codelibs.fess.mylasta.direction.FessConfig fessConfig)	Constructs a v2 request-params adapter over an incoming HTTP request.

Method Summary

Modifier and Type	Method	Description
Object	getAttribute(String name)	Returns the attribute.
Map<String,String[]>	getConditions()	Returns the conditions.
String[]	getExtraQueries()	Returns the extra queries.
FacetInfo	getFacetInfo()	Returns the facet info.
Map<String,String[]>	getFields()	Returns the fields.
GeoInfo	getGeoInfo()	Returns the geo info.
HighlightInfo	getHighlightInfo()	Returns the highlight info.
String[]	getLanguages()	Returns the languages.
Locale	getLocale()	Returns the locale.
int	getOffset()	Returns the offset parameter from the request, defaulting to 0 when missing or non-numeric.
int	getPageSize()	Returns the requested page size, validated and bounded by the Fess configuration.
String	getQuery()	Returns the query.
String	getSimilarDocHash()	Returns the similar document hash.
String	getSort()	Returns the sort.
int	getStartPosition()	Returns the start parameter from the request, defaulting to the configured paging.search.page.start when missing or malformed.
String	getTrackTotalHits()	Returns the track total hits.
SearchRequestParams.SearchRequestType	getType()	Returns the search request type.

Methods inherited from class org.codelibs.fess.entity.SearchRequestParams

createFacetInfo, createGeoInfo, getMinScore, getParamValueArray, getResponseFields, hasConditionQuery, isEmptyArray, simplifyArray

Methods inherited from class java.lang.Object

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

Constructor Details

V2JsonRequestParams

public V2JsonRequestParams(jakarta.servlet.http.HttpServletRequest request,
 org.codelibs.fess.mylasta.direction.FessConfig fessConfig)

Constructs a v2 request-params adapter over an incoming HTTP request.

Parameters:

request - the incoming HTTP request whose parameters are read on demand

fessConfig - the Fess configuration used to source default paging values

Method Details

getTrackTotalHits

public String getTrackTotalHits()

Description copied from class: SearchRequestParams

Returns the track total hits.

Overrides:

getTrackTotalHits in class SearchRequestParams

Returns:

The track total hits.

getQuery

public String getQuery()

Description copied from class: SearchRequestParams

Returns the query.

Specified by:

getQuery in class SearchRequestParams

Returns:

The query.

getExtraQueries

public String[] getExtraQueries()

Description copied from class: SearchRequestParams

Returns the extra queries.

Specified by:

getExtraQueries in class SearchRequestParams

Returns:

The extra queries.

getFields

public Map<String,String[]> getFields()

Description copied from class: SearchRequestParams

Returns the fields.

Specified by:

getFields in class SearchRequestParams

Returns:

The fields.

getConditions

public Map<String,String[]> getConditions()

Description copied from class: SearchRequestParams

Returns the conditions.

Specified by:

getConditions in class SearchRequestParams

Returns:

The conditions.

getLanguages

public String[] getLanguages()

Description copied from class: SearchRequestParams

Returns the languages.

Specified by:

getLanguages in class SearchRequestParams

Returns:

The languages.

getGeoInfo

public GeoInfo getGeoInfo()

Description copied from class: SearchRequestParams

Returns the geo info.

Specified by:

getGeoInfo in class SearchRequestParams

Returns:

The geo info.

getFacetInfo

public FacetInfo getFacetInfo()

Description copied from class: SearchRequestParams

Returns the facet info.

Specified by:

getFacetInfo in class SearchRequestParams

Returns:

The facet info.

getSort

public String getSort()

Description copied from class: SearchRequestParams

Returns the sort.

Specified by:

getSort in class SearchRequestParams

Returns:

The sort.

getStartPosition

public int getStartPosition()

Returns the start parameter from the request, defaulting to the configured paging.search.page.start when missing or malformed.

The parsed value is cached after the first call so concurrent paging fields can read it without re-parsing. A negative start is rejected with V2JsonRequestParams.InvalidOffsetException — historically the -1 sentinel meant "uninitialised", which collided with a client legitimately requesting -1; the sentinel is now an explicit startPositionInitialized flag.

Specified by:

getStartPosition in class SearchRequestParams

Returns:

the validated, non-negative start position

Throws:

V2JsonRequestParams.InvalidOffsetException - if start is present and < 0

getOffset

public int getOffset()

Returns the offset parameter from the request, defaulting to 0 when missing or non-numeric.

The parsed value is cached after the first call. A negative offset is rejected with V2JsonRequestParams.InvalidOffsetException — historically the -1 sentinel meant "uninitialised", which collided with a client legitimately passing -1. Caching is now driven by an explicit offsetInitialized flag.

Specified by:

getOffset in class SearchRequestParams

Returns:

the validated, non-negative offset

Throws:

V2JsonRequestParams.InvalidOffsetException - if offset is present and < 0

getPageSize

public int getPageSize()

Returns the requested page size, validated and bounded by the Fess configuration.

Contract:

• Missing or blank num: returns the configured default page size.
• Non-numeric num: returns the configured default page size.
• num <= 0: throws V2JsonRequestParams.InvalidPageSizeException — zero and negative values are not meaningful and likely indicate a client bug; rejecting them early prevents silent amplification to the configured maximum.
• num > max: clamps silently to the configured maximum. Clients can detect clamping by comparing the request num with the page_size field returned in the response envelope.
• 1 <= num <= max: returned unchanged.

Specified by:

getPageSize in class SearchRequestParams

Returns:

validated page size in the range [1, configuredMax]

Throws:

V2JsonRequestParams.InvalidPageSizeException - if num is present and <= 0

getAttribute

public Object getAttribute(String name)

Description copied from class: SearchRequestParams

Returns the attribute.

Specified by:

getAttribute in class SearchRequestParams

Parameters:

name - The name of the attribute.

Returns:

The attribute.

getLocale

public Locale getLocale()

Description copied from class: SearchRequestParams

Returns the locale.

Specified by:

getLocale in class SearchRequestParams

Returns:

The locale.

getType

public SearchRequestParams.SearchRequestType getType()

Description copied from class: SearchRequestParams

Returns the search request type.

Specified by:

getType in class SearchRequestParams

Returns:

The search request type.

getSimilarDocHash

public String getSimilarDocHash()

Description copied from class: SearchRequestParams

Returns the similar document hash.

Specified by:

getSimilarDocHash in class SearchRequestParams

Returns:

The similar document hash.

getHighlightInfo

public HighlightInfo getHighlightInfo()

Description copied from class: SearchRequestParams

Returns the highlight info.

Specified by:

getHighlightInfo in class SearchRequestParams

Returns:

The highlight info.