org.finra.herd.rest

Class IndexSearchRestController

java.lang.Object

org.finra.herd.rest.HerdBaseController

org.finra.herd.rest.IndexSearchRestController

@RestController
 @RequestMapping(value="/rest",
                produces={"application/xml","application/json"})
public class IndexSearchRestController
extends HerdBaseController

The REST controller that handles global indexSearch REST requests.

Constructor Summary

Constructors

Constructor and Description
IndexSearchRestController()

Method Summary

Modifier and Type	Method and Description
IndexSearchResponse	indexSearch(Set<String> fields, Set<String> match, IndexSearchRequest request) The index search POST method.

Methods inherited from class org.finra.herd.rest.HerdBaseController

addPagingHttpHeaders, validateNoDuplicateQueryStringParams

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexSearchRestController

public IndexSearchRestController()

Method Detail

indexSearch

@RequestMapping(value="/indexSearch",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_INDEX_SEARCH_POST")
public IndexSearchResponse indexSearch(@RequestParam(value="fields",required=false,defaultValue="")
                                                                                                                                                                                                                   Set<String> fields,
                                                                                                                                                                                                                   @RequestParam(value="match",required=false,defaultValue="")
                                                                                                                                                                                                                   Set<String> match,
                                                                                                                                                                                                                   @RequestBody
                                                                                                                                                                                                                   IndexSearchRequest request)

The index search POST method.

Parameters:

fields - the set of fields that are to be returned in the index search response (accepts: displayname and shortdescription)

match - the set of match fields that the search will be restricted to (accepts: column)

request - the index search request

Returns:

the index search response