org.finra.herd.rest

Class TagRestController

java.lang.Object

org.finra.herd.rest.TagRestController

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

The REST controller that handles tag REST requests.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TAGS_URI_PREFIX

Constructor Summary

Constructors

Constructor and Description
TagRestController()

Method Summary

Modifier and Type	Method and Description
Tag	createTag(TagCreateRequest tagCreateRequest) Creates a new tag.
Tag	deleteTag(String tagTypeCode, String tagCode) Deletes an existing tag.
Tag	getTag(String tagTypeCode, String tagCode) Gets an existing tag.
TagListResponse	getTags(String tagTypeCode, String tagCode) Retrieves all associated tags for the specified tag type code.
TagSearchResponse	searchTags(TagSearchRequest request, Set<String> fields) Retrieves all tags existing in the system per specified search filters and keys.
Tag	updateTag(String tagTypeCode, String tagCode, TagUpdateRequest tagUpdateRequest) Updates an existing tag.

Methods inherited from class java.lang.Object

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

Field Detail

TAGS_URI_PREFIX

public static final String TAGS_URI_PREFIX

See Also:

Constant Field Values

Constructor Detail

TagRestController

public TagRestController()

Method Detail

createTag

@RequestMapping(value="/tags",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_TAGS_POST")
public Tag createTag(@RequestBody
                                                                                                                                                                                  TagCreateRequest tagCreateRequest)

Creates a new tag.

Parameters:

tagCreateRequest - the information needed to create the tag

Returns:

the created tag type

deleteTag

@RequestMapping(value="/tags/tagTypes/{tagTypeCode}/tagCodes/{tagCode}",
                method=DELETE)
 @Secured(value="FN_TAGS_DELETE")
public Tag deleteTag(@PathVariable(value="tagTypeCode")
                                                                                                                                                               String tagTypeCode,
                                                                                                                                                               @PathVariable(value="tagCode")
                                                                                                                                                               String tagCode)

Deletes an existing tag.

Parameters:

tagTypeCode - the tag type code

tagCode - the tag code

Returns:

the deleted tag

getTag

@RequestMapping(value="/tags/tagTypes/{tagTypeCode}/tagCodes/{tagCode}",
                method=GET)
 @Secured(value="FN_TAGS_GET")
public Tag getTag(@PathVariable(value="tagTypeCode")
                                                                                                                                                      String tagTypeCode,
                                                                                                                                                      @PathVariable(value="tagCode")
                                                                                                                                                      String tagCode)

Gets an existing tag.

Parameters:

tagTypeCode - the tag type code

tagCode - the tag code

Returns:

the tag

getTags

@RequestMapping(value="/tags/tagTypes/{tagTypeCode}",
                method=GET)
 @Secured(value="FN_TAGS_ALL_GET")
public TagListResponse getTags(@PathVariable(value="tagTypeCode")
                                                                                                                                                    String tagTypeCode,
                                                                                                                                                    @RequestParam(value="tagCode",required=false)
                                                                                                                                                    String tagCode)

Retrieves all associated tags for the specified tag type code. When tagCode is null, return all tags of the tag type code, which has no parent (i.e. root tags). When tagCode is provided, return all tags of the tag type code and whose parent tag code is tagCode.

Parameters:

tagTypeCode - the tag type's code.

tagCode - the parent tag code.

Returns:

all associated tags, with parent, itself and the children tags with has more children flag.

searchTags

@RequestMapping(value="/tags/search",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_TAGS_SEARCH_POST")
public TagSearchResponse searchTags(@RequestBody
                                                                                                                                                                                                               TagSearchRequest request,
                                                                                                                                                                                                               @RequestParam(value="fields",required=false,defaultValue="")
                                                                                                                                                                                                               Set<String> fields)

Retrieves all tags existing in the system per specified search filters and keys. For each tag entity, this endpoint returns tag key by default along with any other top-level elements as specified by the "fields" query string parameter. The list of tags returned by this endpoint is sorted alphabetically by tag's display name ascending.

Parameters:

request - the tag search request. The request can only accept a single search filter and a single search key

fields - the field options for the tag type search response. The valid field options are: displayName, description, parentTagKey, hasChildren

Returns:

the tag search response

updateTag

@RequestMapping(value="/tags/tagTypes/{tagTypeCode}/tagCodes/{tagCode}",
                method=PUT,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_TAGS_PUT")
public Tag updateTag(@PathVariable(value="tagTypeCode")
                                                                                                                                                                                                                          String tagTypeCode,
                                                                                                                                                                                                                          @PathVariable(value="tagCode")
                                                                                                                                                                                                                          String tagCode,
                                                                                                                                                                                                                          @RequestBody
                                                                                                                                                                                                                          TagUpdateRequest tagUpdateRequest)

Updates an existing tag.

Parameters:

tagTypeCode - the tag type code

tagCode - the tag code

tagUpdateRequest - the information needed to update the tag

Returns:

the updated tag