org.finra.herd.rest

Class BusinessObjectDataNotificationRegistrationRestController

java.lang.Object

org.finra.herd.rest.HerdBaseController

org.finra.herd.rest.BusinessObjectDataNotificationRegistrationRestController

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

The REST controller that handles business object data notification REST requests.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUSINESS_OBJECT_DATA_NOTIFICATIONS_URI_PREFIX

Constructor Summary

Constructors

Constructor and Description
BusinessObjectDataNotificationRegistrationRestController()

Method Summary

Modifier and Type	Method and Description
BusinessObjectDataNotificationRegistration	createBusinessObjectDataNotificationRegistration(BusinessObjectDataNotificationRegistrationCreateRequest request) Creates a new business object data notification.
BusinessObjectDataNotificationRegistration	deleteBusinessObjectDataNotification(String namespace, String notificationName) Deletes an existing business object data notification by key.
BusinessObjectDataNotificationRegistration	getBusinessObjectDataNotificationRegistration(String namespace, String notificationName) Gets an existing business object data notification by key.
BusinessObjectDataNotificationRegistrationKeys	getBusinessObjectDataNotificationRegistrationsByNamespace(String namespace) Gets a list of keys for all existing business object data notification registrations for the specified business object data notification registration namespace.
BusinessObjectDataNotificationRegistrationKeys	getBusinessObjectDataNotificationRegistrationsByNotificationFilter(String businessObjectDefinitionNamespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, javax.servlet.ServletRequest servletRequest) Gets a list of keys for all existing business object data notification registrations that match the specified business object data notification filter parameters.
BusinessObjectDataNotificationRegistration	updateBusinessObjectDataNotificationRegistration(String namespace, String notificationName, BusinessObjectDataNotificationRegistrationUpdateRequest request) Updates an existing business object data notification 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

BUSINESS_OBJECT_DATA_NOTIFICATIONS_URI_PREFIX

public static final String BUSINESS_OBJECT_DATA_NOTIFICATIONS_URI_PREFIX

See Also:

Constant Field Values

Constructor Detail

BusinessObjectDataNotificationRegistrationRestController

public BusinessObjectDataNotificationRegistrationRestController()

Method Detail

createBusinessObjectDataNotificationRegistration

@RequestMapping(value="/notificationRegistrations/businessObjectDataNotificationRegistrations",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_BUSINESS_OBJECT_DATA_NOTIFICATION_REGISTRATIONS_POST")
public BusinessObjectDataNotificationRegistration createBusinessObjectDataNotificationRegistration(@RequestBody
                                                                                                                                                                                                                                                                                                                                                                            BusinessObjectDataNotificationRegistrationCreateRequest request)

Creates a new business object data notification.

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 business object data notification

Returns:

the created business object data notification

getBusinessObjectDataNotificationRegistration

@RequestMapping(value="/notificationRegistrations/businessObjectDataNotificationRegistrations/namespaces/{namespace}/notificationNames/{notificationName}",
                method=GET)
 @Secured(value="FN_BUSINESS_OBJECT_DATA_NOTIFICATION_REGISTRATIONS_GET")
public BusinessObjectDataNotificationRegistration getBusinessObjectDataNotificationRegistration(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                                                                  String namespace,
                                                                                                                                                                                                                                                                                                                                                                  @PathVariable(value="notificationName")
                                                                                                                                                                                                                                                                                                                                                                  String notificationName)

Gets an existing business object data notification by key.

Requires READ permission on namespace

Parameters:

namespace - the namespace

notificationName - the business object data notification name

Returns:

the retrieved business object data notification

updateBusinessObjectDataNotificationRegistration

@RequestMapping(value="/notificationRegistrations/businessObjectDataNotificationRegistrations/namespaces/{namespace}/notificationNames/{notificationName}",
                method=PUT,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_BUSINESS_OBJECT_DATA_NOTIFICATION_REGISTRATIONS_PUT")
public BusinessObjectDataNotificationRegistration updateBusinessObjectDataNotificationRegistration(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                                                                                                                                      String namespace,
                                                                                                                                                                                                                                                                                                                                                                                                                                      @PathVariable(value="notificationName")
                                                                                                                                                                                                                                                                                                                                                                                                                                      String notificationName,
                                                                                                                                                                                                                                                                                                                                                                                                                                      @RequestBody
                                                                                                                                                                                                                                                                                                                                                                                                                                      BusinessObjectDataNotificationRegistrationUpdateRequest request)

Updates an existing business object data notification 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

notificationName - the business object data notification name

request - the information needed to update the business object data notification

Returns:

the updated business object data notification

deleteBusinessObjectDataNotification

@RequestMapping(value="/notificationRegistrations/businessObjectDataNotificationRegistrations/namespaces/{namespace}/notificationNames/{notificationName}",
                method=DELETE)
 @Secured(value="FN_BUSINESS_OBJECT_DATA_NOTIFICATION_REGISTRATIONS_DELETE")
public BusinessObjectDataNotificationRegistration deleteBusinessObjectDataNotification(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                                                               String namespace,
                                                                                                                                                                                                                                                                                                                                                               @PathVariable(value="notificationName")
                                                                                                                                                                                                                                                                                                                                                               String notificationName)

Deletes an existing business object data notification by key.

Requires WRITE permission on namespace

Parameters:

namespace - the namespace

notificationName - the business object data notification name

Returns:

the business object data notification that got deleted

getBusinessObjectDataNotificationRegistrationsByNamespace

@RequestMapping(value="/notificationRegistrations/businessObjectDataNotificationRegistrations/namespaces/{namespace}",
                method=GET)
 @Secured(value="FN_BUSINESS_OBJECT_DATA_NOTIFICATION_REGISTRATIONS_BY_NAMESPACE_GET")
public BusinessObjectDataNotificationRegistrationKeys getBusinessObjectDataNotificationRegistrationsByNamespace(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                                                          String namespace)

Gets a list of keys for all existing business object data notification registrations for the specified business object data notification registration namespace.

Parameters:

namespace - the namespace of the business object data notification registration

Returns:

the business object data notification registration keys

getBusinessObjectDataNotificationRegistrationsByNotificationFilter

@RequestMapping(value="/notificationRegistrations/businessObjectDataNotificationRegistrations",
                method=GET)
 @Secured(value="FN_BUSINESS_OBJECT_DATA_NOTIFICATION_REGISTRATIONS_BY_NOTIFICATION_FILTER_GET")
public BusinessObjectDataNotificationRegistrationKeys getBusinessObjectDataNotificationRegistrationsByNotificationFilter(@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 business object data notification registrations that match the specified business object data 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 business object data notification registration keys