org.osid.authentication.process

Interface AuthenticationProcessProxyManager

All Superinterfaces:

AuthenticationProcessProfile, java.lang.AutoCloseable, java.io.Closeable, OsidProfile, OsidProxyManager, Sourceable

public interface AuthenticationProcessProxyManager
extends OsidProxyManager, AuthenticationProcessProfile

The authentication process proxy manager provides access to authentication sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. The sessions included in this manager are:

• AuthenticationAcquisitionSession: session to acquire credentials from a user and serialize them for transport to a remote peer for authentication
• AuthenticationValidationSession: 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(Proxy proxy) Gets the OsidSession associated with the AuthenticationAcquisitionSession using the supplied Authentication.
AuthenticationValidationSession	getAuthenticationValidationSession(Proxy proxy) Gets the OsidSession associated with the AuthenticationValidation service using the supplied Authentication.
CircleOfTrustSession	getCircleOfTrustSession(Proxy proxy) Gets the OsidSession associated with the trust circle service.
CircleOfTrustSession	getCircleOfTrustSessionForAgency(Id agencyId, Proxy proxy) Gets the OsidSession associated with the trust circle service for the given agency.
TrustLookupSession	getTrustLookupSession(Proxy proxy) Gets the OsidSession associated with the trust lookup service.
TrustLookupSession	getTrustLookupSessionForAgency(Id agencyId, Proxy proxy) Gets the OsidSession associated with the trust lookup service for the given agency.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

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(Proxy proxy)
                                                                     throws OperationFailedException

Gets the OsidSession associated with the AuthenticationAcquisitionSession using the supplied Authentication.

Parameters:

proxy - a proxy

Returns:

an AuthenticationAcquisitionSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthenticationAcquisition() is false

Compliance:

optional - This method must be implemented if supportsAcquisition() is true.

getAuthenticationValidationSession

AuthenticationValidationSession getAuthenticationValidationSession(Proxy proxy)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the AuthenticationValidation service using the supplied Authentication.

Parameters:

proxy - a proxy

Returns:

an AuthenticationValidationSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthenticationValidation() is false

Compliance:

optional - This method must be implemented if supportsValidation() is true.

getTrustLookupSession

TrustLookupSession getTrustLookupSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the trust lookup service.

Parameters:

proxy - a proxy

Returns:

a TrustLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                                Proxy proxy)
                                                  throws NotFoundException,
                                                         OperationFailedException

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

Parameters:

agencyId - the Id of the agency

proxy - a proxy

Returns:

a TrustLookupSession

Throws:

NotFoundException - agencyId not found

NullArgumentException - agencyId or proxy 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(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the trust circle service.

Parameters:

proxy - a proxy

Returns:

a CircleOfTrustSession

Throws:

NullArgumentException - proxy is null

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,
                                                    Proxy proxy)
                                                      throws NotFoundException,
                                                             OperationFailedException

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

Parameters:

agencyId - the Id of the agency

proxy - a proxy

Returns:

a CircleOfTrustSession

Throws:

NotFoundException - agencyId not found

NullArgumentException - agencyId or proxy 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.