servlet::HttpSession Class Reference

#include <HttpSession.h>

Inheritance diagram for servlet::HttpSession:

[legend]

List of all members.

Public Member Functions
virtual	~HttpSession ()
virtual long	getCreationTime () const =0
virtual std::string	getId () const =0
virtual long	getLastAccessedTime () const =0
virtual const ServletContext &	getServletContext () const =0
virtual void	setMaxInactiveInterval (int interval)=0
virtual int	getMaxInactiveInterval () const =0
virtual boost::shared_ptr< void >	getAttribute (const std::string &name)=0
template<typename T >
T	getAttribute (const std::string &name)
virtual std::auto_ptr < std::vector< std::string > >	getAttributeNames () const =0
virtual void	setAttribute (const std::string &name, boost::shared_ptr< void > value)=0
template<typename T >
void	setAttribute (const std::string &name, boost::shared_ptr< T > value)
template<typename T >
void	setAttribute (const std::string &name, const T &value)
virtual bool	hasAttribute (const std::string &name) const =0
virtual void	removeAttribute (const std::string &name)=0
virtual void	invalidate ()=0
virtual bool	isNew () const =0

---

Detailed Description

HttpSession

Provides a way to identify a user across more than one page request or visit to a Web site and to store information about that user.

The servlet container uses this interface to create a session between an HTTP client and an HTTP server. The session persists for a specified time period, across more than one connection or page request from the user. A session usually corresponds to one user, who may visit a site many times. The server can maintain a session in many ways such as using cookies or rewriting URLs.

This interface allows servlets to

• View and manipulate information about a session, such as the session identifier, creation time, and last accessed time
• Bind objects to sessions, allowing user information to persist across multiple user connections

When an application stores an object in or removes an object from a session, the session checks whether the object implements servlet::HttpSessionBindingListener. If it does, the servlet notifies the object that it has been bound to or unbound from the session. Notifications are sent after the binding methods complete. For session that are invalidated or expire, notifications are sent after the session has been invalidated or expired.

When container migrates a session between VMs in a distributed container setting, all session attributes implementing the servlet::HttpSessionActivationListener interface are notified.

A servlet should be able to handle cases in which the client does not choose to join a session, such as when cookies are intentionally turned off. Until the client joins the session, isNew returns true. If the client chooses not to join the session, getSession will return a different session on each request, and isNew will always return true.

Session information is scoped only to the current web application (servlet::ServletContext), so information stored in one context will not be directly visible in another.

Author:

Various

Version:

$Version$

See also:

servlet::HttpSessionBindingListener

servlet::HttpSessionContext

Definition at line 118 of file HttpSession.h.

---

Constructor & Destructor Documentation

virtual servlet::HttpSession::~HttpSession

(

)

[inline, virtual]

Definition at line 120 of file HttpSession.h.

---

Member Function Documentation

template<typename T >

T servlet::HttpSession::getAttribute

(

const std::string &

name

)

[inline]

Reimplemented in container::HttpSessionImpl.

T servlet::HttpSession::getAttribute

(

const std::string &

name

)

[inline, pure virtual]

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

Parameters:

name

a string specifying the name of the object

Returns:

the object with the specified name

Exceptions:

IllegalStateException

if this method is called on an invalidated session

Implemented in container::HttpSessionImpl.

Definition at line 351 of file HttpSession.h.

virtual std::auto_ptr< std::vector<std::string> > servlet::HttpSession::getAttributeNames

(

)

const [pure virtual]

Returns an Enumeration of String objects containing the names of all the objects bound to this session.

Returns:

an Enumeration of String objects specifying the names of all the objects bound to this session

Exceptions:

IllegalStateException

if this method is called on an invalidated session

Implemented in container::HttpSessionImpl.

virtual long servlet::HttpSession::getCreationTime

(

)

const [pure virtual]

Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.

Returns:

a long specifying when this session was created, expressed in milliseconds since 1/1/1970 GMT

Exceptions:

IllegalStateException

if this method is called on an invalidated session

Implemented in container::HttpSessionImpl.

virtual std::string servlet::HttpSession::getId

(

)

const [pure virtual]

Returns a string containing the unique identifier assigned to this session. The identifier is assigned by the servlet container and is implementation dependent.

Returns:

a string specifying the identifier assigned to this session

Exceptions:

IllegalStateException

if this method is called on an invalidated session

Implemented in container::HttpSessionImpl.

Referenced by container::HttpServletRequestImpl::getSession().

