|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.pluto.internal.impl.PortletSessionImpl
public class PortletSessionImpl
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 | |
---|---|
Object |
getAttribute(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. |
Object |
getAttribute(String name,
int scope)
Returns the attribute of the specified name under the given scope. |
Map<String,Object> |
getAttributeMap()
Returns a Map of the session attributes in
the portlet session scope. |
Map<String,Object> |
getAttributeMap(int scope)
Returns a Map of the session attributes in
the portlet session scope. |
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. |
Enumeration<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. |
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. |
Map<String,Object> |
getMap()
|
Map<String,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. |
Object |
getValue(String name)
|
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(String name,
Object value)
|
void |
removeAttribute(String name)
Removes the object bound with the specified name under the PORTLET_SCOPE from
this session. |
void |
removeAttribute(String name,
int scope)
Removes the object bound with the specified name and the given scope from this session. |
void |
removeValue(String name)
|
void |
setAttribute(String name,
Object value)
Binds an object to this session under the PORTLET_SCOPE , using the name specified. |
void |
setAttribute(String name,
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 |
---|
public PortletSessionImpl(PortletContext portletContext, InternalPortletWindow internalPortletWindow, javax.servlet.http.HttpSession httpSession)
Method Detail |
---|
public Object getAttribute(String name)
PortletSession
PORTLET_SCOPE
, or null
if no
object is bound under the name in that scope.
getAttribute
in interface PortletSession
getAttribute
in interface javax.servlet.http.HttpSession
name
- a string specifying the name of the object
PORTLET_SCOPE
.public Object getAttribute(String name, int scope)
getAttribute
in interface PortletSession
name
- the attribute name.scope
- the scope under which the attribute object is stored.
public Enumeration getAttributeNames()
PortletSession
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.
getAttributeNames
in interface PortletSession
getAttributeNames
in interface javax.servlet.http.HttpSession
Enumeration
of
String
objects specifying the
names of all the objects bound to
this session, or an empty Enumeration
if no attributes are available.public Enumeration<String> getAttributeNames(int scope)
PortletSession
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.
getAttributeNames
in interface PortletSession
scope
- session scope of the attribute names
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.public void removeAttribute(String name)
PortletSession
PORTLET_SCOPE
from
this session. If the session does not have an object
bound with the specified name, this method does nothing.
removeAttribute
in interface PortletSession
removeAttribute
in interface javax.servlet.http.HttpSession
name
- the name of the object to be
removed from this session in the
PORTLET_SCOPE
.public void removeAttribute(String name, int scope)
PortletSession
removeAttribute
in interface PortletSession
name
- the name of the object to be
removed from this sessionscope
- session scope of this attributepublic void setAttribute(String name, Object value)
PortletSession
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()
.
setAttribute
in interface PortletSession
setAttribute
in interface javax.servlet.http.HttpSession
name
- the name to which the object is bound under
the PORTLET_SCOPE
;
this cannot be null
.value
- the object to be boundpublic void setAttribute(String name, Object value, int scope)
PortletSession
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()
.
setAttribute
in interface PortletSession
name
- the name to which the object is bound;
this cannot be null
.value
- the object to be boundscope
- session scope of this attributepublic PortletContext getPortletContext()
PortletSession
getPortletContext
in interface PortletSession
public long getCreationTime()
PortletSession
getCreationTime
in interface PortletSession
getCreationTime
in interface javax.servlet.http.HttpSession
long
specifying
when this session was created,
expressed in
milliseconds since 1/1/1970 GMTpublic String getId()
PortletSession
getId
in interface PortletSession
getId
in interface javax.servlet.http.HttpSession
public long getLastAccessedTime()
PortletSession
Actions that your portlet takes, such as getting or setting a value associated with the session, do not affect the access time.
getLastAccessedTime
in interface PortletSession
getLastAccessedTime
in interface javax.servlet.http.HttpSession
long
representing the last time
the client sent a request associated
with this session, expressed in
milliseconds since 1/1/1970 GMTpublic int getMaxInactiveInterval()
PortletSession
setMaxInactiveInterval
method.
A negative time indicates the session should never timeout.
getMaxInactiveInterval
in interface PortletSession
getMaxInactiveInterval
in interface javax.servlet.http.HttpSession
PortletSession.setMaxInactiveInterval(int)
public void invalidate() throws IllegalStateException
PortletSession
Invalidating the portlet session will result in invalidating the underlying
HttpSession
invalidate
in interface PortletSession
invalidate
in interface javax.servlet.http.HttpSession
IllegalStateException
- if this method is called on a
session which has already been invalidatedpublic boolean isNew() throws IllegalStateException
PortletSession
isNew
in interface PortletSession
isNew
in interface javax.servlet.http.HttpSession
true
if the
server has created a session,
but the client has not joined yet.
IllegalStateException
- if this method is called on a
session which has already been invalidatedpublic void setMaxInactiveInterval(int interval)
[Portlet Spec. PLT. 15.4.] If the PortletSession object is invalidated by a portlet, the portlet container must invalidate the associated HttpSession object.
setMaxInactiveInterval
in interface PortletSession
setMaxInactiveInterval
in interface javax.servlet.http.HttpSession
interval
- an integer specifying the number of seconds.public javax.servlet.ServletContext getServletContext()
getServletContext
in interface javax.servlet.http.HttpSession
public javax.servlet.http.HttpSessionContext getSessionContext()
getSessionContext
in interface javax.servlet.http.HttpSession
public Object getValue(String name)
getValue
in interface javax.servlet.http.HttpSession
public String[] getValueNames()
getValueNames
in interface javax.servlet.http.HttpSession
public void putValue(String name, Object value)
putValue
in interface javax.servlet.http.HttpSession
public void removeValue(String name)
removeValue
in interface javax.servlet.http.HttpSession
public Map<String,Object> getMap()
public Map<String,Object> getMap(int scope)
public void setIncludeOrForward(boolean isIncludeOrForward)
public Map<String,Object> getAttributeMap(int scope)
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
.
getAttributeMap
in interface PortletSession
scope
- session scope of this attribute
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.public Map<String,Object> getAttributeMap()
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
.
getAttributeMap
in interface PortletSession
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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |