org.craftercms.search.rest.controller.v1

Class SearchRestController

java.lang.Object

org.craftercms.search.rest.controller.v1.SearchRestController

@Controller
 @RequestMapping(value="/api/1/search")
public class SearchRestController
extends Object

REST controller for the search service.

Author:

Alfonso Vásquez, Dejan Brkic

Field Summary

Fields

Modifier and Type	Field and Description
protected String	multiValueIgnorePattern
protected String	multiValueSeparator
protected SearchService	searchService

Constructor Summary

Constructors

Constructor and Description
SearchRestController()

Method Summary

Modifier and Type	Method and Description
String	commit(String indexId)
String	delete(String indexId, String site, String id)
protected org.springframework.util.MultiValueMap<String,String>	getAdditionalFields(javax.servlet.http.HttpServletRequest request, boolean splitParams)
protected String	getSuccessMessage(String message, String indexId, String site, String path)
Map<String,Object>	search(String indexId, javax.servlet.http.HttpServletRequest request)
void	setMultiValueIgnorePattern(String multiValueIgnorePattern)
void	setMultiValueSeparator(String multiValueSeparator)
void	setSearchService(SearchService searchService)
String	update(String indexId, String site, String id, boolean ignoreRootInFieldNames, String xml)
protected String	updateContent(String indexId, String site, String id, org.springframework.web.multipart.MultipartFile file, javax.servlet.http.HttpServletRequest request, boolean splitParams)
String	updateDocument(String site, String id, org.springframework.web.multipart.MultipartFile document, javax.servlet.http.HttpServletRequest request) Deprecated.
String	updateFile(String indexId, String site, String id, org.springframework.web.multipart.MultipartFile file, javax.servlet.http.HttpServletRequest request)

Methods inherited from class java.lang.Object

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

Field Detail

searchService

protected SearchService searchService

multiValueSeparator

protected String multiValueSeparator

multiValueIgnorePattern

protected String multiValueIgnorePattern

Constructor Detail

SearchRestController

public SearchRestController()

Method Detail

setSearchService

public void setSearchService(SearchService searchService)

setMultiValueSeparator

public void setMultiValueSeparator(String multiValueSeparator)

setMultiValueIgnorePattern

public void setMultiValueIgnorePattern(String multiValueIgnorePattern)

search

@RequestMapping(value="/search",
                method=GET)
 @ResponseBody
public Map<String,Object> search(@RequestParam(value="indexId",required=false)
                                                                                                             String indexId,
                                                                                                             javax.servlet.http.HttpServletRequest request)
                                                                                                      throws SearchException

Throws:

SearchException

update

@RequestMapping(value="/update",
                method=POST)
 @ResponseBody
public String update(@RequestParam(value="indexId",required=false)
                                                                                                  String indexId,
                                                                                                  @RequestParam(value="site")
                                                                                                  String site,
                                                                                                  @RequestParam(value="id")
                                                                                                  String id,
                                                                                                  @RequestParam(value="stripRoot")
                                                                                                  boolean ignoreRootInFieldNames,
                                                                                                  @RequestBody
                                                                                                  String xml)
                                                                                           throws SearchException

Throws:

SearchException

delete

@RequestMapping(value="/delete",
                method=POST)
 @ResponseBody
public String delete(@RequestParam(value="indexId",required=false)
                                                                                                  String indexId,
                                                                                                  @RequestParam(value="site")
                                                                                                  String site,
                                                                                                  @RequestParam(value="id")
                                                                                                  String id)
                                                                                           throws SearchException

Throws:

SearchException

commit

@RequestMapping(value="/commit",
                method=POST)
 @ResponseBody
public String commit(@RequestParam(value="indexId",required=false)
                                                                                                  String indexId)
                                                                                           throws SearchException

Throws:

SearchException

updateDocument

@RequestMapping(value={"/update-document","/partial-document-update"},
                method=POST)
 @ResponseBody
 @Deprecated
public String updateDocument(@RequestPart(value="site")
                                                                                                                                                             String site,
                                                                                                                                                             @RequestPart(value="id")
                                                                                                                                                             String id,
                                                                                                                                                             @RequestPart(value="document")
                                                                                                                                                             org.springframework.web.multipart.MultipartFile document,
                                                                                                                                                             javax.servlet.http.HttpServletRequest request)
                                                                                                                                                      throws SearchException

Deprecated.

Throws:

SearchException

updateFile

@RequestMapping(value="/update-file",
                method=POST)
 @ResponseBody
public String updateFile(@RequestParam(value="indexId",required=false)
                                                                                                           String indexId,
                                                                                                           @RequestPart(value="site")
                                                                                                           String site,
                                                                                                           @RequestPart(value="id")
                                                                                                           String id,
                                                                                                           @RequestPart(value="document")
                                                                                                           org.springframework.web.multipart.MultipartFile file,
                                                                                                           javax.servlet.http.HttpServletRequest request)
                                                                                                    throws SearchException

Throws:

SearchException

updateContent

protected String updateContent(String indexId,
                               String site,
                               String id,
                               org.springframework.web.multipart.MultipartFile file,
                               javax.servlet.http.HttpServletRequest request,
                               boolean splitParams)

getAdditionalFields

protected org.springframework.util.MultiValueMap<String,String> getAdditionalFields(javax.servlet.http.HttpServletRequest request,
                                                                                    boolean splitParams)

getSuccessMessage

protected String getSuccessMessage(String message,
                                   String indexId,
                                   String site,
                                   String path)