com.iplanet.dpro.session.share

Class SessionInfo

java.lang.Object

com.iplanet.dpro.session.share.SessionInfo

public class SessionInfo
extends Object

SessionInfo class holds all the information about the Session

Constructor Summary

Constructors

Constructor and Description
SessionInfo() Constructs SessionInfo

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getClientDomain() Cookie domain
String	getClientID() Cookie id
long	getExpiryTime(TimeUnit unit) Time at which this session will expire in milliseconds from the UTC epoch.
long	getMaxCaching() Max Session Cache time in minutes.
long	getMaxIdle() Max Session Idle time in minutes.
long	getMaxTime() Max Session Time in minutes.
Hashtable<String,String>	getProperties()
String	getSecret()
Set<String>	getSessionEventUrls()
String	getSessionID() Session id
String	getSessionType() Session type
String	getState() Session state
long	getTimeIdle() Session idle time in seconds.
long	getTimeLeft() Time left for Session to become inactive, in seconds.
int	hashCode()
boolean	isNeverExpiring() Whether the session will ever expire or not.
void	setClientDomain(String cdomain)
void	setClientID(String cid)
void	setExpiryTime(long expiryTime, TimeUnit unit)
void	setMaxCaching(long maxcaching)
void	setMaxIdle(long maxidle)
void	setMaxTime(long maxtime)
void	setNeverExpiring(boolean neverExpiring) Indicates that the session should never expire.
void	setProperties(Hashtable<String,String> properties)
void	setSecret(String secret)
void	setSessionEventUrls(Set<String> sessionEventUrls)
void	setSessionID(String sid)
void	setSessionType(String stype)
void	setState(String state)
void	setTimeIdle(long timeidle)
void	setTimeLeft(long timeleft)
String	toString()
String	toXMLString() translates the Session Information to an XML document String based

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SessionInfo

public SessionInfo()

Constructs SessionInfo

Method Detail

toXMLString

public String toXMLString()

translates the Session Information to an XML document String based

Returns:

An XML String representing the information

getSessionID

public String getSessionID()

Session id

setSessionID

public void setSessionID(String sid)

getSecret

public String getSecret()

setSecret

public void setSecret(String secret)

getSessionType

public String getSessionType()

Session type

setSessionType

public void setSessionType(String stype)

getClientID

public String getClientID()

Cookie id

setClientID

public void setClientID(String cid)

getClientDomain

public String getClientDomain()

Cookie domain

setClientDomain

public void setClientDomain(String cdomain)

getMaxTime

public long getMaxTime()

Max Session Time in minutes.

setMaxTime

public void setMaxTime(long maxtime)

getMaxIdle

public long getMaxIdle()

Max Session Idle time in minutes.

setMaxIdle

public void setMaxIdle(long maxidle)

getMaxCaching

public long getMaxCaching()

Max Session Cache time in minutes.

setMaxCaching

public void setMaxCaching(long maxcaching)

getExpiryTime

public long getExpiryTime(TimeUnit unit)

Time at which this session will expire in milliseconds from the UTC epoch.

setExpiryTime

public void setExpiryTime(long expiryTime,
                          TimeUnit unit)

setNeverExpiring

public void setNeverExpiring(boolean neverExpiring)

Indicates that the session should never expire.

Parameters:

neverExpiring - true if the session should never expire. If false this method does nothing.

isNeverExpiring

public boolean isNeverExpiring()

Whether the session will ever expire or not.

getTimeIdle

public long getTimeIdle()

Session idle time in seconds.

setTimeIdle

public void setTimeIdle(long timeidle)

getTimeLeft

public long getTimeLeft()

Time left for Session to become inactive, in seconds.

setTimeLeft

public void setTimeLeft(long timeleft)

getState

public String getState()

Session state

setState

public void setState(String state)

getProperties

public Hashtable<String,String> getProperties()

setProperties

public void setProperties(Hashtable<String,String> properties)

getSessionEventUrls

public Set<String> getSessionEventUrls()

setSessionEventUrls

public void setSessionEventUrls(Set<String> sessionEventUrls)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object