org.apache.pluto.internal.impl
Class PortletSessionImpl

java.lang.Object
  org.apache.pluto.internal.impl.PortletSessionImpl

All Implemented Interfaces:

PortletSession, javax.servlet.http.HttpSession

public class PortletSessionImpl
extends java.lang.Object
implements PortletSession, javax.servlet.http.HttpSession

Implementation of the javax.portlet.PortletSession interface.

Field Summary

Fields inherited from interface javax.portlet.PortletSession

APPLICATION_SCOPE, PORTLET_SCOPE

Constructor Summary

PortletSessionImpl(PortletContext portletContext, InternalPortletWindow internalPortletWindow, javax.servlet.http.HttpSession httpSession)
Constructs an instance.

Method Summary

java.lang.Object	getAttribute(java.lang.String name) Returns the object bound with the specified name in this session under the PORTLET_SCOPE, or null if no object is bound under the name in that scope.
java.lang.Object	getAttribute(java.lang.String name, int scope) Returns the attribute of the specified name under the given scope.
java.util.Map<java.lang.String,java.lang.Object>	getAttributeMap() Returns a Map of the session attributes in the portlet session scope.
java.util.Map<java.lang.String,java.lang.Object>	getAttributeMap(int scope) Returns a Map of the session attributes in the portlet session scope.
java.util.Enumeration	getAttributeNames() Returns an Enumeration of String objects containing the names of all the objects bound to this session under the PORTLET_SCOPE, or an empty Enumeration if no attributes are available.
java.util.Enumeration<java.lang.String>	getAttributeNames(int scope) Returns an Enumeration of String objects containing the names of all the objects bound to this session in the given scope, or an empty Enumeration if no attributes are available in the given scope.
long	getCreationTime() Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.
java.lang.String	getId() Returns a string containing the unique identifier assigned to this session.
long	getLastAccessedTime() Returns the last time the client sent a request associated with this session, as the number of milliseconds since midnight January 1, 1970 GMT.
java.util.Map<java.lang.String,java.lang.Object>	getMap()
java.util.Map<java.lang.String,java.lang.Object>	getMap(int scope)
int	getMaxInactiveInterval() Returns the maximum time interval, in seconds, for which the portlet container keeps this session open between client accesses.
PortletContext	getPortletContext() Returns the portlet application context associated with this session.
javax.servlet.ServletContext	getServletContext()
javax.servlet.http.HttpSessionContext	getSessionContext() Deprecated.
java.lang.Object	getValue(java.lang.String name)
java.lang.String[]	getValueNames() Deprecated.
void	invalidate() Invalidates this session (all scopes) and unbinds any objects bound to it.
boolean	isNew() Returns true if the client does not yet know about the session or if the client chooses not to join the session.
void	putValue(java.lang.String name, java.lang.Object value)
void	removeAttribute(java.lang.String name) Removes the object bound with the specified name under the PORTLET_SCOPE from this session.
void	removeAttribute(java.lang.String name, int scope) Removes the object bound with the specified name and the given scope from this session.
void	removeValue(java.lang.String name)
void	setAttribute(java.lang.String name, java.lang.Object value) Binds an object to this session under the PORTLET_SCOPE, using the name specified.
void	setAttribute(java.lang.String name, java.lang.Object value, int scope) Binds an object to this session in the given scope, using the name specified.
void	setIncludeOrForward(boolean isIncludeOrForward)
void	setMaxInactiveInterval(int interval) Specifies the time, in seconds, between client requests, before the portlet container invalidates this session.

Methods inherited from class java.lang.Object

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

Constructor Detail

PortletSessionImpl

public PortletSessionImpl(PortletContext portletContext,
                          InternalPortletWindow internalPortletWindow,
                          javax.servlet.http.HttpSession httpSession)

Constructs an instance.

Method Detail

getAttribute

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

Description copied from interface: PortletSession

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

Specified by:

getAttribute in interface PortletSession

Specified by:

getAttribute in interface javax.servlet.http.HttpSession

Parameters:

