Interface AuthenticationProcessManager

All Superinterfaces:

AuthenticationProcessProfile, AutoCloseable, Closeable, OsidManager, OsidManager, OsidProfile, Sourceable

public interface AuthenticationProcessManager
extends OsidManager, AuthenticationProcessProfile

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

• AuthenticationAcquisitionSession : a session to acquire credentials from a user and serialize them for transport to a remote peer for authentication
• AuthenticationValidationSession: a session to receive and validate authentication credentials from a remote peer wishing to authenticate
• TrustLookupSession : a session to look up authentication circles of trust
• CircleOfTrustSession : a session to examine agent circles of trust

Method Summary

Modifier and Type	Method	Description
AuthenticationAcquisitionSession	getAuthenticationAcquisitionSession()	Gets an AuthenticationAcquisitionSession which is responsible for acquiring authentication credentials on behalf of a service client.
AuthenticationValidationSession	getAuthenticationValidationSession()	Gets the OsidSession associated with the AuthenticationValidation service.
CircleOfTrustSession	getCircleOfTrustSession()	Gets the OsidSession associated with the trust circle service.
CircleOfTrustSession	getCircleOfTrustSessionForAgency(Id agencyId)	Gets the OsidSession associated with the trust circle service for the given agency.
TrustLookupSession	getTrustLookupSession()	Gets the OsidSession associated with the trust lookup service.
TrustLookupSession	getTrustLookupSessionForAgency(Id agencyId)	Gets the OsidSession associated with the trust lookup service for the given agency.

Methods inherited from interface AuthenticationProcessProfile

getAuthenticationInputRecordTypes, getAuthenticationRecordTypes, getChallengeRecordTypes, getCredentialTypes, getTrustTypes, supportsAuthenticationAcquisition, supportsAuthenticationInputRecordType, supportsAuthenticationRecordType, supportsAuthenticationValidation, supportsChallenge, supportsChallengeRecordType, supportsCircleOfTrust, supportsCredentialExport, supportsCredentialType, supportsTrustLookup, supportsTrustType

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getAuthenticationAcquisitionSession

AuthenticationAcquisitionSession getAuthenticationAcquisitionSession()
                                                              throws OperationFailedException

Gets an AuthenticationAcquisitionSession which is responsible for acquiring authentication credentials on behalf of a service client.

Returns:

an acquisition session for this service

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthenticationAcquisition() is false

Compliance:

optional - This method must be implemented if {@code supportsAcquisition()} is {@code true} .

getAuthenticationValidationSession

AuthenticationValidationSession getAuthenticationValidationSession()
                                                            throws OperationFailedException

Gets the OsidSession associated with the AuthenticationValidation service.

Returns:

an AuthenticationValidationSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthenticationValidation() is false

Compliance:

optional - This method must be implemented if {@code supportsValidation()} is {@code true} .

getTrustLookupSession

TrustLookupSession getTrustLookupSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the trust lookup service.

Returns:

a TrustLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTrustLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsTrustLookup()} is {@code true} .

getTrustLookupSessionForAgency

TrustLookupSession getTrustLookupSessionForAgency(Id agencyId)
                                           throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the trust lookup service for the given agency.

Parameters:

agencyId - the Id of the agency

Returns:

a TrustLookupSession

Throws:

NotFoundException - agencyId not found

NullArgumentException - agencyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTrustLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsTrustLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getCircleOfTrustSession

CircleOfTrustSession getCircleOfTrustSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the trust circle service.

Returns:

a CircleOfTrustSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCircleOfTrust() is false

Compliance:

optional - This method must be implemented if {@code supportsCircleOfTrust()} is {@code true} .

getCircleOfTrustSessionForAgency

CircleOfTrustSession getCircleOfTrustSessionForAgency(Id agencyId)
                                               throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the trust circle service for the given agency.

Parameters:

agencyId - the Id of the agency

Returns:

a CircleOfTrustSession

Throws:

NotFoundException - agencyId not found

NullArgumentException - agencyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCiirleOfTrust() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCircleOfTrust()} and {@code supportsVisibleFederation()} are {@code true} .