org.osid.authentication.process

Interface AuthenticationAcquisitionSession

All Superinterfaces:

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

Methods

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

Methods inherited from interface org.osid.OsidSession

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

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

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.