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, boolean hasActiveSubstitutions, boolean absent)	Deprecated, for removal: This API element is subject to removal in a future version. SessionInfo objects will be created by the Axon Ivy Runtime.

Method Summary

Modifier and Type	Method	Description
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()	Deprecated, for removal: This API element is subject to removal in a future version. evaluate this for the given user on your own
boolean	isAbsent()	Deprecated, for removal: This API element is subject to removal in a future version. evaluate this for the given user on your own IUser.isAbsent()
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 Details

SessionInfo

@Deprecated(forRemoval=true,
            since="12.0.8")
public SessionInfo(String sessionUserName,
 String clusterNode,
 boolean hasActiveSubstitutions,
 boolean absent)

Deprecated, for removal: This API element is subject to removal in a future version.

SessionInfo objects will be created by the Axon Ivy Runtime. Don't create them on your own.

API:

This public API is available in Java.

Method Details

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 Java.

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 Java.

hasActiveSubstitutions

@Deprecated(forRemoval=true,
            since="12.0.8")
public boolean hasActiveSubstitutions()

Deprecated, for removal: This API element is subject to removal in a future version.

evaluate this for the given user on your own

Returns:

always false

See Also:

• ISession.hasActiveSubstitutions()

API:

This public API is available in Java.

isAbsent

@Deprecated(forRemoval=true,
            since="12.0.8")
public boolean isAbsent()

Deprecated, for removal: This API element is subject to removal in a future version.

evaluate this for the given user on your own IUser.isAbsent()

Returns:

always false

See Also:

• ISession.isAbsent()

API:

This public API is available in Java.

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 Java.

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 Java.