Interface AuthorizationProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
AuthorizationManager, AuthorizationProxyManager
public interface AuthorizationProfile extends OsidProfile

The AuthorizationProfile describes the interoperability among authorization services.

  • Method Details

    • supportsVisibleFederation

      boolean supportsVisibleFederation()
      Tests if federation is visible.
      Returns:
      true if visible federation is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAuthorization

      boolean supportsAuthorization()
      Tests for the availability of an authorization service which is the basic service for checking authorizations.
      Returns:
      true if authorization is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAuthorizationLookup

      boolean supportsAuthorizationLookup()
      Tests if an authorization lookup service is supported. An authorization lookup service defines methods to access authorizations.
      Returns:
      true if authorization lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAuthorizationQuery

      boolean supportsAuthorizationQuery()
      Tests if an authorization query service is supported.
      Returns:
      true if authorization query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAuthorizationSearch

      boolean supportsAuthorizationSearch()
      Tests if an authorization search service is supported.
      Returns:
      true if authorization search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAuthorizationAdmin

      boolean supportsAuthorizationAdmin()
      Tests if an authorization administrative service is supported.
      Returns:
      true if authorization admin is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAuthorizationNotification

      boolean supportsAuthorizationNotification()
      Tests if authorization notification is supported. Messages may be sent when authorizations are created, modified, or deleted.
      Returns:
      true if authorization notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAuthorizationVault

      boolean supportsAuthorizationVault()
      Tests if an authorization to vault lookup session is available.
      Returns:
      true if authorization vault lookup session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAuthorizationVaultAssignment

      boolean supportsAuthorizationVaultAssignment()
      Tests if an authorization to vault assignment session is available.
      Returns:
      true if authorization vault assignment is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAuthorizationSmartVault

      boolean supportsAuthorizationSmartVault()
      Tests if an authorization smart vaulting session is available.
      Returns:
      true if authorization smart vaulting is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFunctionLookup

      boolean supportsFunctionLookup()
      Tests if a function lookup service is supported. A function lookup service defines methods to access authorization functions.
      Returns:
      true if function lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFunctionQuery

      boolean supportsFunctionQuery()
      Tests if a function query service is supported.
      Returns:
      true if function query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFunctionSearch

      boolean supportsFunctionSearch()
      Tests if a function search service is supported.
      Returns:
      true if function search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFunctionAdmin

      boolean supportsFunctionAdmin()
      Tests if a function administrative service is supported.
      Returns:
      true if function admin is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFunctionNotification

      boolean supportsFunctionNotification()
      Tests if function notification is supported. Messages may be sent when functions are created, modified, or deleted.
      Returns:
      true if function notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFunctionVault

      boolean supportsFunctionVault()
      Tests if a function to vault lookup session is available.
      Returns:
      true if function vault lookup session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFunctionVaultAssignment

      boolean supportsFunctionVaultAssignment()
      Tests if a function to vault assignment session is available.
      Returns:
      true if function vault assignment is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFunctionSmartVault

      boolean supportsFunctionSmartVault()
      Tests if a function smart vaulting session is available.
      Returns:
      true if function smart vaulting is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsQualifierLookup

      boolean supportsQualifierLookup()
      Tests if a qualifier lookup service is supported. A function lookup service defines methods to access authorization qualifiers.
      Returns:
      true if qualifier lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsQualifierQuery

      boolean supportsQualifierQuery()
      Tests if a qualifier query service is supported.
      Returns:
      true if qualifier query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsQualifierSearch

      boolean supportsQualifierSearch()
      Tests if a qualifier search service is supported.
      Returns:
      true if qualifier search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsQualifierAdmin

      boolean supportsQualifierAdmin()
      Tests if a qualifier administrative service is supported.
      Returns:
      true if qualifier admin is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsQualifierNotification

      boolean supportsQualifierNotification()
      Tests if qualifier notification is supported. Messages may be sent when qualifiers are created, modified, or deleted.
      Returns:
      true if qualifier notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsQualifierHierarchy

      boolean supportsQualifierHierarchy()
      Tests if a qualifier hierarchy traversal is supported.
      Returns:
      true if a qualifier hierarchy traversal is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsQualifierHierarchyDesign

      boolean supportsQualifierHierarchyDesign()
      Tests if qualifier hierarchy design is supported.
      Returns:
      true if a qualifier hierarchy design is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsQualifierVault

      boolean supportsQualifierVault()
      Tests if a qualifier to vault lookup session is available.
      Returns:
      true if qualifier vault lookup session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsQualifierVaultAssignment

      boolean supportsQualifierVaultAssignment()
      Tests if a qualifier to vault assignment session is available.
      Returns:
      true if qualifier vault assignment is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsQualifierSmartVault

      boolean supportsQualifierSmartVault()
      Tests if a qualifier smart vaulting session is available.
      Returns:
      true if qualifier smart vault session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsVaultLookup

      boolean supportsVaultLookup()
      Tests if a vault lookup service is supported. A vault lookup service defines methods to access authorization vaults.
      Returns:
      true if function lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsVaultQuery

      boolean supportsVaultQuery()
      Tests if a vault query service is supported.
      Returns:
      true if vault query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsVaultSearch

      boolean supportsVaultSearch()
      Tests if a vault search service is supported.
      Returns:
      true if vault search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsVaultAdmin

      boolean supportsVaultAdmin()
      Tests if a vault administrative service is supported.
      Returns:
      true if vault admin is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsVaultNotification

      boolean supportsVaultNotification()
      Tests if vault notification is supported. Messages may be sent when vaults are created, modified, or deleted.
      Returns:
      true if vault notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsVaultHierarchy

      boolean supportsVaultHierarchy()
      Tests if a vault hierarchy traversal is supported.
      Returns:
      true if a vault hierarchy traversal is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsVaultHierarchyDesign

      boolean supportsVaultHierarchyDesign()
      Tests if vault hierarchy design is supported.
      Returns:
      true if a function hierarchy design is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAuthorizationBatch

      boolean supportsAuthorizationBatch()
      Tests if an authorization batch service is supported.
      Returns:
      true if an authorization batch service design is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAuthorizationRules

      boolean supportsAuthorizationRules()
      Tests if an authorization rules service is supported.
      Returns:
      true if an authorization rules service design is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationRecordTypes

      TypeList getAuthorizationRecordTypes()
      Gets the supported Authorization record types.
      Returns:
      a list containing the supported authorization record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsAuthorizationRecordType

      boolean supportsAuthorizationRecordType(Type authorizationRecordType)
      Tests if the given authorization record type is supported.
      Parameters:
      authorizationRecordType - a Type indicating an authorization record type
      Returns:
      true if the given record Type is supported, false otherwise
      Throws:
      NullArgumentException - authorizationRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationSearchRecordTypes

      TypeList getAuthorizationSearchRecordTypes()
      Gets the supported Authorization search record types.
      Returns:
      a list containing the supported authorization search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsAuthorizationSearchRecordType

      boolean supportsAuthorizationSearchRecordType(Type authorizationSearchRecordType)
      Tests if the given authorization search record type is supported.
      Parameters:
      authorizationSearchRecordType - a Type indicating an authorization search record type
      Returns:
      true if the given search record Type is supported, false otherwise
      Throws:
      NullArgumentException - authorizationSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getFunctionRecordTypes

      TypeList getFunctionRecordTypes()
      Gets the supported Function record types.
      Returns:
      a list containing the supported Function record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsFunctionRecordType

      boolean supportsFunctionRecordType(Type functionRecordType)
      Tests if the given Function record type is supported.
      Parameters:
      functionRecordType - a Type indicating a Function record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - functionRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getFunctionSearchRecordTypes

      TypeList getFunctionSearchRecordTypes()
      Gets the supported Function search record types.
      Returns:
      a list containing the supported Function search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsFunctionSearchRecordType

      boolean supportsFunctionSearchRecordType(Type functionSearchRecordType)
      Tests if the given Function search record type is supported.
      Parameters:
      functionSearchRecordType - a Type indicating a Function search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - functionSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getQualifierRecordTypes

      TypeList getQualifierRecordTypes()
      Gets the supported Qualifier record types.
      Returns:
      a list containing the supported Qualifier record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsQualifierRecordType

      boolean supportsQualifierRecordType(Type qualifierRecordType)
      Tests if the given Qualifier record type is supported.
      Parameters:
      qualifierRecordType - a Type indicating a Qualifier record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - qualifierRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getQualifierSearchRecordTypes

      TypeList getQualifierSearchRecordTypes()
      Gets the supported Qualifier search record types.
      Returns:
      a list containing the supported Qualifier search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsQualifierSearchRecordType

      boolean supportsQualifierSearchRecordType(Type qualifierSearchRecordType)
      Tests if the given Qualifier search record type is supported.
      Parameters:
      qualifierSearchRecordType - a Type indicating a Qualifier search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - qualifierSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getVaultRecordTypes

      TypeList getVaultRecordTypes()
      Gets the supported Vault record types.
      Returns:
      a list containing the supported Vault record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsVaultRecordType

      boolean supportsVaultRecordType(Type vaultRecordType)
      Tests if the given Vault record type is supported.
      Parameters:
      vaultRecordType - a Type indicating a Vault type
      Returns:
      true if the given vault record Type is supported, false otherwise
      Throws:
      NullArgumentException - vaultRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getVaultSearchRecordTypes

      TypeList getVaultSearchRecordTypes()
      Gets the supported vault search record types.
      Returns:
      a list containing the supported Vault search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsVaultSearchRecordType

      boolean supportsVaultSearchRecordType(Type vaultSearchRecordType)
      Tests if the given vault search record type is supported.
      Parameters:
      vaultSearchRecordType - a Type indicating a Vault search record type
      Returns:
      true if the given search record Type is supported, false otherwise
      Throws:
      NullArgumentException - vaultSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationConditionRecordTypes

      TypeList getAuthorizationConditionRecordTypes()
      Gets the supported AuthorizationCondition record types.
      Returns:
      a list containing the supported AuthorizationCondition record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsAuthorizationConditionRecordType

      boolean supportsAuthorizationConditionRecordType(Type authorizationConditionRecordType)
      Tests if the given AuthorizationCondition record type is supported.
      Parameters:
      authorizationConditionRecordType - a Type indicating an AuthorizationCondition record type
      Returns:
      true if the given authorization condition record Type is supported, false otherwise
      Throws:
      NullArgumentException - authorizationConditionRecordType is null
      Compliance:
      mandatory - This method must be implemented.