com.haulmont.cuba.security.auth

Class AbstractClientCredentials

java.lang.Object

com.haulmont.cuba.security.auth.AbstractCredentials

com.haulmont.cuba.security.auth.AbstractClientCredentials

All Implemented Interfaces:

Credentials, LocalizedCredentials, SessionAttributesProvider, SyncSessionCredentials, TimeZoneProvider, java.io.Serializable

Direct Known Subclasses:

AnonymousUserCredentials, ExternalUserCredentials, LoginPasswordCredentials, RememberMeCredentials, TrustedClientCredentials

public abstract class AbstractClientCredentials
extends AbstractCredentials
implements SyncSessionCredentials, SessionAttributesProvider, TimeZoneProvider

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractClientCredentials()
AbstractClientCredentials(java.util.Locale locale, java.util.Map<java.lang.String,java.lang.Object> params)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClientInfo()
ClientType	getClientType()
java.lang.String	getHostName()
java.lang.String	getIpAddress()
java.util.Map<java.lang.String,java.io.Serializable>	getSessionAttributes()
java.util.TimeZone	getTimeZone()
abstract java.lang.String	getUserIdentifier()
boolean	isCheckClientPermissions()
boolean	isSyncNewUserSessionReplication() Indicates that a new user session created on login should be sent to the cluster synchronously.
void	setCheckClientPermissions(boolean checkClientPermissions)
void	setClientInfo(java.lang.String clientInfo)
void	setClientType(ClientType clientType)
void	setHostName(java.lang.String hostName)
void	setIpAddress(java.lang.String ipAddress)
void	setSessionAttributes(java.util.Map<java.lang.String,java.io.Serializable> sessionAttributes)
void	setSyncNewUserSessionReplication(boolean syncNewUserSessionReplication)
void	setTimeZone(java.util.TimeZone timeZone)

Methods inherited from class com.haulmont.cuba.security.auth.AbstractCredentials

getLocale, getParams, isOverrideLocale, setLocale, setOverrideLocale, setParams

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractClientCredentials

public AbstractClientCredentials(java.util.Locale locale,
                                 java.util.Map<java.lang.String,java.lang.Object> params)

AbstractClientCredentials

public AbstractClientCredentials()

Method Detail

getClientInfo

public java.lang.String getClientInfo()

setClientInfo

public void setClientInfo(java.lang.String clientInfo)

getIpAddress

public java.lang.String getIpAddress()

setIpAddress

public void setIpAddress(java.lang.String ipAddress)

getClientType

public ClientType getClientType()

setClientType

public void setClientType(ClientType clientType)

isCheckClientPermissions

public boolean isCheckClientPermissions()

setCheckClientPermissions

public void setCheckClientPermissions(boolean checkClientPermissions)

getUserIdentifier

public abstract java.lang.String getUserIdentifier()

Returns:

user identifier that represents to user login, not necessarily equal to login/email of a user.

isSyncNewUserSessionReplication

public boolean isSyncNewUserSessionReplication()

Description copied from interface: SyncSessionCredentials

Indicates that a new user session created on login should be sent to the cluster synchronously. Overrides the application property cuba.syncNewUserSessionReplication.

Specified by:

isSyncNewUserSessionReplication in interface SyncSessionCredentials

setSyncNewUserSessionReplication

public void setSyncNewUserSessionReplication(boolean syncNewUserSessionReplication)

getHostName

public java.lang.String getHostName()

setHostName

public void setHostName(java.lang.String hostName)

getSessionAttributes

public java.util.Map<java.lang.String,java.io.Serializable> getSessionAttributes()

Specified by:

getSessionAttributes in interface SessionAttributesProvider

setSessionAttributes

public void setSessionAttributes(java.util.Map<java.lang.String,java.io.Serializable> sessionAttributes)

getTimeZone

public java.util.TimeZone getTimeZone()

Specified by:

getTimeZone in interface TimeZoneProvider

setTimeZone

public void setTimeZone(java.util.TimeZone timeZone)