org.forgerock.openam.dpro.session

Class PartialSession

java.lang.Object

org.forgerock.openam.dpro.session.PartialSession

public class PartialSession
extends Object

The JSON representation of partially described session objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PartialSession.Builder A builder to help with construction of PartialSession instances.

Method Summary

Modifier and Type	Method and Description
org.forgerock.json.JsonValue	asJson()
String	getLatestAccessTime() The timestamp of when the session was last used.
String	getMaxIdleExpirationTime() The timestamp of when the max idle timeout will be reached.
String	getMaxSessionExpirationTime() The timestamp of when the max session timeout will be reached.
String	getRealm() Returns the realm associated with this partial session.
String	getSessionHandle() Returns the session handle associated with this partial session.
String	getUniversalId() Returns the universal ID associated with this partial session.
String	getUsername() Returns the username associated with this partial session.

Methods inherited from class java.lang.Object

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

Method Detail

getUsername

public String getUsername()

Returns the username associated with this partial session.

Returns:

The user friendly username.

getUniversalId

public String getUniversalId()

Returns the universal ID associated with this partial session.

Returns:

The universal ID of the user this partial session belongs to.

getRealm

public String getRealm()

Returns the realm associated with this partial session.

Returns:

The realm where this session was created.

getSessionHandle

public String getSessionHandle()

Returns the session handle associated with this partial session.

Returns:

The session's handle.

getLatestAccessTime

public String getLatestAccessTime()

The timestamp of when the session was last used.

Returns:

The timestamp of when the session was last used.

getMaxIdleExpirationTime

public String getMaxIdleExpirationTime()

The timestamp of when the max idle timeout will be reached.

Returns:

When this session will time out due to inactivity.

getMaxSessionExpirationTime

public String getMaxSessionExpirationTime()

The timestamp of when the max session timeout will be reached.

Returns:

When the session will time out.

asJson

public org.forgerock.json.JsonValue asJson()