Interface JobProcessorNotificationSession

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

This session defines methods to receive notifications on adds/changes to JobProcessor objects in this Foundry . This also includes existing JobProcessors 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 JobProcessorLookupSession .

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

    • canRegisterForJobProcessorNotifications

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

    • reliableJobProcessorNotifications

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

    • unreliableJobProcessorNotifications

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

    • acknowledgeJobProcessorNotification

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

    • registerForNewJobProcessors

      void registerForNewJobProcessors() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new job processors. JobProcessorReceiver.newJobProcessors() is invoked when a new JobProcessor appears in this foundry.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedJobProcessors

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

    • registerForChangedJobProcessor

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

    • registerForDeletedJobProcessors

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

    • registerForDeletedJobProcessor

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