org.finra.herd.rest

Class StorageUnitNotificationRegistrationRestController

java.lang.Object

org.finra.herd.rest.HerdBaseController

org.finra.herd.rest.StorageUnitNotificationRegistrationRestController

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

The REST controller that handles storage unit notification REST requests.

Field Summary

Fields

Modifier and Type	Field and Description
static String	STORAGE_UNIT_NOTIFICATIONS_URI_PREFIX

Constructor Summary

Constructors

Constructor and Description
StorageUnitNotificationRegistrationRestController()

Method Summary

Modifier and Type	Method and Description
StorageUnitNotificationRegistration	createStorageUnitNotificationRegistration(StorageUnitNotificationRegistrationCreateRequest request) Creates a new storage unit notification registration.
StorageUnitNotificationRegistration	deleteStorageUnitNotification(String namespace, String notificationName) Deletes an existing storage unit notification registration by key.
StorageUnitNotificationRegistration	getStorageUnitNotificationRegistration(String namespace, String notificationName) Gets an existing storage unit notification registration by key.
StorageUnitNotificationRegistrationKeys	getStorageUnitNotificationRegistrationsByNamespace(String namespace) Gets a list of keys for all existing storage unit notification registrations for the specified storage unit notification registration namespace.
StorageUnitNotificationRegistrationKeys	getStorageUnitNotificationRegistrationsByNotificationFilter(String businessObjectDefinitionNamespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, javax.servlet.ServletRequest servletRequest) Gets a list of keys for all existing storage unit notification registrations that match the specified storage unit notification filter parameters.
StorageUnitNotificationRegistration	updateStorageUnitNotificationRegistration(String namespace, String notificationName, StorageUnitNotificationRegistrationUpdateRequest request) Updates an existing storage unit notification registration by key.

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

STORAGE_UNIT_NOTIFICATIONS_URI_PREFIX

public static final String STORAGE_UNIT_NOTIFICATIONS_URI_PREFIX

See Also:

Constant Field Values

Constructor Detail

StorageUnitNotificationRegistrationRestController

public StorageUnitNotificationRegistrationRestController()

Method Detail

createStorageUnitNotificationRegistration

