Interface AuthorizationEnablerSmartVaultSession

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

This session manages queries and sequencing to create "smart" dynamic vaults. An AuthorizationEnablerQuery can be retrieved from this session and mapped to this Vault to create a virtual collection of authorization enablers. The authorization enablers may be sequenced using the AuthorizationEnablerSearchOrder from this session.

This Vault has a default query that matches any authorization enabler and a default search order that specifies no sequencing. The queries may be examined using an AuthorizationEnablerQueryInspector . The query may be modified by converting the inspector back to an AuthorizationEnablerQuery .

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

    • canManageSmartVaults

      boolean canManageSmartVaults()
      Tests if this user can manage smart vaults. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.
      Returns:
      false if smart vault management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationEnablerQuery

      AuthorizationEnablerQuery getAuthorizationEnablerQuery()
      Gets an authorization enabler query.
      Returns:
      the authorization enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationEnablerSearchOrder

      AuthorizationEnablerSearchOrder getAuthorizationEnablerSearchOrder()
      Gets an authorization enabler search order.
      Returns:
      the authorization enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • applyAuthorizationEnablerQuery

      void applyAuthorizationEnablerQuery(AuthorizationEnablerQuery authorizationEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Applies an authorization enabler query to this vault.
      Parameters:
      authorizationEnablerQuery - the authorization enabler query
      Throws:
      NullArgumentException - authorizationEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - authorizationEnablerQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectAuthorizationEnablerQuery

      AuthorizationEnablerQueryInspector inspectAuthorizationEnablerQuery() throws OperationFailedException, PermissionDeniedException
      Gets an authorization enabler query inspector for this vault.
      Returns:
      the authorization enabler query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyAuthorizationEnablerSequencing

      void applyAuthorizationEnablerSequencing(AuthorizationEnablerSearchOrder authorizationEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies an authorization enabler search order to this vault.
      Parameters:
      authorizationEnablerSearchOrder - the authorization enabler search order
      Throws:
      NullArgumentException - authorizationEnablerSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - authorizationEnablerSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationEnablerQueryFromInspector

      AuthorizationEnablerQuery getAuthorizationEnablerQueryFromInspector(AuthorizationEnablerQueryInspector authorizationEnablerQueryInspector)
      Gets an authorization enabler query from an inspector.
      Parameters:
      authorizationEnablerQueryInspector - an authorization enabler query inspector
      Returns:
      the authorization enabler query
      Throws:
      NullArgumentException - authorizationEnablerQueryInspector is null
      UnsupportedException - authorizationEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.