virtual long servlet::HttpSession::getLastAccessedTime

(

)

const [pure virtual]

Returns the last time the client sent a request associated with this session, as the number of milliseconds since midnight January 1, 1970 GMT, and marked by the time the container received the request.

Actions that your application takes, such as getting or setting a value associated with the session, do not affect the access time.

Returns:

a long representing the last time the client sent a request associated with this session, expressed in milliseconds since 1/1/1970 GMT

Exceptions:

IllegalStateException

if this method is called on an invalidated session

Implemented in container::HttpSessionImpl.

virtual int servlet::HttpSession::getMaxInactiveInterval

(

)

const [pure virtual]

Returns the maximum time interval, in seconds, that the servlet container will keep this session open between client accesses. After this interval, the servlet container will invalidate the session. The maximum time interval can be set with the setMaxInactiveInterval method. A negative time indicates the session should never timeout.

Returns:

an integer specifying the number of seconds this session remains open between client requests

See also:

setMaxInactiveInterval

Implemented in container::HttpSessionImpl.

virtual const ServletContext& servlet::HttpSession::getServletContext

(

)

const [pure virtual]

Returns the ServletContext to which this session belongs.

Returns:

The ServletContext object for the web application

Since:

2.3

Implemented in container::HttpSessionImpl.

virtual bool servlet::HttpSession::hasAttribute

(

const std::string &

name

)

const [pure virtual]

[C++ Servlet API Extention]

Returns false if no attribute of the given name exists. Returns true otherwize

Parameters:

name

a String specifying the name of the attribute

Returns:

false if the attribute does not exist. true otherwize

Implemented in container::HttpSessionImpl.

virtual void servlet::HttpSession::invalidate

(

)

[pure virtual]

Invalidates this session then unbinds any objects bound to it.

Exceptions:

IllegalStateException

if this method is called on an already invalidated session

Implemented in container::HttpSessionImpl.

virtual bool servlet::HttpSession::isNew

(

)

const [pure virtual]

Returns true if the client does not yet know about the session or if the client chooses not to join the session. For example, if the server used only cookie-based sessions, and the client had disabled the use of cookies, then a session would be new on each request.

Returns:

true if the server has created a session, but the client has not yet joined

Exceptions:

IllegalStateException

if this method is called on an already invalidated session

Implemented in container::HttpSessionImpl.

Referenced by container::HttpServletRequestImpl::getSession().

virtual void servlet::HttpSession::removeAttribute

(

const std::string &

name

)

[pure virtual]

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.

After this method executes, and if the object implements HttpSessionBindingListener, the container calls HttpSessionBindingListener.valueUnbound. The container then notifies any HttpSessionAttributeListeners in the web application.

Parameters:

name

the name of the object to remove from this session

Exceptions:

IllegalStateException

if this method is called on an invalidated session

Implemented in container::HttpSessionImpl.

template<typename T >

void servlet::HttpSession::setAttribute	(	const std::string &	name,
		const T &	value
	)			[inline]

Definition at line 358 of file HttpSession.h.

References setAttribute().

Here is the call graph for this function:

template<typename T >

void servlet::HttpSession::setAttribute	(	const std::string &	name,
		boost::shared_ptr< T >	value
	)			[inline]

Definition at line 279 of file HttpSession.h.

References setAttribute().

Here is the call graph for this function:

virtual void servlet::HttpSession::setAttribute	(	const std::string &	name,
		boost::shared_ptr< void >	value
	)			[pure virtual]

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.

After this method executes, and if the new object implements HttpSessionBindingListener, the container calls HttpSessionBindingListener.valueBound. The container then notifies any HttpSessionAttributeListeners in the web application.

If an object was already bound to this session of this name that implements HttpSessionBindingListener, its HttpSessionBindingListener.valueUnbound method is called.

If the value passed in is null, this has the same effect as calling removeAttribute().

Parameters:

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

Exceptions:

IllegalStateException

if this method is called on an invalidated session

Implemented in container::HttpSessionImpl.

Referenced by setAttribute().

virtual void servlet::HttpSession::setMaxInactiveInterval

(

int

interval

)

[pure virtual]

Specifies the time, in seconds, between client requests before the servlet container will invalidate this session. A negative time indicates the session should never timeout.

Parameters:

interval

An integer specifying the number of seconds

Implemented in container::HttpSessionImpl.

---

The documentation for this class was generated from the following file:

• include/servlet/HttpSession.h