Interface AuthorizationRulesManager

All Superinterfaces:
AuthorizationRulesProfile, AutoCloseable, Closeable, OsidManager, OsidManager, OsidProfile, Sourceable
public interface AuthorizationRulesManager extends OsidManager, AuthorizationRulesProfile

The authorization rules manager provides access to authorization rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • AuthorizationEnablerLookupSession : a session to retrieve authorization enablers
  • AuthorizationEnablerQuerySession : a session to query for authorization enablers
  • AuthorizationEnablerSearchSession : a session to search for authorization enablers
  • AuthorizationEnablerAdminSession : a session to create and delete authorization enablers
  • AuthorizationEnablerNotificationSession : a session to receive notifications pertaining to authorization enabler changes
  • AuthorizationEnablerVaultSession : a session to look up authorization enabler vault mappings
  • AuthorizationEnablerVaultAssignmentSession : a session to manage authorization enabler to vault mappings
  • AuthorizationEnablerSmartVaultSession : a session to manage dynamic vaults of authorization enablers
  • AuthorizationEnablerRuleLookupSession : a session to look up authorization enabler to authorization mappings
  • AuthorizationEnablerRuleApplicationSession : a session to assign authorization enablers to authorizations

  • Method Details

    • getAuthorizationEnablerLookupSession

      AuthorizationEnablerLookupSession getAuthorizationEnablerLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the authorization enabler lookup service.
      Returns:
      an AuthorizationEnablerLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAuthorizationEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAuthorizationEnablerLookup()} is {@code true} .

    • getAuthorizationEnablerLookupSessionForVault

      AuthorizationEnablerLookupSession getAuthorizationEnablerLookupSessionForVault(Id vaultId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the authorization enabler lookup service for the given vault.
      Parameters:
      vaultId - the Id of the Vault
      Returns:
      an AuthorizationEnablerLookupSession
      Throws:
      NotFoundException - no Vault found by the given Id
      NullArgumentException - vaultId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAuthorizationEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAuthorizationEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getAuthorizationEnablerQuerySession

      AuthorizationEnablerQuerySession getAuthorizationEnablerQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the authorization enabler query service.
      Returns:
      an AuthorizationEnablerQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAuthorizationEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAuthorizationEnablerQuery()} is {@code true} .

    • getAuthorizationEnablerQuerySessionForVault

      AuthorizationEnablerQuerySession getAuthorizationEnablerQuerySessionForVault(Id vaultId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the authorization enabler query service for the given vault.
      Parameters:
      vaultId - the Id of the Vault
      Returns:
      an AuthorizationEnablerQuerySession
      Throws:
      NotFoundException - no Vault found by the given Id
      NullArgumentException - vaultId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAuthorizationEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAuthorizationEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

    • getAuthorizationEnablerSearchSession

      AuthorizationEnablerSearchSession getAuthorizationEnablerSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the authorization enabler search service.
      Returns:
      an AuthorizationEnablerSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAuthorizationEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAuthorizationEnablerSearch()} is {@code true} .

    • getAuthorizationEnablerSearchSessionForVault

      AuthorizationEnablerSearchSession getAuthorizationEnablerSearchSessionForVault(Id vaultId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the authorization enablers earch service for the given vault.
      Parameters:
      vaultId - the Id of the Vault
      Returns:
      an AuthorizationEnablerSearchSession
      Throws:
      NotFoundException - no Vault found by the given Id
      NullArgumentException - vaultId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAuthorizationEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAuthorizationEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

    • getAuthorizationEnablerAdminSession

      AuthorizationEnablerAdminSession getAuthorizationEnablerAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the authorization enabler administration service.
      Returns:
      an AuthorizationEnablerAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAuthorizationEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAuthorizationEnablerAdmin()} is {@code true} .

    • getAuthorizationEnablerAdminSessionForVault

      AuthorizationEnablerAdminSession getAuthorizationEnablerAdminSessionForVault(Id vaultId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the authorization enabler administration service for the given vault.
      Parameters:
      vaultId - the Id of the Vault
      Returns:
      an AuthorizationEnablerAdminSession
      Throws:
      NotFoundException - no Vault found by the given Id
      NullArgumentException - vaultId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAuthorizationEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAuthorizationEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

    • getAuthorizationEnablerNotificationSession

      AuthorizationEnablerNotificationSession getAuthorizationEnablerNotificationSession(AuthorizationEnablerReceiver authorizationEnablerReceiver) throws OperationFailedException
      Gets the OsidSession associated with the authorization enabler notification service.
      Parameters:
      authorizationEnablerReceiver - the notification callback
      Returns:
      an AuthorizationEnablerNotificationSession
      Throws:
      NullArgumentException - authorizationEnablerReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAuthorizationEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAuthorizationEnablerNotification()} is {@code true} .

    • getAuthorizationEnablerNotificationSessionForVault

      AuthorizationEnablerNotificationSession getAuthorizationEnablerNotificationSessionForVault(AuthorizationEnablerReceiver authorizationEnablerReceiver, Id vaultId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the authorization enabler notification service for the given vault.
      Parameters:
      authorizationEnablerReceiver - the notification callback
      vaultId - the Id of the Vault
      Returns:
      an AuthorizationEnablerNotificationSession
      Throws:
      NotFoundException - no vault found by the given Id
      NullArgumentException - authorizationEnablerReceiver or vaultId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAuthorizationEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAuthorizationEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getAuthorizationEnablerVaultSession

      AuthorizationEnablerVaultSession getAuthorizationEnablerVaultSession() throws OperationFailedException
      Gets the OsidSession to lookup authorization enabler/vault mappings for authorization enablers.
      Returns:
      an AuthorizationEnablerVaultSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAuthorizationEnablerVault() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAuthorizationEnablerVault()} is {@code true} .

    • getAuthorizationEnablerVaultAssignmentSession

      AuthorizationEnablerVaultAssignmentSession getAuthorizationEnablerVaultAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning authorization enablers to vaults for authorization.
      Returns:
      an AuthorizationEnablerVaultAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAuthorizationEnablerVaultAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAuthorizationEnablerVaultAssignment()} is {@code true} .

    • getAuthorizationEnablerSmartVaultSession

      AuthorizationEnablerSmartVaultSession getAuthorizationEnablerSmartVaultSession(Id vaultId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage authorization enabler smart vaults.
      Parameters:
      vaultId - the Id of the Vault
      Returns:
      an AuthorizationEnablerSmartVaultSession
      Throws:
      NotFoundException - no Vault found by the given Id
      NullArgumentException - vaultId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAuthorizationEnablerSmartVault() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAuthorizationEnablerSmartVault()} is {@code true} .

    • getAuthorizationEnablerRuleLookupSession

      AuthorizationEnablerRuleLookupSession getAuthorizationEnablerRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the authorization enabler authorization mapping lookup service.
      Returns:
      an AuthorizationEnablerRuleLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAuthorizationEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAuthorizationEnablerRuleLookup()} is {@code true} .

    • getAuthorizationEnablerRuleLookupSessionForVault

      AuthorizationEnablerRuleLookupSession getAuthorizationEnablerRuleLookupSessionForVault(Id vaultId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the authorization enabler mapping lookup service for the given vault.
      Parameters:
      vaultId - the Id of the Vault
      Returns:
      an AuthorizationEnablerRuleLookupSession
      Throws:
      NotFoundException - no Vault found by the given Id
      NullArgumentException - vaultId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAuthorizationEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAuthorizationEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getAuthorizationEnablerRuleApplicationSession

      AuthorizationEnablerRuleApplicationSession getAuthorizationEnablerRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the authorization enabler assignment service to apply enablers to vaults.
      Returns:
      an AuthorizationEnablerRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAuthorizationEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAuthorizationEnablerRuleApplication()} is {@code true} .

    • getAuthorizationEnablerRuleApplicationSessionForVault

      AuthorizationEnablerRuleApplicationSession getAuthorizationEnablerRuleApplicationSessionForVault(Id vaultId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the authorization enabler assignment service for the given vault to apply enablers to vaults.
      Parameters:
      vaultId - the Id of the Vault
      Returns:
      an AuthorizationEnablerRuleApplicationSession
      Throws:
      NotFoundException - no Vault found by the given Id
      NullArgumentException - vaultId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsAuthorizationEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAuthorizationEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true}