org.osid.authentication

Interface AuthenticationProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

AuthenticationManager, AuthenticationProxyManager

public interface AuthenticationProfile
extends OsidProfile

The AuthenticationProfile describes the interoperability among authentication services.

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getAgencyRecordTypes() Gets the supported Agency record types.
TypeList	getAgencySearchRecordTypes() Gets the supported Agency search record types.
TypeList	getAgentRecordTypes() Gets the supported Agent record types.
TypeList	getAgentSearchRecordTypes() Gets the supported Agent search record types.
boolean	supportsAgencyAdmin() Tests if an agency administrative service is supported.
boolean	supportsAgencyHierarchy() Tests if an agency hierarchy traversal is supported.
boolean	supportsAgencyHierarchyDesign() Tests if an agency hierarchy design is supported.
boolean	supportsAgencyLookup() Tests if an agency lookup service is supported.
boolean	supportsAgencyNotification() Tests if agency notification is supported.
boolean	supportsAgencyQuery() Tests if an agency query service is supported.
boolean	supportsAgencyRecordType(Type agencyRecordType) Tests if the given Agency record type is supported.
boolean	supportsAgencySearch() Tests if an agency search service is supported.
boolean	supportsAgencySearchRecordType(Type agencySearchRecordType) Tests if the given Agency search record type is supported.
boolean	supportsAgentAdmin() Tests if an agent administrative service is supported.
boolean	supportsAgentAgency() Tests if retrieving mappings of agents and agencies is supported.
boolean	supportsAgentAgencyAssignment() Tests if managing mappings of agents and agencies is supported.
boolean	supportsAgentLookup() Tests if an agent lookup service is supported.
boolean	supportsAgentNotification() Tests if agent notification is supported.
boolean	supportsAgentQuery() Tests if an agent query service is supported.
boolean	supportsAgentRecordType(Type agentRecordType) Tests if the given Agent record type is supported.
boolean	supportsAgentSearch() Tests if an agent search service is supported.
boolean	supportsAgentSearchRecordType(Type agentSearchRecordType) Tests if the given Agent search record type is supported.
boolean	supportsAgentSmartAgency() Tests if agent smart agency is available.
boolean	supportsAuthenticationAcquisition() Tests is authentication acquisition is supported.
boolean	supportsAuthenticationKeys() Tests if an authentication key service is available.
boolean	supportsAuthenticationProcess() Tests if an authentication process service is available.
boolean	supportsAuthenticationValidation() Tests if authentication validation is supported.
boolean	supportsVisibleFederation() Tests if federation is visible.

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

supportsVisibleFederation

boolean supportsVisibleFederation()

Tests if federation is visible.

Returns:

true if visible federation is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAuthenticationAcquisition

boolean supportsAuthenticationAcquisition()

Tests is authentication acquisition is supported. Authentication acquisition is responsible for acquiring client side authentication credentials.

Returns:

true if authentication acquisiiton is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAuthenticationValidation

boolean supportsAuthenticationValidation()

Tests if authentication validation is supported. Authentication validation verifies given authentication credentials and maps to an agent identity.

Returns:

true if authentication validation is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAgentLookup

boolean supportsAgentLookup()

Tests if an agent lookup service is supported. An agent lookup service defines methods to access agents.

Returns:

true if agent lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAgentQuery

boolean supportsAgentQuery()

Tests if an agent query service is supported.

Returns:

true if agent query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAgentSearch

boolean supportsAgentSearch()

Tests if an agent search service is supported.

Returns:

true if agent search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAgentAdmin

boolean supportsAgentAdmin()

Tests if an agent administrative service is supported.

Returns:

true if agent admin is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAgentNotification

boolean supportsAgentNotification()

Tests if agent notification is supported. Messages may be sent when agents are created, modified, or deleted.

Returns:

true if agent notification is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAgentAgency

boolean supportsAgentAgency()

Tests if retrieving mappings of agents and agencies is supported.

Returns:

true if agent agency mapping retrieval is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAgentAgencyAssignment

boolean supportsAgentAgencyAssignment()

Tests if managing mappings of agents and agencies is supported.

Returns:

true if agent agency assignment is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAgentSmartAgency

boolean supportsAgentSmartAgency()

Tests if agent smart agency is available.

Returns:

true if agent smart agency is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAgencyLookup

boolean supportsAgencyLookup()

Tests if an agency lookup service is supported. An agency lookup service defines methods to access agencies.

Returns:

true if agency lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAgencyQuery

boolean supportsAgencyQuery()

Tests if an agency query service is supported.

Returns:

true if agency query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAgencySearch

boolean supportsAgencySearch()

Tests if an agency search service is supported.

Returns:

true if agency search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAgencyAdmin

boolean supportsAgencyAdmin()

Tests if an agency administrative service is supported.

Returns:

true if agency admin is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAgencyNotification

boolean supportsAgencyNotification()

Tests if agency notification is supported. Messages may be sent when agencies are created, modified, or deleted.

Returns:

true if agency notification is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAgencyHierarchy

boolean supportsAgencyHierarchy()

Tests if an agency hierarchy traversal is supported.

Returns:

true if an agency hierarchy traversal is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAgencyHierarchyDesign

boolean supportsAgencyHierarchyDesign()

Tests if an agency hierarchy design is supported.

Returns:

true if an agency hierarchy design is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAuthenticationKeys

boolean supportsAuthenticationKeys()

Tests if an authentication key service is available.

Returns:

true if an authentication key service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAuthenticationProcess

boolean supportsAuthenticationProcess()

Tests if an authentication process service is available.

Returns:

true if an authentication process service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

getAgentRecordTypes

TypeList getAgentRecordTypes()

Gets the supported Agent record types.

Returns:

a list containing the supported Agent record types

Compliance:

mandatory - This method must be implemented.

supportsAgentRecordType

boolean supportsAgentRecordType(Type agentRecordType)

Tests if the given Agent record type is supported.

Parameters:

agentRecordType - a Type indicating an Agent record type

Returns:

true if the given record Type is supported, false otherwise

Throws:

NullArgumentException - agentRecordType is null

Compliance:

mandatory - This method must be implemented.

getAgentSearchRecordTypes

TypeList getAgentSearchRecordTypes()

Gets the supported Agent search record types.

Returns:

a list containing the supported Agent search record types

Compliance:

mandatory - This method must be implemented.

supportsAgentSearchRecordType

boolean supportsAgentSearchRecordType(Type agentSearchRecordType)

Tests if the given Agent search record type is supported.

Parameters:

agentSearchRecordType - a Type indicating an Agent search record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - agentSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getAgencyRecordTypes

TypeList getAgencyRecordTypes()

Gets the supported Agency record types.

Returns:

a list containing the supported Agency record types

Compliance:

mandatory - This method must be implemented.

supportsAgencyRecordType

boolean supportsAgencyRecordType(Type agencyRecordType)

Tests if the given Agency record type is supported.

Parameters:

agencyRecordType - a Type indicating an Agency record type

Returns:

true if the given record Type is supported, false otherwise

Throws:

NullArgumentException - agencyRecordType is null

Compliance:

mandatory - This method must be implemented.

getAgencySearchRecordTypes

TypeList getAgencySearchRecordTypes()

Gets the supported Agency search record types.

Returns:

a list containing the supported Agency search record types

Compliance:

mandatory - This method must be implemented.

supportsAgencySearchRecordType

boolean supportsAgencySearchRecordType(Type agencySearchRecordType)

Tests if the given Agency search record type is supported.

Parameters:

agencySearchRecordType - a Type indicating an Agency search record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - agencySearchRecordType is null

Compliance:

mandatory - This method must be implemented.