Interface BrokerEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to BrokerEnablers in this Distributor . This also includes existing broker enablers 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 BrokerEnablerLookupSession .

  • 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.

    • canRegisterForBrokerEnablerNotifications

      boolean canRegisterForBrokerEnablerNotifications()
      Tests if this user can register for BrokerEnabler 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 enablers 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.

    • reliableBrokerEnablerNotifications

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

    • unreliableBrokerEnablerNotifications

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

    • acknowledgeBrokerEnablerNotification

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

    • registerForNewBrokerEnablers

      void registerForNewBrokerEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new broker enablers. BrokerEnablerReceiver.newBrokerEnablers() is invoked when a new BrokerEnabler appears in this distributor.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedBrokerEnablers

      void registerForChangedBrokerEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated broker enablers. BrokerEnablerReceiver.changedBrokerEnablers() is invoked when a BrokerEnabler in this distributor is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedBrokerEnabler

      void registerForChangedBrokerEnabler(Id brokerEnablerId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of an updated broker enabler. BrokerEnablerReceiver.changedBrokerEnablers() is invoked when the specified BrokerEnabler in this distributor is changed.
      Parameters:
      brokerEnablerId - the Id of the BrokerEnabler to monitor
      Throws:
      NullArgumentException - brokerEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedBrokerEnablers

      void registerForDeletedBrokerEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted broker enablers. BrokerEnablerReceiver.deletedBrokerEnablers() is invoked when a broker enabler is deleted or removed from this distributor.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedBrokerEnabler

      void registerForDeletedBrokerEnabler(Id brokerEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted broker enabler. BrokerEnablerReceiver.deletedBrokerEnabler() is invoked when the specified broker enabler is deleted or removed from this distributor.
      Parameters:
      brokerEnablerId - the Id of the BrokerEnabler to monitor
      Throws:
      NullArgumentException - brokerEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.