com.plumtree.openfoundation.web
Class XPSession

java.lang.Object
  com.plumtree.openfoundation.web.XPSession

All Implemented Interfaces:

IXPSession

public class XPSession

extends java.lang.Object

implements IXPSession

XPSession wraps HttpSession.

Constructor Summary

XPSession(HttpSession session)
Constructs XPSession wrapping the passed HttpSession object.

Method Summary

void	Abandon() Invalidates this session then unbinds any objects bound to it.
java.lang.Object	GetAttribute(java.lang.String name) Returns the session object bound with the specified name in this session, or null if no object is bound under the name.
HttpSession	GetUnderlyingObject() This method retuns underlying HttpSession object.
void	RemoveAttribute(java.lang.String name) Removes the object bound with the specified name from this session.
void	SetAttribute(java.lang.String name, java.lang.Object _value) Binds an object to this session, using the name specified.

Methods inherited from class java.lang.Object

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

Constructor Detail

XPSession

public XPSession(HttpSession session)

Constructs XPSession wrapping the passed HttpSession object.

Parameters:

session - - HttpSession object to be wrapped.

Method Detail

GetAttribute

public java.lang.Object GetAttribute(java.lang.String name)

Returns the session object bound with the specified name in this session, or null if no object is bound under the name.

Specified by:

GetAttribute in interface IXPSession

Parameters:

name - - a string specifying the name of the object

Returns:

the object with the specified name

SetAttribute

public void SetAttribute(java.lang.String name,
                         java.lang.Object _value)

Binds an object to this session, using the name specified. If an object of the same name is already. bound to the session, the object is replaced.

Specified by:

SetAttribute in interface IXPSession

Parameters:

name - - the name to which the object is bound; cannot be null

_value - - the object to be bound

RemoveAttribute

public void RemoveAttribute(java.lang.String name)

Removes the object bound with the specified name from this session. If the session does not have an object bound with the specified name, this method does nothing.

Specified by:

RemoveAttribute in interface IXPSession

Parameters:

name - - the name of the object to remove from this session.

Abandon

public void Abandon()

Invalidates this session then unbinds any objects bound to it.

Specified by:

Abandon in interface IXPSession

GetUnderlyingObject

public HttpSession GetUnderlyingObject()

This method retuns underlying HttpSession object.

Returns:

HttpSession Object.