Interface BrokerNotificationSession

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

This session defines methods to receive notifications on adds/changes to Broker objects in this Distributor . This also includes existing brokers that may appear or disappear due to changes in the Distributor hierarchy, 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 BrokerLookupSession .

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

    • canRegisterForBrokerNotifications

      boolean canRegisterForBrokerNotifications()
      Tests if this user can register for Broker 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 brokers 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.

    • reliableBrokerNotifications

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

    • unreliableBrokerNotifications

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

    • acknowledgeBrokerNotification

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

    • registerForNewBrokers

      void registerForNewBrokers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new brokers. BrokerReceiver.newBrokers() is invoked when a new Broker appears in this distributor.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedBrokers

      void registerForChangedBrokers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated brokers. BrokerReceiver.changedBrokers() is invoked when a broker in this distributor is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedBroker

      void registerForChangedBroker(Id brokerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated broker. BrokerReceiver.changedBrokers() is invoked when the specified broker in this distributor is changed.
      Parameters:
      brokerId - the Id of the Broker to monitor
      Throws:
      NullArgumentException - brokerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedBrokers

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

    • registerForDeletedBroker

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