org.finra.herd.rest

Class PartitionKeyGroupRestController

java.lang.Object

org.finra.herd.rest.HerdBaseController

org.finra.herd.rest.PartitionKeyGroupRestController

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

The REST controller that handles partition key group REST requests.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARTITION_KEY_GROUPS_URI_PREFIX

Constructor Summary

Constructors

Constructor and Description
PartitionKeyGroupRestController()

Method Summary

Modifier and Type	Method and Description
PartitionKeyGroup	createPartitionKeyGroup(PartitionKeyGroupCreateRequest request) Creates a new partition key group.
PartitionKeyGroup	deletePartitionKeyGroup(String partitionKeyGroupName) Deletes an existing partition key group by name.
PartitionKeyGroup	getPartitionKeyGroup(String partitionKeyGroupName) Gets an existing partition key group by name.
PartitionKeyGroupKeys	getPartitionKeyGroups() Gets a list of all existing partition key groups.

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

PARTITION_KEY_GROUPS_URI_PREFIX

public static final String PARTITION_KEY_GROUPS_URI_PREFIX

See Also:

Constant Field Values

Constructor Detail

PartitionKeyGroupRestController

public PartitionKeyGroupRestController()

Method Detail

createPartitionKeyGroup

@RequestMapping(value="/partitionKeyGroups",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_PARTITION_KEY_GROUPS_POST")
public PartitionKeyGroup createPartitionKeyGroup(@RequestBody
                                                                                                                                                                                                                                            PartitionKeyGroupCreateRequest request)

Creates a new partition key group.

Parameters:

request - the information needed to create a partition key group

Returns:

the newly created partition key group information

getPartitionKeyGroup

@RequestMapping(value="/partitionKeyGroups/{partitionKeyGroupName}",
                method=GET)
 @Secured(value="FN_PARTITION_KEY_GROUPS_GET")
public PartitionKeyGroup getPartitionKeyGroup(@PathVariable(value="partitionKeyGroupName")
                                                                                                                                                                                              String partitionKeyGroupName)

Gets an existing partition key group by name.

Parameters:

partitionKeyGroupName - the partition key group name

Returns:

the partition key group information

deletePartitionKeyGroup

@RequestMapping(value="/partitionKeyGroups/{partitionKeyGroupName}",
                method=DELETE)
 @Secured(value="FN_PARTITION_KEY_GROUPS_DELETE")
public PartitionKeyGroup deletePartitionKeyGroup(@PathVariable(value="partitionKeyGroupName")
                                                                                                                                                                                                       String partitionKeyGroupName)

Deletes an existing partition key group by name.

Parameters:

partitionKeyGroupName - the partition key group name

Returns:

the partition key group that got deleted

getPartitionKeyGroups

@RequestMapping(value="/partitionKeyGroups",
                method=GET)
 @Secured(value="FN_PARTITION_KEY_GROUPS_ALL_GET")
public PartitionKeyGroupKeys getPartitionKeyGroups()

Gets a list of all existing partition key groups.

Returns:

the partition key groups