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

Class RelatedQueriesHandler

java.lang.Object

org.codelibs.fess.api.v2.handlers.RelatedQueriesHandler

public class RelatedQueriesHandler
extends Object

Handles GET /api/v2/related-queries.

Returns related query terms for the given q parameter by delegating to RelatedQueryHelper.getRelatedQueries(String). When q is blank or absent the response contains an empty queries array. The response shape is always a success envelope with status:0:

 { "status": 0, "queries": ["related1", "related2", ...] }
 

This handler is GET-only; other methods are rejected with V2ErrorCode.METHOD_NOT_ALLOWED.

Constructor Summary

Constructors

Constructor	Description
RelatedQueriesHandler()	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	handle(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res)	Processes one GET /api/v2/related-queries request.

Methods inherited from class java.lang.Object

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

Constructor Details

RelatedQueriesHandler

public RelatedQueriesHandler()

Default constructor. The handler is stateless and intended to be instantiated once by the API manager and shared across concurrent requests.

Method Details

handle

public void handle(jakarta.servlet.http.HttpServletRequest req,
 jakarta.servlet.http.HttpServletResponse res)
            throws IOException

Processes one GET /api/v2/related-queries request.

Reads the q query parameter, delegates to RelatedQueryHelper.getRelatedQueries(String), and writes the result as a success envelope. An empty or absent q yields an empty queries array rather than an error.

Parameters:

req - the incoming HTTP request

res - the HTTP response to write to

Throws:

IOException - if writing the envelope fails