name - a string specifying the name of the object

Returns:

the object with the specified name for the PORTLET_SCOPE.

getAttribute

public java.lang.Object getAttribute(java.lang.String name,
                                     int scope)

Returns the attribute of the specified name under the given scope.

Specified by:

getAttribute in interface PortletSession

Parameters:

name - the attribute name.

scope - the scope under which the attribute object is stored.

Returns:

the attribute object.

getAttributeNames

public java.util.Enumeration getAttributeNames()

Description copied from interface: PortletSession

Returns an Enumeration of String objects containing the names of all the objects bound to this session under the PORTLET_SCOPE, or an empty Enumeration if no attributes are available.

Specified by:

getAttributeNames in interface PortletSession

Specified by:

getAttributeNames in interface javax.servlet.http.HttpSession

Returns:

an Enumeration of String objects specifying the names of all the objects bound to this session, or an empty Enumeration if no attributes are available.

getAttributeNames

public java.util.Enumeration<java.lang.String> getAttributeNames(int scope)

Description copied from interface: PortletSession

Returns an Enumeration of String objects containing the names of all the objects bound to this session in the given scope, or an empty Enumeration if no attributes are available in the given scope.

Specified by:

getAttributeNames in interface PortletSession

Parameters:

scope - session scope of the attribute names

Returns:

an Enumeration of String objects specifying the names of all the objects bound to this session, or an empty Enumeration if no attributes are available in the given scope.

removeAttribute

public void removeAttribute(java.lang.String name)

Description copied from interface: PortletSession

Removes the object bound with the specified name under the PORTLET_SCOPE 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 PortletSession

Specified by:

removeAttribute in interface javax.servlet.http.HttpSession

Parameters:

name - the name of the object to be removed from this session in the PORTLET_SCOPE.

removeAttribute

public void removeAttribute(java.lang.String name,
                            int scope)

Description copied from interface: PortletSession

Removes the object bound with the specified name and the given scope 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 PortletSession

Parameters:

name - the name of the object to be removed from this session

scope - session scope of this attribute

setAttribute

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

Description copied from interface: PortletSession

Binds an object to this session under the PORTLET_SCOPE, using the name specified. If an object of the same name in this scope is already bound to the session, that object is replaced.

After this method has been executed, 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 that implements HttpSessionBindingListener, its HttpSessionBindingListener.valueUnbound method is called.

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

Specified by:

setAttribute in interface PortletSession

Specified by:

setAttribute in interface javax.servlet.http.HttpSession

Parameters:

name - the name to which the object is bound under the PORTLET_SCOPE; this cannot be null.

value - the object to be bound

setAttribute

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

Description copied from interface: PortletSession

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

After this method has been executed, 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 that implements HttpSessionBindingListener, its HttpSessionBindingListener.valueUnbound method is called.

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

Specified by:

setAttribute in interface PortletSession

Parameters:

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

value - the object to be bound

scope - session scope of this attribute

getPortletContext

public PortletContext getPortletContext()

Description copied from interface: PortletSession

Returns the portlet application context associated with this session.

Specified by:

getPortletContext in interface PortletSession

Returns:

the portlet application context

getCreationTime

public long getCreationTime()

Description copied from interface: PortletSession

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

Specified by:

getCreationTime in interface PortletSession

Specified by:

getCreationTime in interface javax.servlet.http.HttpSession

Returns:

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

getId

public java.lang.String getId()

Description copied from interface: PortletSession

Returns a string containing the unique identifier assigned to this session.

Specified by:

getId in interface PortletSession

Specified by:

getId in interface javax.servlet.http.HttpSession

Returns:

a string specifying the identifier assigned to this session

getLastAccessedTime

public long getLastAccessedTime()

Description copied from interface: PortletSession

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

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

Specified by:

getLastAccessedTime in interface PortletSession

Specified by:

getLastAccessedTime in interface javax.servlet.http.HttpSession

Returns:

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

getMaxInactiveInterval

public int getMaxInactiveInterval()

Description copied from interface: PortletSession

