## org.apache.axis.session
Interface Session

All Known Implementing Classes:
  AxisHttpSession, SimpleSession

public interface Session

An abstract interface to provide session storage to Axis services. This is extremely basic at the moment.

Author:
  Glen Daniels (gdaniels@apache.org)

Method Summary
`java.lang.Object` `get(java.lang.String key)` Get a property from the session
`java.util.Enumeration` `getKeys()` Get an enumeration of the keys in this session
`java.lang.Object` `getLockObject()` Get an Object suitable for synchronizing the session.
`int` `getTimeout()` Return the sessions' time-to-live.
`void` `invalidate()` invalidate the session
`void` `remove(java.lang.String key)` Remove a property from the session
`void` `set(java.lang.String key, java.lang.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)

Method Detail

### get

    public java.lang.Object get(java.lang.String key)

  Get a property from the session

  Parameters:
    `key` - the name of the property desired.

### set

    public void set(java.lang.String key,
                    java.lang.Object value)

  Set a property in the session

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

### remove

    public void remove(java.lang.String key)

  Remove a property from the session

  Parameters:
    `key` - the name of the property desired.

### getKeys

    public java.util.Enumeration getKeys()

  Get an enumeration of the keys in this session

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

### getTimeout

    public int getTimeout()

  Return the sessions' time-to-live.

  Returns:
    the timeout value for this session.

### touch

    public void touch()

  "Touch" the session (mark it recently used)

### invalidate

    public void invalidate()

  invalidate the session

### getLockObject

    public java.lang.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.

Copyright © 2005 Apache Web Services Project. All Rights Reserved.