org.nuxeo.ecm.platform.api.login

Class UserIdentificationInfo

java.lang.Object

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

KeycloakUserInfo, ShibbolethUserInfo

public class UserIdentificationInfo
extends Object
implements Serializable

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

Author:

Thierry Delprat

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	authPluginName
protected Map<String,String>	loginParameters
protected String	loginPluginName
protected String	password
protected String	token
protected String	userName

Constructor Summary

Constructors

Constructor and Description
UserIdentificationInfo(String userName, String password)
UserIdentificationInfo(UserIdentificationInfo savedIdent)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

userName

protected String userName

password

protected String password

token

protected String token

authPluginName

protected String authPluginName

loginPluginName

protected String loginPluginName

loginParameters

protected final Map<String,String> loginParameters

Constructor Detail

UserIdentificationInfo

public UserIdentificationInfo(String userName,
                              String password)

UserIdentificationInfo

public UserIdentificationInfo(UserIdentificationInfo savedIdent)

Method Detail

getAuthPluginName

public String getAuthPluginName()

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

setAuthPluginName

public void setAuthPluginName(String authPluginName)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

getUserName

public String getUserName()

setUserName

public void setUserName(String userName)

containsValidIdentity

public boolean containsValidIdentity()

getLoginParameters

public Map<String,String> getLoginParameters()

setLoginParameters

public void setLoginParameters(Map<String,String> loginParameters)

getLoginPluginName

public String getLoginPluginName()

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

setLoginPluginName

public void setLoginPluginName(String loginPluginName)

getToken

public String getToken()

setToken

public void setToken(String token)