Package org.craftercms.engine.controller.rest

Class SiteSearchController

java.lang.Object

org.craftercms.core.controller.rest.RestControllerBase

org.craftercms.engine.controller.rest.SiteSearchController

@CrafterRestController
@RequestMapping({"${crafter.core.rest.base.uri}/site/search","${crafter.core.rest.base.uri}/site/elasticsearch"})
public class SiteSearchController
extends org.craftercms.core.controller.rest.RestControllerBase

REST controller to expose the Search service

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
protected final com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected final List<Pattern>	restrictedKeyPatterns
protected final SiteAwareOpenSearchService	searchService
static final String	URL_ES_ROOT
static final String	URL_ROOT
static final String	URL_SEARCH

Fields inherited from class org.craftercms.core.controller.rest.RestControllerBase

MESSAGE_MODEL_ATTRIBUTE_NAME, REST_BASE_URI

Constructor Summary

Constructors

Constructor	Description
SiteSearchController(SiteAwareOpenSearchService searchService, com.fasterxml.jackson.databind.ObjectMapper objectMapper, String[] restrictedKeyPatterns)

Method Summary

Modifier and Type	Method	Description
void	search(com.fasterxml.jackson.databind.JsonNode request, Map<String,Object> parameters, jakarta.servlet.http.HttpServletResponse response)

Methods inherited from class org.craftercms.core.controller.rest.RestControllerBase

createResponseMessage, createSingletonModifiableMap

Methods inherited from class java.lang.Object

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

Field Details

URL_ROOT

public static final String URL_ROOT

See Also:

• Constant Field Values

URL_ES_ROOT

public static final String URL_ES_ROOT

See Also:

• Constant Field Values

URL_SEARCH

public static final String URL_SEARCH

See Also:

• Constant Field Values

searchService

protected final SiteAwareOpenSearchService searchService

objectMapper

protected final com.fasterxml.jackson.databind.ObjectMapper objectMapper

restrictedKeyPatterns

protected final List<Pattern> restrictedKeyPatterns

Constructor Details

SiteSearchController

@ConstructorProperties({"searchService","objectMapper","restrictedKeyPatterns"})
public SiteSearchController(SiteAwareOpenSearchService searchService,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 String[] restrictedKeyPatterns)

Method Details

search

@PostMapping(value="/search",
             consumes="application/json")
public void search(@RequestBody
 com.fasterxml.jackson.databind.JsonNode request,
 @RequestParam
 Map<String,Object> parameters,
 jakarta.servlet.http.HttpServletResponse response)
            throws IOException

Throws:

IOException