Interface DispatchProcessorNotificationSession

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

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

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

    • canRegisterForDispatchProcessorNotifications

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

    • reliableDispatchProcessorNotifications

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

    • unreliableDispatchProcessorNotifications

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

    • acknowledgeDispatchProcessorNotification

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

    • registerForNewDispatchProcessors

      void registerForNewDispatchProcessors() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new dispatch processors. DispatchProcessorReceiver.newDispatchProcessors() is invoked when a new DispatchProcessor appears in this publisher.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedDispatchProcessors

      void registerForChangedDispatchProcessors() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated dispatch processors. DispatchProcessorReceiver.changedDispatchProcessors() is invoked when a DispatchProcessor in this publisher is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedDispatchProcessor

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

    • registerForDeletedDispatchProcessors

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

    • registerForDeletedDispatchProcessor

      void registerForDeletedDispatchProcessor(Id dispatchProcessorId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted dispatch processor. DispatchProcessorReceiver.deletedDispatchProcessor() is invoked when the specified dispatch processor is deleted or removed from this publisher.
      Parameters:
      dispatchProcessorId - the Id of the DispatchProcessor to monitor
      Throws:
      NullArgumentException - dispatchProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.