org.finra.herd.rest

Class ExpectedPartitionValueRestController

java.lang.Object

org.finra.herd.rest.HerdBaseController

org.finra.herd.rest.ExpectedPartitionValueRestController

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

The REST controller that handles expected partition value REST requests.

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXPECTED_PARTITION_VALUES_URI_PREFIX

Constructor Summary

Constructors

Constructor and Description
ExpectedPartitionValueRestController()

Method Summary

Modifier and Type	Method and Description
ExpectedPartitionValuesInformation	createExpectedPartitionValues(ExpectedPartitionValuesCreateRequest request) Creates a list of expected partition values for an existing partition key group.
ExpectedPartitionValuesInformation	deleteExpectedPartitionValues(ExpectedPartitionValuesDeleteRequest request) Deletes specified expected partition values from an existing partition key group which is identified by name.
ExpectedPartitionValueInformation	getExpectedPartitionValue(String partitionKeyGroupName, String expectedPartitionValue, Integer offset) Retrieves an existing expected partition value plus/minus an optional offset.
ExpectedPartitionValuesInformation	getExpectedPartitionValues(String partitionKeyGroupName, String startExpectedPartitionValue, String endExpectedPartitionValue) Retrieves a range of existing expected partition values.

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

EXPECTED_PARTITION_VALUES_URI_PREFIX

public static final String EXPECTED_PARTITION_VALUES_URI_PREFIX

See Also:

Constant Field Values

Constructor Detail

ExpectedPartitionValueRestController

public ExpectedPartitionValueRestController()

Method Detail

createExpectedPartitionValues

@RequestMapping(value="/expectedPartitionValues",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_EXPECTED_PARTITION_VALUES_POST")
public ExpectedPartitionValuesInformation createExpectedPartitionValues(@RequestBody
                                                                                                                                                                                                                                                                             ExpectedPartitionValuesCreateRequest request)

Creates a list of expected partition values for an existing partition key group.

Parameters:

request - the information needed to create the expected partition values

Returns:

the newly created expected partition values

getExpectedPartitionValue

@RequestMapping(value="/expectedPartitionValues/partitionKeyGroups/{partitionKeyGroupName}/expectedPartitionValues/{expectedPartitionValue}",
                method=GET)
 @Secured(value="FN_EXPECTED_PARTITION_VALUES_GET")
public ExpectedPartitionValueInformation getExpectedPartitionValue(@PathVariable(value="partitionKeyGroupName")
                                                                                                                                                                                                                                                                                                 String partitionKeyGroupName,
                                                                                                                                                                                                                                                                                                 @PathVariable(value="expectedPartitionValue")
                                                                                                                                                                                                                                                                                                 String expectedPartitionValue,
                                                                                                                                                                                                                                                                                                 @RequestParam(value="offset",required=false)
                                                                                                                                                                                                                                                                                                 Integer offset)

Retrieves an existing expected partition value plus/minus an optional offset.

Parameters:

partitionKeyGroupName - the partition key group name

expectedPartitionValue - the expected partition value to retrieve plus/minus an optional offset

offset - the optional positive or negative offset

Returns:

the expected partition value

getExpectedPartitionValues

@RequestMapping(value="/expectedPartitionValues/partitionKeyGroups/{partitionKeyGroupName}",
                method=GET)
 @Secured(value="FN_EXPECTED_PARTITION_VALUES_GET")
public ExpectedPartitionValuesInformation getExpectedPartitionValues(@PathVariable(value="partitionKeyGroupName")
                                                                                                                                                                                                                                                  String partitionKeyGroupName,
                                                                                                                                                                                                                                                  @RequestParam(value="startExpectedPartitionValue",required=false)
                                                                                                                                                                                                                                                  String startExpectedPartitionValue,
                                                                                                                                                                                                                                                  @RequestParam(value="endExpectedPartitionValue",required=false)
                                                                                                                                                                                                                                                  String endExpectedPartitionValue)

Retrieves a range of existing expected partition values.

Parameters:

partitionKeyGroupName - the partition key group name

startExpectedPartitionValue - the start expected partition value for the expected partition value range

endExpectedPartitionValue - the end expected partition value for the expected partition value range

Returns:

the expected partition values

deleteExpectedPartitionValues

@RequestMapping(value="/expectedPartitionValues",
                method=DELETE,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_EXPECTED_PARTITION_VALUES_DELETE")
public ExpectedPartitionValuesInformation deleteExpectedPartitionValues(@RequestBody
                                                                                                                                                                                                                                                                                 ExpectedPartitionValuesDeleteRequest request)

Deletes specified expected partition values from an existing partition key group which is identified by name.

Parameters:

request - the information needed to delete the expected partition values

Returns:

the expected partition values that got deleted