Interface AuthenticationAcquisitionSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AuthenticationAcquisitionSession
extends OsidSession

This session acquires authentication credentials. The basic method, getAuthentication() , gets authentication credentials for use with authenticating to a remote peer. These credentials may be generated from direct user input or retrieved via a file, for example.

Method Summary

Modifier and Type	Method	Description
Authentication	getAuthentication()	Gets the authentication credential for the current user.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

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

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getAuthentication

Authentication getAuthentication()
                          throws OperationFailedException,
PermissionDeniedException

Gets the authentication credential for the current user. The input data may represent the identity of the remote peer or data from a challenge-response transaction necessary for generating the credantial.

Returns:

the acquired authentication credential

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.