com.vaadin.server
Class WrappedHttpSession

java.lang.Object
  com.vaadin.server.WrappedHttpSession

All Implemented Interfaces:

WrappedSession

public class WrappedHttpSession
extends java.lang.Object
implements WrappedSession

Wrapper for HttpSession.

Since:

7.0.0

Version:

@VERSION@

Author:

Vaadin Ltd

Constructor Summary

WrappedHttpSession(javax.servlet.http.HttpSession session)
Creates a new wrapped http session.

Method Summary

java.lang.Object	getAttribute(java.lang.String name) Gets an attribute from this session.
java.util.Set<java.lang.String>	getAttributeNames() Gets the current set of attribute names stored in this session.
javax.servlet.http.HttpSession	getHttpSession() Gets the wrapped HttpSession.
java.lang.String	getId() Gets a string with a unique identifier for the session.
int	getMaxInactiveInterval() Returns the maximum time interval, in seconds, that this session will be kept open between client accesses.
void	invalidate() Invalidates this session then unbinds any objects bound to it.
void	setAttribute(java.lang.String name, java.lang.Object value) Saves an attribute value in this session.

Methods inherited from class java.lang.Object

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

Constructor Detail

WrappedHttpSession

public WrappedHttpSession(javax.servlet.http.HttpSession session)

Creates a new wrapped http session.

Parameters:

session - the http session to wrap.

Method Detail

getMaxInactiveInterval

public int getMaxInactiveInterval()

Description copied from interface: WrappedSession

Returns the maximum time interval, in seconds, that this session will be kept open between client accesses.

Specified by:

getMaxInactiveInterval in interface WrappedSession

Returns:

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

See Also:

HttpSession.getMaxInactiveInterval(), PortletSession.getMaxInactiveInterval()

getAttribute

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

Description copied from interface: WrappedSession

Gets an attribute from this session.

Specified by:

getAttribute in interface WrappedSession

Parameters:

name - the name of the attribute

Returns:

the attribute value, or null if the attribute is not defined in the session

See Also:

HttpSession.getAttribute(String), PortletSession.getAttribute(String)

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object value)

Description copied from interface: WrappedSession

Saves an attribute value in this session.

Specified by:

setAttribute in interface WrappedSession

Parameters:

name - the name of the attribute

value - the attribute value

See Also:

HttpSession.setAttribute(String, Object), PortletSession.setAttribute(String, Object)

getHttpSession

public javax.servlet.http.HttpSession getHttpSession()

Gets the wrapped HttpSession.

Returns:

the wrapped http session

getAttributeNames

public java.util.Set<java.lang.String> getAttributeNames()

Description copied from interface: WrappedSession

Gets the current set of attribute names stored in this session.

Specified by:

getAttributeNames in interface WrappedSession

Returns:

an unmodifiable set of the current attribute names

See Also:

HttpSession.getAttributeNames(), PortletSession.getAttributeNames()

invalidate

public void invalidate()

Description copied from interface: WrappedSession

Invalidates this session then unbinds any objects bound to it.

Specified by:

invalidate in interface WrappedSession

See Also:

HttpSession.invalidate(), PortletSession.invalidate()

getId

public java.lang.String getId()

Description copied from interface: WrappedSession

Gets a string with a unique identifier for the session.

Specified by:

getId in interface WrappedSession

Returns:

a unique session id string