@RequestMapping(value="/notificationRegistrations/storageUnitNotificationRegistrations",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_STORAGE_UNIT_NOTIFICATION_REGISTRATIONS_POST")
public StorageUnitNotificationRegistration createStorageUnitNotificationRegistration(@RequestBody
                                                                                                                                                                                                                                                                                                                                               StorageUnitNotificationRegistrationCreateRequest request)

Creates a new storage unit notification registration.

Requires WRITE permission on namespace

Requires READ permission on filter namespace

Requires EXECUTE permission on ALL job action namespaces

Parameters:

request - the information needed to create the storage unit notification registration

Returns:

the created storage unit notification registration

deleteStorageUnitNotification

@RequestMapping(value="/notificationRegistrations/storageUnitNotificationRegistrations/namespaces/{namespace}/notificationNames/{notificationName}",
                method=DELETE)
 @Secured(value="FN_STORAGE_UNIT_NOTIFICATION_REGISTRATIONS_DELETE")
public StorageUnitNotificationRegistration deleteStorageUnitNotification(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                                  String namespace,
                                                                                                                                                                                                                                                                                                                                  @PathVariable(value="notificationName")
                                                                                                                                                                                                                                                                                                                                  String notificationName)

Deletes an existing storage unit notification registration by key.

Requires WRITE permission on namespace

Parameters:

namespace - the namespace of the storage unit notification registration

notificationName - the name of the storage unit notification registration

Returns:

the storage unit notification registration that got deleted

getStorageUnitNotificationRegistration

@RequestMapping(value="/notificationRegistrations/storageUnitNotificationRegistrations/namespaces/{namespace}/notificationNames/{notificationName}",
                method=GET)
 @Secured(value="FN_STORAGE_UNIT_NOTIFICATION_REGISTRATIONS_GET")
public StorageUnitNotificationRegistration getStorageUnitNotificationRegistration(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                                     String namespace,
                                                                                                                                                                                                                                                                                                                                     @PathVariable(value="notificationName")
                                                                                                                                                                                                                                                                                                                                     String notificationName)

Gets an existing storage unit notification registration by key.

Requires READ permission on namespace

Parameters:

namespace - the namespace of the storage unit notification registration

notificationName - the name of the storage unit notification registration

Returns:

the retrieved storage unit notification registration

getStorageUnitNotificationRegistrationsByNamespace

@RequestMapping(value="/notificationRegistrations/storageUnitNotificationRegistrations/namespaces/{namespace}",
                method=GET)
 @Secured(value="FN_STORAGE_UNIT_NOTIFICATION_REGISTRATIONS_BY_NAMESPACE_GET")
public StorageUnitNotificationRegistrationKeys getStorageUnitNotificationRegistrationsByNamespace(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                             String namespace)

Gets a list of keys for all existing storage unit notification registrations for the specified storage unit notification registration namespace.

Parameters:

namespace - the namespace of the storage unit notification registration

Returns:

the storage unit notification registration keys

getStorageUnitNotificationRegistrationsByNotificationFilter

@RequestMapping(value="/notificationRegistrations/storageUnitNotificationRegistrations",
                method=GET)
 @Secured(value="FN_STORAGE_UNIT_NOTIFICATION_REGISTRATIONS_BY_NOTIFICATION_FILTER_GET")
public StorageUnitNotificationRegistrationKeys getStorageUnitNotificationRegistrationsByNotificationFilter(@RequestParam(value="businessObjectDefinitionNamespace",required=true)
                                                                                                                                                                                                                                                                                                                         String businessObjectDefinitionNamespace,
                                                                                                                                                                                                                                                                                                                         @RequestParam(value="businessObjectDefinitionName",required=true)
                                                                                                                                                                                                                                                                                                                         String businessObjectDefinitionName,
                                                                                                                                                                                                                                                                                                                         @RequestParam(value="businessObjectFormatUsage",required=false)
                                                                                                                                                                                                                                                                                                                         String businessObjectFormatUsage,
                                                                                                                                                                                                                                                                                                                         @RequestParam(value="businessObjectFormatFileType",required=false)
                                                                                                                                                                                                                                                                                                                         String businessObjectFormatFileType,
                                                                                                                                                                                                                                                                                                                         javax.servlet.ServletRequest servletRequest)

Gets a list of keys for all existing storage unit notification registrations that match the specified storage unit notification filter parameters.

This endpoint requires both namespace and name of the business object definition.

Requires READ permission on business object definition namespace

Parameters:

businessObjectDefinitionNamespace - the namespace of the business object definition

businessObjectDefinitionName - the name of the business object definition

businessObjectFormatUsage - the usage of the business object format

businessObjectFormatFileType - the file type of the business object format

servletRequest - the client request information

Returns:

the storage unit notification registration keys

updateStorageUnitNotificationRegistration

@RequestMapping(value="/notificationRegistrations/storageUnitNotificationRegistrations/namespaces/{namespace}/notificationNames/{notificationName}",
                method=PUT,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_STORAGE_UNIT_NOTIFICATION_REGISTRATIONS_PUT")
public StorageUnitNotificationRegistration updateStorageUnitNotificationRegistration(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                                                                                                         String namespace,
                                                                                                                                                                                                                                                                                                                                                                                                         @PathVariable(value="notificationName")
                                                                                                                                                                                                                                                                                                                                                                                                         String notificationName,
                                                                                                                                                                                                                                                                                                                                                                                                         @RequestBody
                                                                                                                                                                                                                                                                                                                                                                                                         StorageUnitNotificationRegistrationUpdateRequest request)

Updates an existing storage unit notification registration by key.

Requires WRITE permission on namespace

Requires READ permission on filter namespace

Requires EXECUTE permission on ALL job action namespaces

Parameters:

namespace - the namespace of the storage unit notification registration

notificationName - the name of the storage unit notification registration

request - the information needed to update the storage unit notification registration

Returns:

the updated storage unit notification registration