Package org.codelibs.fess.api.json

Class SearchApiManager

java.lang.Object

org.codelibs.fess.api.BaseApiManager

org.codelibs.fess.api.json.SearchApiManager

All Implemented Interfaces:

WebApiManager

public class SearchApiManager
extends BaseApiManager

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	SearchApiManager.JsonRequestParams
protected static class	SearchApiManager.RequestParameter

Nested classes/interfaces inherited from class org.codelibs.fess.api.BaseApiManager

BaseApiManager.FormatType

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	GET
protected static final String	MESSAGE_FIELD
protected String	mimeType
protected static final String	POST
protected static final String	RESULT_FIELD

Fields inherited from class org.codelibs.fess.api.BaseApiManager

pathPrefix

Constructor Summary

Constructors

Constructor	Description
SearchApiManager()

Method Summary

Modifier and Type	Method	Description
protected boolean	acceptHttpMethod(jakarta.servlet.http.HttpServletRequest request, String... methods)
protected String	detailedMessage(Throwable t)
protected BaseApiManager.FormatType	detectFormatType(jakarta.servlet.http.HttpServletRequest request)
protected String	escapeCallbackName(String callbackName)
protected String	escapeJson(Object obj)
protected String	escapeJsonKeyValue(String key, String value)
boolean	matches(jakarta.servlet.http.HttpServletRequest request)
void	process(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.FilterChain chain)
protected void	processFavoriteRequest(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.FilterChain chain)
protected void	processFavoritesRequest(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.FilterChain chain)
protected void	processLabelRequest(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.FilterChain chain)
protected void	processPingRequest(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.FilterChain chain)
protected void	processPopularWordRequest(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.FilterChain chain)
protected void	processScrollSearchRequest(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.FilterChain chain)
protected void	processSearchRequest(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.FilterChain chain)
protected void	processSuggestRequest(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.FilterChain chain)
void	register()
void	setMimeType(String mimeType)
protected void	writeHeaders(jakarta.servlet.http.HttpServletResponse response)
protected void	writeJsonResponse(int status, String body)
protected void	writeJsonResponse(int status, Throwable t)

Methods inherited from class org.codelibs.fess.api.BaseApiManager

getFormatType, getPathPrefix, setPathPrefix, write

Methods inherited from class java.lang.Object

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

Field Details

MESSAGE_FIELD

protected static final String MESSAGE_FIELD

See Also:

• Constant Field Values

RESULT_FIELD

protected static final String RESULT_FIELD

See Also:

• Constant Field Values

GET

protected static final String GET

See Also:

• Constant Field Values

POST

protected static final String POST

See Also:

• Constant Field Values

mimeType

protected String mimeType

Constructor Details

SearchApiManager

public SearchApiManager()

Method Details

register

@PostConstruct
public void register()

detectFormatType

protected BaseApiManager.FormatType detectFormatType(jakarta.servlet.http.HttpServletRequest request)

Overrides:

detectFormatType in class BaseApiManager

matches

public boolean matches(jakarta.servlet.http.HttpServletRequest request)

process

public void process(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 jakarta.servlet.FilterChain chain)
             throws IOException,
jakarta.servlet.ServletException

Throws:

IOException

jakarta.servlet.ServletException

acceptHttpMethod

protected boolean acceptHttpMethod(jakarta.servlet.http.HttpServletRequest request,
 String... methods)

processScrollSearchRequest

protected void processScrollSearchRequest(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 jakarta.servlet.FilterChain chain)

processPingRequest

protected void processPingRequest(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 jakarta.servlet.FilterChain chain)

processSearchRequest

protected void processSearchRequest(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 jakarta.servlet.FilterChain chain)

detailedMessage

protected String detailedMessage(Throwable t)

processLabelRequest

protected void processLabelRequest(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 jakarta.servlet.FilterChain chain)

processPopularWordRequest

protected void processPopularWordRequest(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 jakarta.servlet.FilterChain chain)

processFavoriteRequest

protected void processFavoriteRequest(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 jakarta.servlet.FilterChain chain)

processFavoritesRequest

protected void processFavoritesRequest(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 jakarta.servlet.FilterChain chain)

processSuggestRequest

protected void processSuggestRequest(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 jakarta.servlet.FilterChain chain)
                              throws IOException,
jakarta.servlet.ServletException

Throws:

IOException

jakarta.servlet.ServletException

writeHeaders

protected void writeHeaders(jakarta.servlet.http.HttpServletResponse response)

Specified by:

writeHeaders in class BaseApiManager

writeJsonResponse

protected void writeJsonResponse(int status,
 Throwable t)

escapeJsonKeyValue

protected String escapeJsonKeyValue(String key,
 String value)

writeJsonResponse

protected void writeJsonResponse(int status,
 String body)

escapeCallbackName

protected String escapeCallbackName(String callbackName)

escapeJson

protected String escapeJson(Object obj)

setMimeType

public void setMimeType(String mimeType)