Package ch.ivyteam.ivy.security

Class SessionInfo

java.lang.Object

ch.ivyteam.ivy.security.SessionInfo

All Implemented Interfaces:

Serializable

public class SessionInfo
extends Object
implements Serializable

Contains information about a session stored in a ClusterSessionsSnapshot

See Also:

Serialized Form

API:

This is a public API.

Constructor Summary

Constructors

Constructor	Description
SessionInfo(String sessionUserName, String clusterNode, String activeEnvironment, boolean hasActiveSubstitutions, boolean absent)

Method Summary

Modifier and Type	Method	Description
String	getActiveEnvironment()	Returns the name of the environment set on the session or null if none was set.
String	getClusterNode()	Returns the name of the cluster node the session originates from.
String	getSessionUserName()	Returns the name of the user which logged in to this session.
boolean	hasActiveSubstitutions()	Returns true if this session was an active substitution for other users
boolean	isAbsent()	Returns true if the user was absent when the snapshot was taken.
boolean	isSessionUserUnknown()	Returns true if the session user is not known thus an anonymous session.
boolean	isSystemSession()	Returns true if the session belongs to the system user otherwise false.

Constructor Detail

SessionInfo

public SessionInfo(String sessionUserName,
                   String clusterNode,
                   String activeEnvironment,
                   boolean hasActiveSubstitutions,
                   boolean absent)

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

Method Detail

getSessionUserName

public String getSessionUserName()

Returns the name of the user which logged in to this session. Returns null if Session user was unknown.

Returns:

Name of the session user or null.

See Also:

ISession.getSessionUser()

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

getClusterNode

public String getClusterNode()

Returns the name of the cluster node the session originates from.

Returns:

name of the cluster node, never null

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

getActiveEnvironment

public String getActiveEnvironment()

Returns the name of the environment set on the session or null if none was set.

Returns:

name of the environment or null.

See Also:

ISession.getActiveEnvironment()

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

hasActiveSubstitutions

public boolean hasActiveSubstitutions()

Returns true if this session was an active substitution for other users

Returns:

true or false

See Also:

ISession.hasActiveSubstitutions()

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

isAbsent

public boolean isAbsent()

Returns true if the user was absent when the snapshot was taken.

Returns:

true or false

See Also:

ISession.isAbsent()

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

isSystemSession

public boolean isSystemSession()

Returns true if the session belongs to the system user otherwise false.

Returns:

true if system false otherwise

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

isSessionUserUnknown

public boolean isSessionUserUnknown()

Returns true if the session user is not known thus an anonymous session. Otherwise false.

Returns:

true for unknown session user false otherwise

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.