org.osid.authentication.process

Interface AuthenticationProcessManager

All Superinterfaces:

AuthenticationProcessProfile, java.lang.AutoCloseable, java.io.Closeable, 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

Methods

Modifier and Type	Method and 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 org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.authentication.process.AuthenticationProcessProfile

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

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

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 supportsAcquisition() is 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 supportsValidation() is 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 supportsTrustLookup() is 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 supportsTrustLookup() and supportsVisibleFederation() are 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 supportsCircleOfTrust() is 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 supportsCircleOfTrust() and supportsVisibleFederation() are true.