com.vaadin.server
Interface WrappedSession

All Known Implementing Classes:

WrappedHttpSession, WrappedPortletSession

public interface WrappedSession

A generic session, wrapping a more specific session implementation, e.g. HttpSession or PortletSession.

Since:

7.0.0

Version:

@VERSION@

Author:

Vaadin Ltd

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

Method Detail

getMaxInactiveInterval

int getMaxInactiveInterval()

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

Returns:

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

See Also:

HttpSession.getMaxInactiveInterval(), PortletSession.getMaxInactiveInterval()

getAttribute

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

Gets an attribute from this session.

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

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

Saves an attribute value in this session.

Parameters:

name - the name of the attribute

value - the attribute value

See Also:

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

getAttributeNames

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

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

Returns:

an unmodifiable set of the current attribute names

See Also:

HttpSession.getAttributeNames(), PortletSession.getAttributeNames()

invalidate

void invalidate()

Invalidates this session then unbinds any objects bound to it.

See Also:

HttpSession.invalidate(), PortletSession.invalidate()

getId

java.lang.String getId()

Gets a string with a unique identifier for the session.

Returns:

a unique session id string