Interface DispatchProcessorEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to DispatchProcessorEnablers in this Publisher . This also includes existing dispatch processor enablers that may appear or disappear due to changes in the Publisher hier archy, 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 DispatchProcessorEnablerLookupSession .

  • Method Details

    • getPublisherId

      Id getPublisherId()
      Gets the Publisher Id associated with this session.
      Returns:
      the Publisher Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getPublisher

      Publisher getPublisher() throws OperationFailedException, PermissionDeniedException
      Gets the Publisher associated with this session.
      Returns:
      the publisher
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canRegisterForDispatchProcessorEnablerNotifications

      boolean canRegisterForDispatchProcessorEnablerNotifications()
      Tests if this user can register for DispatchProcessorEnabler 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.

    • useFederatedPublisherView

      void useFederatedPublisherView()
      Federates the view for methods in this session. A federated view will include dispatch processor enablers in publishers which are children of this publisher in the publisher hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedPublisherView

      void useIsolatedPublisherView()
      Isolates the view for methods in this session. An isolated view restricts notifications to this publisher only.
      Compliance:
      mandatory - This method is must be implemented.

    • reliableDispatchProcessorEnablerNotifications

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

    • unreliableDispatchProcessorEnablerNotifications

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

    • acknowledgeDispatchProcessorEnablerNotification

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

    • registerForNewDispatchProcessorEnablers

      void registerForNewDispatchProcessorEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new dispatch processor enablers. DispatchProcessorEnablerReceiver.newDispatchProcessorEnablers() is invoked when a new DispatchProcessorEnabler appears in this publisher.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedDispatchProcessorEnablers

      void registerForChangedDispatchProcessorEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated dispatch processor enablers. DispatchProcessorEnablerReceiver.changedDispatchProcessorEnablers() is invoked when a DispatchProcessorEnabler in this publisher is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedDispatchProcessorEnabler

      void registerForChangedDispatchProcessorEnabler(Id dispatchProcessorEnablerId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of an updated dispatch processor enabler. DispatchProcessorEnablerReceiver.changedDispatchProcessorEnablers() is invoked when the specified DispatchProcessorEnabler in this publisher is changed.
      Parameters:
      dispatchProcessorEnablerId - the Id of the DispatchProcessorEnabler to monitor
      Throws:
      NullArgumentException - dispatchProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedDispatchProcessorEnablers

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

    • registerForDeletedDispatchProcessorEnabler

      void registerForDeletedDispatchProcessorEnabler(Id dispatchProcessorEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted dispatch processor enabler. DispatchProcessorEnablerReceiver.deletedDispatchProcessorEnabler() is invok ed when the specified dispatch processor enabler is deleted or removed from this publisher.
      Parameters:
      dispatchProcessorEnablerId - the Id of the DispatchProcessorEnabler to monitor
      Throws:
      NullArgumentException - dispatchProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.