Interface AuthenticationValidationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AuthenticationValidationSession
extends OsidSession

This session is the remote end of a transport link from the acquisition session and validates authentication credentials sent to it. The basic method, authenticate() accepts a credential, validates it and returns an Authentication containing the identity of the authenticated user.

This OSID does not define any root interface for credentials and challenge data. The object representing these are completely defined within their Type ,providing flexibility in adapting to a variety of application environments.

Method Summary

Modifier and Type	Method	Description
Authentication	authenticate(AuthenticationInput input)	Validates and returns the authentication credential from the given data.
AuthenticationInput	getAuthenticationInput()	Gets an interface for authentication input.
Challenge	getChallengeData(AuthenticationInput input)	Gets data that can be used for a challenge to the peer attempting authentication.

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

getAuthenticationInput

AuthenticationInput getAuthenticationInput()

Gets an interface for authentication input.

Returns:

authentication input

Compliance:

mandatory - This method is must be implemented.

authenticate

Authentication authenticate(AuthenticationInput input)
                     throws OperationFailedException,
PermissionDeniedException

Validates and returns the authentication credential from the given data.

Parameters:

input - the authentication input to be validated

Returns:

the resulting authentication

Throws:

NullArgumentException - input is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - input is not of this service

Compliance:

mandatory - This method is must be implemented.

getChallengeData

Challenge getChallengeData(AuthenticationInput input)
                    throws OperationFailedException,
PermissionDeniedException

Gets data that can be used for a challenge to the peer attempting authentication.

Parameters:

input - authentication input

Returns:

the acquired challenge data

Throws:

NullArgumentException - input is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnimplementedException - challenge response not available

UnsupportedException - input is not of this service

Compliance:

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