org.apache.axis.transport.http

Class AxisHttpSession

Implemented Interfaces:
Session

public class AxisHttpSession
extends java.lang.Object
implements Session

An HTTP/Servlet implementation of Axis sessions.

Author:
Glen Daniels (gdaniels@apache.org)

Field Summary

static String
AXIS_SESSION_MARKER

Constructor Summary

AxisHttpSession(HttpServletRequest realRequest)
AxisHttpSession(HttpSession realSession)

Method Summary

protected void
ensureSession()
Object
get(String key)
Get a property from the session
Enumeration
getKeys()
Get an enumeration of the keys in this session
Object
getLockObject()
Get an Object suitable for synchronizing the session.
HttpSession
getRep()
Get the internal HttpSession.
int
getTimeout()
Return the sessions' time-to-live.
void
invalidate()
invalidate the session
void
remove(String key)
Remove a property from the session
void
set(String key, Object value)
Set a property in the session
void
setTimeout(int timeout)
Set the session's time-to-live.
void
touch()
"Touch" the session (mark it recently used)

Field Details

AXIS_SESSION_MARKER

public static final String AXIS_SESSION_MARKER

Constructor Details

AxisHttpSession

public AxisHttpSession(HttpServletRequest realRequest)


AxisHttpSession

public AxisHttpSession(HttpSession realSession)

Method Details

ensureSession

protected void ensureSession()


get

public Object get(String key)
Get a property from the session
Specified by:
get in interface Session

Parameters:
key - the name of the property desired.


getKeys

public Enumeration getKeys()
Get an enumeration of the keys in this session
Specified by:
getKeys in interface Session


getLockObject

public Object getLockObject()
Get an Object suitable for synchronizing the session. This method exists because different session implementations might provide different ways of getting at shared data. For a simple hashtable- based session, this would just be the hashtable, but for sessions which use database connections, etc. it might be an object wrapping a table ID or somesuch.
Specified by:
getLockObject in interface Session


getRep

public HttpSession getRep()
Get the internal HttpSession.


getTimeout

public int getTimeout()
Return the sessions' time-to-live.
Specified by:
getTimeout in interface Session

Returns:
the timeout value for this session.


invalidate

public void invalidate()
invalidate the session
Specified by:
invalidate in interface Session


remove

public void remove(String key)
Remove a property from the session
Specified by:
remove in interface Session

Parameters:
key - the name of the property desired.


set

public void set(String key,
                Object value)
Set a property in the session
Specified by:
set in interface Session

Parameters:
key - the name of the property to set.
value - the value of the property.


setTimeout

public void setTimeout(int timeout)
Set the session's time-to-live. This is implementation-specific, but basically should be the # of seconds of inactivity which will cause the session to time out and invalidate. "inactivity" is implementation-specific.
Specified by:
setTimeout in interface Session


touch

public void touch()
"Touch" the session (mark it recently used)
Specified by:
touch in interface Session


Copyright B) 2005 Apache Web Services Project. All Rights Reserved.