Interface BrokerConstrainerEnablerNotificationSession

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

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

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

    • canRegisterForBrokerConstrainerEnablerNotifications

      boolean canRegisterForBrokerConstrainerEnablerNotifications()
      Tests if this user can register for BrokerConstrainerEnabler 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 constrainer 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.

    • reliableBrokerConstrainerEnablerNotifications

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

    • unreliableBrokerConstrainerEnablerNotifications

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

    • acknowledgeBrokerConstrainerEnablerNotification

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

    • registerForNewBrokerConstrainerEnablers

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

    • registerForChangedBrokerConstrainerEnablers

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

    • registerForChangedBrokerConstrainerEnabler

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

    • registerForDeletedBrokerConstrainerEnablers

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

    • registerForDeletedBrokerConstrainerEnabler

      void registerForDeletedBrokerConstrainerEnabler(Id brokerConstrainerEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted :osid trainer enabler. BrokerConstrainerEnablerReceiver.deletedBrokerConstrainerEnabler() is invoked w hen the specified broker constrainer enabler is deleted or removed from this distributor.
      Parameters:
      brokerConstrainerEnablerId - the Id of the BrokerConstrainerEnabler to monitor
      Throws:
      NullArgumentException - brokerConstrainerEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.