Interface JobProcessorEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to JobProcessorEnabler objects in this Foundry . This also includes existing JobProcessorEnablers that may appear or disappear due to changes in the Foundry 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 JobProcessorEnablerLookupSession .

  • Method Details

    • getFoundryId

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

    • getFoundry

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

    • canRegisterForJobProcessorEnablerNotifications

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

    • useFederatedFoundryView

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

    • useIsolatedFoundryView

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

    • reliableJobProcessorEnablerNotifications

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

    • unreliableJobProcessorEnablerNotifications

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

    • acknowledgeJobProcessorEnablerNotification

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

    • registerForNewJobProcessorEnablers

      void registerForNewJobProcessorEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new job processor enablers. JobProcessorEnablerReceiver.newJobProcessorEnablers() is invoked when a new JobProcessorEnabler appears in this foundry.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedJobProcessorEnablers

      void registerForChangedJobProcessorEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated foundry enabelrs. JobProcessorEnablerReceiver.changedJobProcessorEnablers() is invoked when a job processor enabler in this foundry is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedJobProcessorEnabler

      void registerForChangedJobProcessorEnabler(Id jobProcessorEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated job processor enabler. ProvisionableReceiver.changedJobProcessorEnablers() is invoked when the specified job processor enabler in this foundry is changed.
      Parameters:
      jobProcessorEnablerId - the Id of the JobProcessorEnabler to monitor
      Throws:
      NullArgumentException - jobProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedJobProcessorEnablers

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

    • registerForDeletedJobProcessorEnabler

      void registerForDeletedJobProcessorEnabler(Id jobProcessorEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted job processor enabler. JobProcessorEnablerReceiver.deletedJobProcessorEnablers() is invoked when the specified job processor enabler is deleted or removed from this foundry.
      Parameters:
      jobProcessorEnablerId - the Id of the JobProcessorEnabler to monitor
      Throws:
      NullArgumentException - jobProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.