Returns the maximum time interval, in seconds, for which the portlet container keeps this session open between client accesses. After this interval, the portlet container invalidates the session. The maximum time interval can be set with the setMaxInactiveInterval method. A negative time indicates the session should never timeout.

Specified by:

getMaxInactiveInterval in interface PortletSession

Specified by:

getMaxInactiveInterval in interface javax.servlet.http.HttpSession

Returns:

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

See Also:

PortletSession.setMaxInactiveInterval(int)

invalidate

public void invalidate()
                throws java.lang.IllegalStateException

Description copied from interface: PortletSession

Invalidates this session (all scopes) and unbinds any objects bound to it.

Invalidating the portlet session will result in invalidating the underlying HttpSession

Specified by:

invalidate in interface PortletSession

Specified by:

invalidate in interface javax.servlet.http.HttpSession

Throws:

java.lang.IllegalStateException - if this method is called on a session which has already been invalidated

isNew

public boolean isNew()
              throws java.lang.IllegalStateException

Description copied from interface: PortletSession

Returns true if the client does not yet know about the session or if the client chooses not to join the session.

Specified by:

isNew in interface PortletSession

Specified by:

isNew in interface javax.servlet.http.HttpSession

Returns:

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

Throws:

java.lang.IllegalStateException - if this method is called on a session which has already been invalidated

setMaxInactiveInterval

public void setMaxInactiveInterval(int interval)

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

[Portlet Spec. PLT. 15.4.] If the PortletSession object is invalidated by a portlet, the portlet container must invalidate the associated HttpSession object.

Specified by:

setMaxInactiveInterval in interface PortletSession

Specified by:

setMaxInactiveInterval in interface javax.servlet.http.HttpSession

Parameters:

interval - an integer specifying the number of seconds.

getServletContext

public javax.servlet.ServletContext getServletContext()

Specified by:

getServletContext in interface javax.servlet.http.HttpSession

getSessionContext

public javax.servlet.http.HttpSessionContext getSessionContext()

Deprecated.

DEPRECATED: implemented for backwards compatability with HttpSession.

Specified by:

getSessionContext in interface javax.servlet.http.HttpSession

getValue

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

Specified by:

getValue in interface javax.servlet.http.HttpSession

getValueNames

public java.lang.String[] getValueNames()

Deprecated.

DEPRECATED: Implemented for backwards compatibility with HttpSession.

Specified by:

getValueNames in interface javax.servlet.http.HttpSession

putValue

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

Specified by:

putValue in interface javax.servlet.http.HttpSession

removeValue

public void removeValue(java.lang.String name)

Specified by:

removeValue in interface javax.servlet.http.HttpSession

getMap

public java.util.Map<java.lang.String,java.lang.Object> getMap()

getMap

public java.util.Map<java.lang.String,java.lang.Object> getMap(int scope)

setIncludeOrForward

public void setIncludeOrForward(boolean isIncludeOrForward)

getAttributeMap

public java.util.Map<java.lang.String,java.lang.Object> getAttributeMap(int scope)

Returns a Map of the session attributes in the portlet session scope.

The keys are of type String and the values in the returned Map are from type Object.

If no session attributes exist this method returns an empty Map.

Specified by:

getAttributeMap in interface PortletSession

Parameters:

scope - session scope of this attribute

Returns:

an immutable Map containing the session attributes in the portlet session scope as keys and attribute values as map values, or an empty Map if no session attributes exist. The keys in the map are of type String, the values of type Object.

Since:

2.0

getAttributeMap

public java.util.Map<java.lang.String,java.lang.Object> getAttributeMap()

Returns a Map of the session attributes in the portlet session scope.

The keys are of type String and the values in the returned Map are from type Object.

If no session attributes exist this method returns an empty Map.

Specified by:

getAttributeMap in interface PortletSession

Returns:

an immutable Map containing the session attributes in the portlet session scope as keys and attribute values as map values, or an empty Map if no session attributes exist. The keys in the map are of type String, the values of type Object.

Since:

2.0