Interface AuditProcessorNotificationSession

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

This session defines methods to receive notifications on adds/changes to AuditProcessors in this Inquest . This also includes existing audit processors that may appear or disappear due to changes in the Inquest hierar chy, 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 AuditProcessorLookupSession .

  • Method Details

    • getInquestId

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

    • getInquest

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

    • canRegisterForAuditProcessorNotifications

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

    • useFederatedInquestView

      void useFederatedInquestView()
      Federates the view for methods in this session. A federated view will include audit processors in inquests which are children of this inquest in the inquest hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedInquestView

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

    • reliableAuditProcessorNotifications

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

    • unreliableAuditProcessorNotifications

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

    • acknowledgeAuditProcessorNotification

      void acknowledgeAuditProcessorNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge an audit 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.

    • registerForNewAuditProcessors

      void registerForNewAuditProcessors() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new audit processors. AuditProcessorReceiver.newAuditProcessors() is invoked when a new AuditProcessor appears in this inquest.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAuditProcessors

      void registerForChangedAuditProcessors() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated audit processors. AuditProcessorReceiver.changedAuditProcessors() is invoked when an AuditProcessor in this inquest is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAuditProcessor

      void registerForChangedAuditProcessor(Id auditProcessorId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of an updated audit processor. AuditProcessorReceiver.changedAuditProcessors() is invoked when the specified AuditProcessor in this inquest is changed.
      Parameters:
      auditProcessorId - the Id of the AuditProcessor to monitor
      Throws:
      NullArgumentException - auditProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAuditProcessors

      void registerForDeletedAuditProcessors() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted audit processors. AuditProcessorReceiver.deletedAuditProcessors() is invoked when an audit processor is deleted or removed from this inquest.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAuditProcessor

      void registerForDeletedAuditProcessor(Id auditProcessorId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted audit processor. AuditProcessorReceiver.deletedAuditProcessor() is invoked when the specified audit processor is deleted or removed from this inquest.
      Parameters:
      auditProcessorId - the Id of the AuditProcessor to monitor
      Throws:
      NullArgumentException - auditProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.