Package lumis.portal.authentication

Class SessionConfig

java.lang.Object

lumis.portal.authentication.SessionConfig

All Implemented Interfaces:

Serializable, Cloneable

@StableMinor(version="14.1",
             sinceVersion="4.0")
public final class SessionConfig
extends Object
implements Cloneable, Serializable

Stores user session information.

Since:

4.0.6

Version:

$Revision: 24683 $ $Date: 2021-08-23 18:55:58 -0300 (Mon, 23 Aug 2021) $

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SessionConfig()	Deprecated. Since 4.0.8, the SessionConfig should not be created using this constructor.

Method Summary

Modifier and Type	Method	Description
protected SessionConfig	clone()
static SessionConfig	getCurrentSessionConfig()	Returns the current session config object.
Locale	getLocale()
UserConfig	getUserConfig()	Returns the UserConfig associated with this session, cached inside this instance.
String	getUserId()	Gets the user id associated with this session.
String	getUserSessionId()
void	setLocale(Locale locale)
void	setUserSessionId(String userSessionId)	Deprecated. Since 4.0.8, you should obtain the session config instance already constructed from getCurrentSessionConfig() or a method in IAuthenticationManager and there is no need to set the userSessionId.

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionConfig

@Deprecated
public SessionConfig()

Deprecated.

Since 4.0.8, the SessionConfig should not be created using this constructor. Instead obtain it by calling getCurrentSessionConfig() or the methods available in IAuthenticationManager.

Since:

4.0.0

Method Detail

getUserSessionId

public String getUserSessionId()

Returns:

Returns the userSessionId.

setUserSessionId

@Deprecated
public void setUserSessionId(String userSessionId)

Deprecated.

Since 4.0.8, you should obtain the session config instance already constructed from getCurrentSessionConfig() or a method in IAuthenticationManager and there is no need to set the userSessionId.

Parameters:

userSessionId - The userSessionId to set.

getLocale

public Locale getLocale()

Returns:

Returns the locale.

setLocale

public void setLocale(Locale locale)

Parameters:

locale - The locale to set.

getUserConfig

public UserConfig getUserConfig()
                         throws PortalException

Returns the UserConfig associated with this session, cached inside this instance. The value returned may not reflect changes occurred since the start of this session.

Returns:

the UserConfig associated with this session.

Throws:

PortalException

Since:

11.0.0

getUserId

public String getUserId()
                 throws PortalException

Gets the user id associated with this session.

Returns:

the user id associated with this session.

Throws:

PortalException - if it was not possible to obtain the userId for this SessionConfig.

Since:

4.0.8

getCurrentSessionConfig

public static SessionConfig getCurrentSessionConfig()

Returns the current session config object.

Returns:

the current session config object.

Since:

4.0.7

clone

protected SessionConfig clone()

Overrides:

clone in class Object