org.craftercms.search.controller

Class SearchRestController

java.lang.Object

org.craftercms.search.controller.SearchRestController

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

REST controller for the search service.

Author:

Alfonso Vásquez, Dejan Brkic

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 Map<String,String>	getAdditionalFields(javax.servlet.http.HttpServletRequest request)
protected org.springframework.util.MultiValueMap<String,String>	getAdditionalMultiValueFields(javax.servlet.http.HttpServletRequest request)
void	handleException(Exception e, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
Map<String,Object>	search(String indexId, javax.servlet.http.HttpServletRequest request)
void	setQueryFactory(QueryFactory<Query> queryFactory)
void	setSearchService(SearchService searchService)
String	update(String indexId, String site, String id, boolean ignoreRootInFieldNames, String xml)
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

Constructor Detail

SearchRestController

public SearchRestController()

Method Detail

setSearchService

public void setSearchService(SearchService searchService)

setQueryFactory

public void setQueryFactory(QueryFactory<Query> queryFactory)

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

handleException

@ExceptionHandler(value=java.lang.Exception.class)
public void handleException(Exception e,
                                                                               javax.servlet.http.HttpServletRequest request,
                                                                               javax.servlet.http.HttpServletResponse response)
                                                                        throws IOException

Throws:

IOException

getAdditionalFields

protected Map<String,String> getAdditionalFields(javax.servlet.http.HttpServletRequest request)

getAdditionalMultiValueFields

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