Interface AuthorizationEnablerNotificationSession

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

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

  • Method Details

    • getVaultId

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

    • getVault

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

    • canRegisterForAuthorizationEnablerNotifications

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

    • useFederatedVaultView

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

    • useIsolatedVaultView

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

    • reliableAuthorizationEnablerNotifications

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

    • unreliableAuthorizationEnablerNotifications

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

    • acknowledgeAuthorizationEnablerNotification

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

    • registerForNewAuthorizationEnablers

      void registerForNewAuthorizationEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new authorization enablers. AuthorizationEnablerReceiver.newAuthorizationEnablers() is invoked when a new AuthorizationEnabler appears in this vault.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAuthorizationEnablers

      void registerForChangedAuthorizationEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated authorization enablers. AuthorizationEnablerReceiver.changedAuthorizationEnablers() is invoked when an authorization enabler in this vault is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAuthorizationEnabler

      void registerForChangedAuthorizationEnabler(Id authorizationEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated authorization enabler. ProvisionableReceiver.changedAuthorizationEnablers() is invoked when the specified authorization enabler in this vault is changed.
      Parameters:
      authorizationEnablerId - the Id of the AuthorizationEnabler to monitor
      Throws:
      NullArgumentException - authorizationEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAuthorizationEnablers

      void registerForDeletedAuthorizationEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted authorization enablers. AuthorizationEnablerReceiver.deletedAuthorizationEnablers() is invoked when an authorization enabler is deleted or removed from this vault.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAuthorizationEnabler

      void registerForDeletedAuthorizationEnabler(Id authorizationEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted authorization enabler. AuthorizationEnablerReceiver.deletedAuthorizationEnablers() is invoked when the specified authorization enabler is deleted or removed from this vault.
      Parameters:
      authorizationEnablerId - the Id of the AuthorizationEnabler to monitor
      Throws:
      NullArgumentException - authorizationEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.