Interface AuthorizationEnablerRuleLookupSession

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

This session provides methods to retrieve AuthorizationEnabler to Authorization mappings. An Authorization with multiple AuthorizationEnablers means any positive rule evaluation across the enablers result in an effective Authorization .

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated vault view: All methods in this session operate, retrieve and pertain authorization enablers defined explicitly in the current vault
  • federated vault view: All methods in this session operate, retrieve and pertain to all authorization enablers defined in this vault and any other authorization enablers implicitly available in this vault through vault inheritence.

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

    • canLookupAuthorizationEnablerRules

      boolean canLookupAuthorizationEnablerRules()
      Tests if this user can perform lookups of authorization enabler/authorization mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.
      Returns:
      false if looking up mappings is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeAuthorizationEnablerRuleView

      void useComparativeAuthorizationEnablerRuleView()
      The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
      Compliance:
      mandatory - This method is must be implemented.

    • usePlenaryAuthorizationEnablerRuleView

      void usePlenaryAuthorizationEnablerRuleView()
      A complete view of the AuthorizationEnabler and Authorization returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
      Compliance:
      mandatory - This method is must be implemented.

    • useFederatedVaultView

      void useFederatedVaultView()
      Federates the view for methods in this session. A federated view will include authorization 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 lookups to this vault only.
      Compliance:
      mandatory - This method is must be implemented.

    • getAuthorizationEnablerIdsForAuthorization

      IdList getAuthorizationEnablerIdsForAuthorization(Id authorizationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the AuthorizationEnabler Id associated with an Authorization .
      Parameters:
      authorizationId - Id of the Authorization
      Returns:
      the authorization enabler Ids
      Throws:
      NotFoundException - authorizationId is not found
      NullArgumentException - authorizationId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationEnablersForAuthorization

      AuthorizationEnablerList getAuthorizationEnablersForAuthorization(Id authorizationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the AuthorizationEnabler associated with an Authorization .
      Parameters:
      authorizationId - Id of the Authorization
      Returns:
      the authorization enablers
      Throws:
      NotFoundException - authorizationId is not found
      NullArgumentException - authorizationId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationIdsForAuthorizationEnabler

      IdList getAuthorizationIdsForAuthorizationEnabler(Id authorizationEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Authorization Ids mapped to an AuthorizationEnabler .
      Parameters:
      authorizationEnablerId - Id of an AuthorizationEnabler
      Returns:
      list of authorization Ids
      Throws:
      NotFoundException - authorizationEnablerId is not found
      NullArgumentException - authorizationEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationsForAuthorizationEnabler

      AuthorizationList getAuthorizationsForAuthorizationEnabler(Id authorizationEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Authorizations mapped to an AuthorizationEnabler .
      Parameters:
      authorizationEnablerId - Id of an AuthorizationEnabler
      Returns:
      list of authorizations
      Throws:
      NotFoundException - authorizationEnablerId is not found
      NullArgumentException - authorizationEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.