|
Oracle Fusion Middleware Java API Reference for Oracle PDK Java 11g Release 1 (11.1.1) E10691-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ProviderSession
The Provider interfaces are specified without dependencies on the Servlet interfaces. ProviderSession provides the equivalent abstraction as a servlet's HttpSession. When running in the servlet container, the session state is maintained in the HttpSession object while the ProviderSession becomes a simple wrapper that isolates the abstraction from that particular interface.
Sessions, if used, must be established in Provider.initSession(). Sessions are maintained on a ProviderUser basis. The ProviderUser interface is used to create and reacquire the session. A convenience method for reacquiring the session is available to renderers in the PortletRenderRequest object.
Method Summary | |
---|---|
java.lang.Object |
getAttribute(java.lang.String name)
Returns the object bound with the specified name in this session, or null if no object is bound under the name. |
java.util.Enumeration |
getAttributeNames()
Returns an Enumeration of String objects
containing the names of all the objects bound to this session. |
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. |
int |
getMaxInactiveInterval()
Returns the maximum time interval, in seconds, that the servlet engine will keep this session open between client requests. |
void |
invalidate()
Invalidates this session 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 |
removeAttribute(java.lang.String name)
Removes the object bound with the specified name from this session. |
void |
setAttribute(java.lang.String name,
java.lang.Object value)
Binds an object to this session, using the name specified. |
Method Detail |
---|
long getCreationTime()
long
specifying
when this session was created,
expressed in
milliseconds since 1/1/1970 GMT
java.lang.IllegalStateException
- if this method is called on an
invalidated sessionjava.lang.String getId()
java.lang.IllegalStateException
- if this method is called on an
invalidated sessionlong getLastAccessedTime()
Actions that your application takes, such as getting or setting a value associated with the session, do not affect the access time.
long
representing the last time
the client sent a request associated
with this session, expressed in
milliseconds since 1/1/1970 GMT
java.lang.IllegalStateException
- if this method is called on an
invalidated sessionint getMaxInactiveInterval()
setMaxInactiveInterval
method.
java.lang.Object getAttribute(java.lang.String name)
null
if no object is bound under the name.
name
- a string specifying the name of the object
java.lang.IllegalStateException
- if this method is called on an
invalidated sessionjava.util.Enumeration getAttributeNames()
Enumeration
of String
objects
containing the names of all the objects bound to this session.
Enumeration
of
String
objects specifying the
names of all the objects bound to
this session
java.lang.IllegalStateException
- if this method is called on an
invalidated sessionvoid setAttribute(java.lang.String name, java.lang.Object value)
After this method executes, and if the object
implements HttpSessionBindingListener
,
the container calls
HttpSessionBindingListener.valueBound
.
name
- the name to which the object is bound;
cannot be nullvalue
- the object to be bound; cannot be null
java.lang.IllegalStateException
- if this method is called on an
invalidated sessionvoid removeAttribute(java.lang.String name)
After this method executes, and if the object
implements HttpSessionBindingListener
,
the container calls
HttpSessionBindingListener.valueUnbound
.
name
- the name of the object to
remove from this session
java.lang.IllegalStateException
- if this method is called on an
invalidated sessionvoid invalidate()
java.lang.IllegalStateException
- if this method is called on an
already invalidated sessionboolean isNew()
true
if the client does not yet know about the
session or if the client chooses not to join the session. For
example, if the server used only cookie-based sessions, and
the client had disabled the use of cookies, then a session would
be new on each request.
true
if the
server has created a session,
but the client has not yet joined
java.lang.IllegalStateException
- if this method is called on an
already invalidated session
|
Oracle Fusion Middleware Java API Reference for Oracle PDK Java 11g Release 1 (11.1.1) E10691-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |