Interface BrokerProcessorNotificationSession

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

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

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

    • canRegisterForBrokerProcessorNotifications

      boolean canRegisterForBrokerProcessorNotifications()
      Tests if this user can register for BrokerProcessor 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 processors 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.

    • reliableBrokerProcessorNotifications

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

    • unreliableBrokerProcessorNotifications

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

    • acknowledgeBrokerProcessorNotification

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

    • registerForNewBrokerProcessors

      void registerForNewBrokerProcessors() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new broker processors. BrokerProcessorReceiver.newBrokerProcessors() is invoked when a new BrokerProcessor appears in this distributor.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedBrokerProcessors

      void registerForChangedBrokerProcessors() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated broker processors. BrokerProcessorReceiver.changedBrokerProcessors() is invoked when a BrokerProcessor in this distributor is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedBrokerProcessor

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

    • registerForDeletedBrokerProcessors

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

    • registerForDeletedBrokerProcessor

      void registerForDeletedBrokerProcessor(Id brokerProcessorId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted broker processor. BrokerProcessorReceiver.deletedBrokerProcessor() is invoked when the specified broker processor is deleted or removed from this distributor.
      Parameters:
      brokerProcessorId - the Id of the BrokerProcessor to monitor
      Throws:
      NullArgumentException - brokerProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.