org.exoplatform.services.security

Interface Authenticator

public interface Authenticator

Created by The eXo Platform SAS
Component responsible for user authentication (session creation) In JAAS LoginModule typically called in login() method

Author:

Gennady Azarenkov

Level API:

Platform

Method Summary

Methods

Modifier and Type	Method and Description
Identity	createIdentity(String userId)
Exception	getLastExceptionOnValidateUser() Gives the last exception that occurs while calling validateUser(Credential[]).
String	validateUser(Credential[] credentials) Authenticate user and return userId which can be different to username.

Method Detail

validateUser

String validateUser(Credential[] credentials)
                    throws LoginException,
                           Exception

Authenticate user and return userId which can be different to username.

Parameters:

credentials - - list of users credentials (such as name/password, X509 certificate etc)

Returns:

userId the user's identifier.

Throws:

LoginException - in case the authentication fails

Exception - if any exception occurs

createIdentity

Identity createIdentity(String userId)
                        throws Exception

Parameters:

userId - the user's identifier

Returns:

returns the Identity representing the user

Throws:

Exception - if any exception occurs

getLastExceptionOnValidateUser

Exception getLastExceptionOnValidateUser()

Gives the last exception that occurs while calling validateUser(Credential[]). This allows applications outside JAAS like UI to be able to know which exception occurs while calling validateUser(Credential[]).

Returns:

the original Exception that occurs while calling validateUser(Credential[]) for the very last time if an exception occurred, null otherwise.

WARNING: to prevent potential memory leaks, the second call to this method may return null so if you need to access several times to this value, you should store the result into a local variable.