org.finra.herd.rest

Class SearchIndexRestController

java.lang.Object

org.finra.herd.rest.HerdBaseController

org.finra.herd.rest.SearchIndexRestController

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

The REST controller that handles search index requests.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SEARCH_INDEXES_URI_PREFIX

Constructor Summary

Constructors

Constructor and Description
SearchIndexRestController()

Method Summary

Modifier and Type	Method and Description
SearchIndex	createSearchIndex(SearchIndexCreateRequest request) Creates a new search index.
SearchIndex	deleteSearchIndex(String searchIndexName) Deletes an existing search index by its name.
SearchIndex	getSearchIndex(String searchIndexName) Gets an existing search index by its name.
SearchIndexKeys	getSearchIndexes() Gets a list of search index keys for all search indexes defined in the system.

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

Field Detail

SEARCH_INDEXES_URI_PREFIX

public static final String SEARCH_INDEXES_URI_PREFIX

See Also:

Constant Field Values

Constructor Detail

SearchIndexRestController

public SearchIndexRestController()

Method Detail

createSearchIndex

@RequestMapping(value="/searchIndexes",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_SEARCH_INDEXES_POST")
public SearchIndex createSearchIndex(@RequestBody
                                                                                                                                                                                                                     SearchIndexCreateRequest request)

Creates a new search index.

Parameters:

request - the information needed to create a search index

Returns:

the newly created search index

deleteSearchIndex

@RequestMapping(value="/searchIndexes/{searchIndexName}",
                method=DELETE)
 @Secured(value="FN_SEARCH_INDEXES_DELETE")
public SearchIndex deleteSearchIndex(@PathVariable(value="searchIndexName")
                                                                                                                                                                          String searchIndexName)

Deletes an existing search index by its name.

Parameters:

searchIndexName - the search index name

Returns:

the search index that got deleted

getSearchIndex

@RequestMapping(value="/searchIndexes/{searchIndexName}",
                method=GET)
 @Secured(value="FN_SEARCH_INDEXES_GET")
public SearchIndex getSearchIndex(@PathVariable(value="searchIndexName")
                                                                                                                                                                 String searchIndexName)

Gets an existing search index by its name.

Parameters:

searchIndexName - the name of the search index

Returns:

the retrieved search index

getSearchIndexes

@RequestMapping(value="/searchIndexes",
                method=GET)
 @Secured(value="FN_SEARCH_INDEXES_ALL_GET")
public SearchIndexKeys getSearchIndexes()

Gets a list of search index keys for all search indexes defined in the system.

Returns:

the list of search index keys