Interface DispatchEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to DispatchEnablers in this Publisher . This also includes existing dispatch 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 DispatchEnablerLookupSession .

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

    • canRegisterForDispatchEnablerNotifications

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

    • reliableDispatchEnablerNotifications

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

    • unreliableDispatchEnablerNotifications

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

    • acknowledgeDispatchEnablerNotification

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

    • registerForNewDispatchEnablers

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

    • registerForChangedDispatchEnablers

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

    • registerForChangedDispatchEnabler

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

    • registerForDeletedDispatchEnablers

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

    • registerForDeletedDispatchEnabler

      void registerForDeletedDispatchEnabler(Id dispatchEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted dispatch enabler. DispatchEnablerReceiver.deletedDispatchEnabler() is invoked when the specified dispatch enabler is deleted or removed from this publisher.
      Parameters:
      dispatchEnablerId - the Id of the DispatchEnabler to monitor
      Throws:
      NullArgumentException - dispatchEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.