de.uplanet.lucy.server.portalserver
Class Session

java.lang.Object
  extended by de.uplanet.lucy.server.session.AbstractSession
      extended by de.uplanet.lucy.server.portalserver.Session
All Implemented Interfaces:
de.uplanet.lucy.server.session.ISession, de.uplanet.util.IDumpable

public class Session
extends de.uplanet.lucy.server.session.AbstractSession
implements de.uplanet.util.IDumpable

Version:
$Revision: 79413 $

Field Summary
 
Fields inherited from interface de.uplanet.lucy.server.session.ISession
DEFAULT_TIMEOUT
 
Method Summary
 java.lang.String dump()
           
 java.lang.String getAuthConfigName()
           
 java.lang.String getId()
          Get the unique session identifier.
 long getLastAccessTime()
          Get the time of the last access to this session.
 de.uplanet.lucy.server.portalserver.SessionManager getManager()
          Get this session's manager.
 long getTimeout()
          Get the session timeout.
 IUser getUser()
          Get the user that is associated with the session.
 boolean hasAuthenticatedUser()
          Deprecated. 
 boolean isAnonymous()
          Determine if the session is an anonymous session.
 boolean isStale(long p_lTimeNow)
          Test if the session has timed out.
 void logout()
          This method merely delegates logout calls to the associated session manager.
 void setTimeout(long p_lTimeout)
          Set the session timeout.
 void touch()
          Touch the session.
 
Methods inherited from class de.uplanet.lucy.server.session.AbstractSession
addListener, containsKey, get, get, getCreationTime, getSubject, isLoggedOut, isStale, keySet, put, remove
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getManager

public de.uplanet.lucy.server.portalserver.SessionManager getManager()
Get this session's manager.


getId

public java.lang.String getId()
Description copied from interface: de.uplanet.lucy.server.session.ISession
Get the unique session identifier.

Specified by:
getId in interface de.uplanet.lucy.server.session.ISession

getUser

public IUser getUser()
Description copied from interface: de.uplanet.lucy.server.session.ISession
Get the user that is associated with the session.

Specified by:
getUser in interface de.uplanet.lucy.server.session.ISession
Returns:
The user that is associated with this session, or null.

hasAuthenticatedUser

@Deprecated
public boolean hasAuthenticatedUser()
Deprecated. 

Returns:
true if the session has an aggregated user object, false otherwise.

getAuthConfigName

public java.lang.String getAuthConfigName()

isAnonymous

public boolean isAnonymous()
Description copied from interface: de.uplanet.lucy.server.session.ISession
Determine if the session is an anonymous session.

Specified by:
isAnonymous in interface de.uplanet.lucy.server.session.ISession
Returns:
true if the session is anonymous, false otherwise.

getTimeout

public long getTimeout()
Description copied from interface: de.uplanet.lucy.server.session.ISession
Get the session timeout.

Specified by:
getTimeout in interface de.uplanet.lucy.server.session.ISession
Returns:
p_lTimeout The timeout in milliseconds.

setTimeout

public void setTimeout(long p_lTimeout)
Description copied from interface: de.uplanet.lucy.server.session.ISession
Set the session timeout.

Specified by:
setTimeout in interface de.uplanet.lucy.server.session.ISession
Parameters:
p_lTimeout - The timeout in milliseconds.

getLastAccessTime

public long getLastAccessTime()
Description copied from interface: de.uplanet.lucy.server.session.ISession
Get the time of the last access to this session.

Specified by:
getLastAccessTime in interface de.uplanet.lucy.server.session.ISession
Returns:
The time of last access.

isStale

public boolean isStale(long p_lTimeNow)
Description copied from interface: de.uplanet.lucy.server.session.ISession
Test if the session has timed out.

Specified by:
isStale in interface de.uplanet.lucy.server.session.ISession
Returns:
true if the session has timed out, false otherwise.

touch

public void touch()
Description copied from interface: de.uplanet.lucy.server.session.ISession
Touch the session.

Specified by:
touch in interface de.uplanet.lucy.server.session.ISession

logout

public void logout()
This method merely delegates logout calls to the associated session manager.

Specified by:
logout in interface de.uplanet.lucy.server.session.ISession

dump

public java.lang.String dump()
Specified by:
dump in interface de.uplanet.util.IDumpable


Last updated: 2011-01-27
Copyright 2000-2010 United Planet. All Rights Reserved.