org.nuxeo.ecm.platform.api.login
Class UserIdentificationInfo

java.lang.Object
  org.nuxeo.ecm.platform.api.login.UserIdentificationInfo

All Implemented Interfaces:

java.io.Serializable

public class UserIdentificationInfo
extends java.lang.Object
implements java.io.Serializable

Encapsulates some information about a user and how it must be authenticated.

Author:

Thierry Delprat

See Also:

Serialized Form

Constructor Summary

UserIdentificationInfo(java.lang.String userName, java.lang.String password)

UserIdentificationInfo(UserIdentificationInfo savedIdent)

Method Summary

boolean	containsValidIdentity()
java.lang.String	getAuthPluginName() Returns the name of the Authentication Plugin used to get user identity (FORM,BASIC,CAS2 ...).
java.util.Map<java.lang.String,java.lang.String>	getLoginParameters()
java.lang.String	getLoginPluginName() Returns the name of the LoginModule plugin that must be used to create the Principal.
java.lang.String	getPassword()
java.lang.String	getToken()
java.lang.String	getUserName()
void	setAuthPluginName(java.lang.String authPluginName)
void	setLoginParameters(java.util.Map<java.lang.String,java.lang.String> loginParameters)
void	setLoginPluginName(java.lang.String loginPluginName)
void	setPassword(java.lang.String password)
void	setToken(java.lang.String token)
void	setUserName(java.lang.String userName)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserIdentificationInfo

public UserIdentificationInfo(java.lang.String userName,
                              java.lang.String password)

UserIdentificationInfo

public UserIdentificationInfo(UserIdentificationInfo savedIdent)

Method Detail

getAuthPluginName

public java.lang.String getAuthPluginName()

Returns the name of the Authentication Plugin used to get user identity (FORM,BASIC,CAS2 ...).

setAuthPluginName

public void setAuthPluginName(java.lang.String authPluginName)

getPassword

public java.lang.String getPassword()

setPassword

public void setPassword(java.lang.String password)

getUserName

public java.lang.String getUserName()

setUserName

public void setUserName(java.lang.String userName)

containsValidIdentity

public boolean containsValidIdentity()

getLoginParameters

public java.util.Map<java.lang.String,java.lang.String> getLoginParameters()

setLoginParameters

public void setLoginParameters(java.util.Map<java.lang.String,java.lang.String> loginParameters)

getLoginPluginName

public java.lang.String getLoginPluginName()

Returns the name of the LoginModule plugin that must be used to create the Principal.

setLoginPluginName

public void setLoginPluginName(java.lang.String loginPluginName)

getToken

public java.lang.String getToken()

setToken

public void setToken(java.lang.String token)