Interface BrokerConstrainerNotificationSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface BrokerConstrainerNotificationSession extends OsidSession

This session defines methods to receive notifications on adds/changes to BrokerConstrainers in this Distributor . This also includes existing broker constrainers that may appear or disappear due to changes in the Distributor hi erarchy, This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed.

The two views defined in this session correspond to the views in the BrokerConstrainerLookupSession .

  • Method Details

    • getDistributorId

      Id getDistributorId()
      Gets the Distributor Id associated with this session.
      Returns:
      the Distributor Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getDistributor

      Distributor getDistributor() throws OperationFailedException, PermissionDeniedException
      Gets the Distributor associated with this session.
      Returns:
      the distributor
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canRegisterForBrokerConstrainerNotifications

      boolean canRegisterForBrokerConstrainerNotifications()
      Tests if this user can register for BrokerConstrainer notifications. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED .This is intended as a hint to an application that may opt not to offer notification operations.
      Returns:
      false if notification methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedDistributorView

      void useFederatedDistributorView()
      Federates the view for methods in this session. A federated view will include broker constrainers in distributors which are children of this distributor in the distributor hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedDistributorView

      void useIsolatedDistributorView()
      Isolates the view for methods in this session. An isolated view restricts notifications to this distributor only.
      Compliance:
      mandatory - This method is must be implemented.

    • reliableBrokerConstrainerNotifications

      void reliableBrokerConstrainerNotifications()
      Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeBrokerConstrainerNotification() .
      Compliance:
      mandatory - This method is must be implemented.

    • unreliableBrokerConstrainerNotifications

      void unreliableBrokerConstrainerNotifications()
      Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
      Compliance:
      mandatory - This method is must be implemented.

    • acknowledgeBrokerConstrainerNotification

      void acknowledgeBrokerConstrainerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge a broker constrainer notification.
      Parameters:
      notificationId - the Id of the notification
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewBrokerConstrainers

      void registerForNewBrokerConstrainers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new broker constrainers. BrokerConstrainerReceiver.newBrokerConstrainers() is invoked when a new BrokerConstrainer appears in this distributor.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedBrokerConstrainers

      void registerForChangedBrokerConstrainers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated broker constrainers. BrokerConstrainerReceiver.changedBrokerConstrainers() is invoked when a BrokerConstrainer in this distributor is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedBrokerConstrainer

      void registerForChangedBrokerConstrainer(Id brokerConstrainerId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of an updated broker constrainer. BrokerConstrainerReceiver.changedBrokerConstrainers() is invoked when the specified BrokerConstrainer in this distributor is changed.
      Parameters:
      brokerConstrainerId - the Id of the BrokerConstrainer to monitor
      Throws:
      NullArgumentException - brokerConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedBrokerConstrainers

      void registerForDeletedBrokerConstrainers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted broker constrainers. BrokerConstrainerReceiver.deletedBrokerConstrainers() is invoked when a broker constrainer is deleted or removed from this distributor.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedBrokerConstrainer

      void registerForDeletedBrokerConstrainer(Id brokerConstrainerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted broker constrainer. BrokerConstrainerReceiver.deletedBrokerConstrainer() is invoked when the specified broker constrainer is deleted or removed from this distributor.
      Parameters:
      brokerConstrainerId - the Id of the BrokerConstrainer to monitor
      Throws:
      NullArgumentException - brokerConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.