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 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. |
changeBranch, initialize, rollbackService
close
getAuthenticationInputRecordTypes, getAuthenticationRecordTypes, getChallengeRecordTypes, getCredentialTypes, getTrustTypes, supportsAuthenticationAcquisition, supportsAuthenticationInputRecordType, supportsAuthenticationRecordType, supportsAuthenticationValidation, supportsChallenge, supportsChallengeRecordType, supportsCircleOfTrust, supportsCredentialExport, supportsCredentialType, supportsTrustLookup, supportsTrustType
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
AuthenticationAcquisitionSession getAuthenticationAcquisitionSession() throws OperationFailedException
AuthenticationAcquisitionSession
which is
responsible for acquiring authentication credentials on behalf of a
service client.OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthenticationAcquisition()
is false
optional
- This method must be implemented if
supportsAcquisition()
is true.
AuthenticationValidationSession getAuthenticationValidationSession() throws OperationFailedException
OsidSession
associated with the
AuthenticationValidation
service. AuthenticationValidationSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthenticationValidation()
is false
optional
- This method must be implemented if
supportsValidation()
is true.
TrustLookupSession getTrustLookupSession() throws OperationFailedException
OsidSession
associated with the trust lookup
service. TrustLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsTrustLookup()
is false
optional
- This method must be implemented if
supportsTrustLookup()
is true.
TrustLookupSession getTrustLookupSessionForAgency(Id agencyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the trust lookup
service for the given agency.agencyId
- the Id
of the agency TrustLookupSession
NotFoundException
- agencyId
not foundNullArgumentException
- agencyId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsTrustLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsTrustLookup()
and
supportsVisibleFederation()
are true.
CircleOfTrustSession getCircleOfTrustSession() throws OperationFailedException
OsidSession
associated with the trust circle
service. CircleOfTrustSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCircleOfTrust()
is false
optional
- This method must be implemented if
supportsCircleOfTrust()
is true.
CircleOfTrustSession getCircleOfTrustSessionForAgency(Id agencyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the trust circle
service for the given agency.agencyId
- the Id
of the agency CircleOfTrustSession
NotFoundException
- agencyId
not foundNullArgumentException
- agencyId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsCiirleOfTrust()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsCircleOfTrust()
and
supportsVisibleFederation()
are true.