Interface ParameterProcessorNotificationSession

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

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

  • Method Details

    • getConfigurationId

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

    • getConfiguration

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

    • canRegisterForParameterProcessorNotifications

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

    • useFederatedConfigurationView

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

    • useIsolatedConfigurationView

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

    • reliableParameterProcessorNotifications

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

    • unreliableParameterProcessorNotifications

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

    • acknowledgeParameterProcessorNotification

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

    • registerForNewParameterProcessors

      void registerForNewParameterProcessors() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new parameter processors. ParameterProcessorReceiver.newParameterProcessors() is invoked when a new ParameterProcessor appears in this configuration.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedParameterProcessors

      void registerForChangedParameterProcessors() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated parameter processors. ParameterProcessorReceiver.changedParameterProcessors() is invoked when a parameter processor in this configuration is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedParameterProcessor

      void registerForChangedParameterProcessor(Id parameterProcessorId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated parameter processor. ProvisionableReceiver.changedParameterProcessors() is invoked when the specified parameter processor in this configuration is changed.
      Parameters:
      parameterProcessorId - the Id of the ParameterProcessor to monitor
      Throws:
      NullArgumentException - parameterProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedParameterProcessors

      void registerForDeletedParameterProcessors() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted parameter processors. ParameterProcessorReceiver.deletedParameterProcessors() is invoked when a parameter processor is deleted or removed from this configuration.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedParameterProcessor

      void registerForDeletedParameterProcessor(Id parameterProcessorId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted parameter processor. ParameterProcessorReceiver.deletedParameterProcessors() is invoked when the specified parameter processor is deleted or removed from this configuration.
      Parameters:
      parameterProcessorId - the Id of the ParameterProcessor to monitor
      Throws:
      NullArgumentException - parameterProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.