org.finra.herd.rest

Class NotificationRegistrationStatusRestController

java.lang.Object

org.finra.herd.rest.HerdBaseController

org.finra.herd.rest.NotificationRegistrationStatusRestController

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

The REST controller for notification registration statuses.

Constructor Summary

Constructors

Constructor and Description
NotificationRegistrationStatusRestController()

Method Summary

Modifier and Type	Method and Description
NotificationRegistrationStatusUpdateResponse	updateNotificationRegistrationStatus(String namespace, String notificationName, NotificationRegistrationStatusUpdateRequest notificationRegistrationStatusUpdateRequest) Updates the status of a notification registration.

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

Constructor Detail

NotificationRegistrationStatusRestController

public NotificationRegistrationStatusRestController()

Method Detail

updateNotificationRegistrationStatus

@Secured(value="FN_NOTIFICATION_REGISTRATION_STATUS_PUT")
 @RequestMapping(value="/notificationRegistrationStatus/namespaces/{namespace}/notificationNames/{notificationName}",
                method=PUT,
                consumes={"application/xml","application/json"})
public NotificationRegistrationStatusUpdateResponse updateNotificationRegistrationStatus(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                                                                      String namespace,
                                                                                                                                                                                                                                                                                                                                                                      @PathVariable(value="notificationName")
                                                                                                                                                                                                                                                                                                                                                                      String notificationName,
                                                                                                                                                                                                                                                                                                                                                                      @RequestBody
                                                                                                                                                                                                                                                                                                                                                                      NotificationRegistrationStatusUpdateRequest notificationRegistrationStatusUpdateRequest)

Updates the status of a notification registration.

Requires WRITE permission on namespace

Parameters:

namespace - The namespace of the notification registration.

notificationName - The name of the notification registration.

notificationRegistrationStatusUpdateRequest - The request to update the status.

Returns:

The response of the update request.