Interface BrokerProcessorEnablerNotificationSession

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

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

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

    • canRegisterForBrokerProcessorEnablerNotifications

      boolean canRegisterForBrokerProcessorEnablerNotifications()
      Tests if this user can register for BrokerProcessorEnabler 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 processor 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.

    • reliableBrokerProcessorEnablerNotifications

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

    • unreliableBrokerProcessorEnablerNotifications

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

    • acknowledgeBrokerProcessorEnablerNotification

      void acknowledgeBrokerProcessorEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge a broker processor 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.

    • registerForNewBrokerProcessorEnablers

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

    • registerForChangedBrokerProcessorEnablers

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

    • registerForChangedBrokerProcessorEnabler

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

    • registerForDeletedBrokerProcessorEnablers

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

    • registerForDeletedBrokerProcessorEnabler

      void registerForDeletedBrokerProcessorEnabler(Id brokerProcessorEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted broker processor enabler. BrokerProcessorEnablerReceiver.deletedBrokerProcessorEnabler() is invoked w hen the specified broker processor enabler is deleted or removed from this distributor.
      Parameters:
      brokerProcessorEnablerId - the Id of the BrokerProcessorEnabler to monitor
      Throws:
      NullArgumentException - brokerProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.