org.osid.authentication.process

Interface AuthenticationProcessProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

AuthenticationProcessManager, AuthenticationProcessProxyManager

public interface AuthenticationProcessProfile
extends OsidProfile

The AuthenticationProcessProfile describes the interoperability among authentication process services.

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getAuthenticationInputRecordTypes() Gets the supported authentication input record types.
TypeList	getAuthenticationRecordTypes() Gets the supported authentication record types.
TypeList	getChallengeRecordTypes() Gets the supported challenge types.
TypeList	getCredentialTypes() Gets the supported credential types.
TypeList	getTrustTypes() Gets the supported trust types.
boolean	supportsAuthenticationAcquisition() Tests if authentication acquisition is supported.
boolean	supportsAuthenticationInputRecordType(Type authenticationInputRecordType) Tests if the given authentication input record type is supported.
boolean	supportsAuthenticationRecordType(Type authenticationRecordType) Tests if the given authentication record type is supported.
boolean	supportsAuthenticationValidation() Tests if authentication validation is supported.
boolean	supportsChallenge() Tests if this authentication service supports a challenge-response mechanism where credential validation service must implement a means to generate challenge data.
boolean	supportsChallengeRecordType(Type challengeRecordType) Tests if the given challenge data type is supported.
boolean	supportsCircleOfTrust() Tests if a session to examine agent and trust relationships is supported.
boolean	supportsCredentialExport() Tests if Authentication objects can export serialzied credentials for transport.
boolean	supportsCredentialType(Type credentialType) Tests if the given credential type is supported.
boolean	supportsTrustLookup() Tests if a trust look up session is supported.
boolean	supportsTrustType(Type trustType) Tests if the given trust type is supported.

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

supportsAuthenticationAcquisition

boolean supportsAuthenticationAcquisition()

Tests if 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.

supportsTrustLookup

boolean supportsTrustLookup()

Tests if a trust look up session is supported.

Returns:

true if trust lookup is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCircleOfTrust

boolean supportsCircleOfTrust()

Tests if a session to examine agent and trust relationships is supported.

Returns:

true if a circle of trust is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsChallenge

boolean supportsChallenge()

Tests if this authentication service supports a challenge-response mechanism where credential validation service must implement a means to generate challenge data.

Returns:

true if this is a challenge-response system, false otherwise

Compliance:

mandatory - This method must be implemented.

getAuthenticationRecordTypes

TypeList getAuthenticationRecordTypes()

Gets the supported authentication record types.

Returns:

a list containing the supported authentication record types

Compliance:

mandatory - This method must be implemented.

supportsAuthenticationRecordType

boolean supportsAuthenticationRecordType(Type authenticationRecordType)

Tests if the given authentication record type is supported.

Parameters:

authenticationRecordType - a Type indicating an authentication record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - authenticationRecordType is null

Compliance:

mandatory - This method must be implemented.

getAuthenticationInputRecordTypes

TypeList getAuthenticationInputRecordTypes()

Gets the supported authentication input record types.

Returns:

a list containing the supported authentication input record types

Compliance:

mandatory - This method must be implemented.

supportsAuthenticationInputRecordType

boolean supportsAuthenticationInputRecordType(Type authenticationInputRecordType)

Tests if the given authentication input record type is supported.

Parameters:

authenticationInputRecordType - a Type indicating an authentication input record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - authenticationInputRecordType is null

Compliance:

mandatory - This method must be implemented.

getChallengeRecordTypes

TypeList getChallengeRecordTypes()

Gets the supported challenge types.

Returns:

a list containing the supported challenge types

Compliance:

mandatory - This method must be implemented.

supportsChallengeRecordType

boolean supportsChallengeRecordType(Type challengeRecordType)

Tests if the given challenge data type is supported.

Parameters:

challengeRecordType - a Type indicating a challenge record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - challengeRecordType is null

Compliance:

mandatory - This method must be implemented.

supportsCredentialExport

boolean supportsCredentialExport()

Tests if Authentication objects can export serialzied credentials for transport.

Returns:

true if the given credentials export is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

getCredentialTypes

TypeList getCredentialTypes()

Gets the supported credential types.

Returns:

a list containing the supported credential types

Compliance:

mandatory - This method must be implemented.

supportsCredentialType

boolean supportsCredentialType(Type credentialType)

Tests if the given credential type is supported.

Parameters:

credentialType - a Type indicating a credential type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - credentialType is null

Compliance:

mandatory - This method must be implemented.

getTrustTypes

TypeList getTrustTypes()

Gets the supported trust types.

Returns:

a list containing the supported trust types

Compliance:

mandatory - This method must be implemented.

supportsTrustType

boolean supportsTrustType(Type trustType)

Tests if the given trust type is supported.

Parameters:

trustType - a Type indicating a trust type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - trustType is null

Compliance:

mandatory - This method must be implemented.