| javax.portlet.PortletSession
All known Subclasses: com.sun.portal.portlet.impl.PortletSessionImpl,
| PortletSession | | public interface PortletSession (Code) | | The PortletSession interface provides a way to identify a user
across more than one request and to store transient information about that user.
A PortletSession is created per user client per portlet application.
A portlet can bind an object attribute into a PortletSession by name.
The PortletSession interface defines two scopes for storing objects:
APPLICATION_SCOPE
PORTLET_SCOPE
All objects stored in the session using the APPLICATION_SCOPE
must be available to all the portlets, servlets and
JSPs that belongs to the same portlet application and that handles a
request identified as being a part of the same session.
Objects stored in the session using the PORTLET_SCOPE must be
available to the portlet during requests for the same portlet window
that the objects where stored from. Attributes stored in the
PORTLET_SCOPE are not protected from other web components
of the portlet application. They are just conveniently namespaced.
The portlet session is based on the HttpSession. Therefore all
HttpSession listeners do apply to the portlet session and
attributes set in the portlet session are visible in the HttpSession
and vice versa.
|
| Field Summary | |
| final public static int | APPLICATION_SCOPE
This constant defines an application wide scope for the session attribute. | | final public static int | PORTLET_SCOPE
This constant defines the scope of the session attribute to be
private to the portlet and its included resources. |
| Method Summary | |
| public 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. | | public java.lang.Object | getAttribute(java.lang.String name, int scope)
Returns the object bound with the specified name in this session,
or null if no object is bound under the name in the given scope. | | public 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. | | public java.util.Enumeration | 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. | | public long | getCreationTime()
Returns the time when this session was created, measured in
milliseconds since midnight January 1, 1970 GMT. | | public java.lang.String | getId()
Returns a string containing the unique identifier assigned to this session. | | public 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. | | public int | getMaxInactiveInterval()
Returns the maximum time interval, in seconds, for which the portlet container
keeps this session open between client accesses. | | public PortletContext | getPortletContext()
Returns the portlet application context associated with this session. | | public void | invalidate()
Invalidates this session (all scopes) and unbinds any objects bound to it. | | public boolean | isNew()
Returns true if the client does not yet know about the session or
if the client chooses not to join the session. | | public void | removeAttribute(String name)
Removes the object bound with the specified name under
the PORTLET_SCOPE from
this session. | | public void | removeAttribute(String name, int scope)
Removes the object bound with the specified name and the given scope from
this session. | | public void | setAttribute(java.lang.String name, java.lang.Object value)
Binds an object to this session under the PORTLET_SCOPE, using the name specified. | | public 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. | | public void | setMaxInactiveInterval(int interval)
Specifies the time, in seconds, between client requests, before the
portlet container invalidates this session. |
| APPLICATION_SCOPE | | final public static int APPLICATION_SCOPE(Code) | | This constant defines an application wide scope for the session attribute.
APPLICATION_SCOPE session attributes enable Portlets
within one portlet application to share data.
Portlets may need to prefix attributes set in this scope with some
ID, to avoid overwriting each other's attributes in the
case where two portlets of the same portlet definition
are created.
Value: 0x01
|
| PORTLET_SCOPE | | final public static int PORTLET_SCOPE(Code) | | This constant defines the scope of the session attribute to be
private to the portlet and its included resources.
Value: 0x02
|
| getAttribute | | public java.lang.Object getAttribute(java.lang.String name, int scope)(Code) | | Returns the object bound with the specified name in this session,
or null if no object is bound under the name in the given scope.
Parameters:
name - a string specifying the name of the object
Parameters:
scope - session scope of this attribute the object with the specified name
exception:
java.lang.IllegalStateException - if this method is called on aninvalidated session
exception:
java.lang.IllegalArgumentException - if name is null. |
| getAttributeNames | | public java.util.Enumeration getAttributeNames()(Code) | | 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.
an Enumeration of String objects specifying thenames of all the objects bound tothis session, or an empty Enumeration if no attributes are available.
exception:
java.lang.IllegalStateException - if this method is called on aninvalidated session |
| getAttributeNames | | public java.util.Enumeration getAttributeNames(int scope)(Code) | | 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.
Parameters:
scope - session scope of the attribute names an Enumeration of String objects specifying thenames of all the objects bound tothis session, or an empty Enumeration if no attributes are available in the given scope.
exception:
java.lang.IllegalStateException - if this method is called on aninvalidated session |
| getCreationTime | | public long getCreationTime()(Code) | | Returns the time when this session was created, measured in
milliseconds since midnight January 1, 1970 GMT.
a long specifyingwhen this session was created,expressed in milliseconds since 1/1/1970 GMT
exception:
java.lang.IllegalStateException - if this method is called on aninvalidated session |
| getId | | public java.lang.String getId()(Code) | | Returns a string containing the unique identifier assigned to this session.
a string specifying the identifierassigned to this session |
| getLastAccessedTime | | public long getLastAccessedTime()(Code) | | 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.
a longrepresenting the last time the client sent a request associatedwith this session, expressed in milliseconds since 1/1/1970 GMT |
| getMaxInactiveInterval | | public int getMaxInactiveInterval()(Code) | | 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.
an integer specifying the number ofseconds this session remains openbetween client requests
See Also: PortletSession.setMaxInactiveInterval |
| getPortletContext | | public PortletContext getPortletContext()(Code) | | Returns the portlet application context associated with this session.
the portlet application context |
| invalidate | | public void invalidate()(Code) | | Invalidates this session (all scopes) and unbinds any objects bound to it.
Invalidating the portlet session will result in invalidating the underlying
HttpSession
exception:
java.lang.IllegalStateException - if this method is called on asession which has already been invalidated |
| isNew | | public boolean isNew()(Code) | | Returns true if the client does not yet know about the session or
if the client chooses not to join the session.
true if the server has created a session, but the client has not joined yet.
exception:
java.lang.IllegalStateException - if this method is called on asession which has already been invalidated |
| removeAttribute | | public void removeAttribute(String name)(Code) | | 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.
Parameters:
name - the name of the object to beremoved from this session in the PORTLET_SCOPE.
exception:
java.lang.IllegalStateException - if this method is called on asession which has been invalidated
exception:
java.lang.IllegalArgumentException - if name is null. |
| removeAttribute | | public void removeAttribute(String name, int scope)(Code) | | 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.
Parameters:
name - the name of the object to beremoved from this session
Parameters:
scope - session scope of this attribute
exception:
java.lang.IllegalStateException - if this method is called on asession which has been invalidated
exception:
java.lang.IllegalArgumentException - if name is null. |
| setAttribute | | public void setAttribute(java.lang.String name, java.lang.Object value)(Code) | | 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().
Parameters:
name - the name to which the object is bound underthe PORTLET_SCOPE;this cannot be null.
Parameters:
value - the object to be bound
exception:
java.lang.IllegalStateException - if this method is called on asession which has been invalidated
exception:
java.lang.IllegalArgumentException - if name is null. |
| setAttribute | | public void setAttribute(java.lang.String name, java.lang.Object value, int scope)(Code) | | 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().
Parameters:
name - the name to which the object is bound;this cannot be null.
Parameters:
value - the object to be bound
Parameters:
scope - session scope of this attribute
exception:
java.lang.IllegalStateException - if this method is called on asession which has been invalidated
exception:
java.lang.IllegalArgumentException - if name is null. |
| setMaxInactiveInterval | | public void setMaxInactiveInterval(int interval)(Code) | | Specifies the time, in seconds, between client requests, before the
portlet container invalidates this session. A negative time
indicates the session should never timeout.
Parameters:
interval - An integer specifying the numberof seconds |
|
|