|
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 |
java.lang.Object oracle.portal.provider.v2.http.ServletProviderSession
public class ServletProviderSession
Servlet specific implementation of the ProviderSession
interface.
Field Summary | |
---|---|
static java.lang.String |
SESSION_ID
|
Method Summary | |
---|---|
static ServletProviderSession |
getAttachedSession(javax.servlet.http.HttpServletRequest request)
|
static ServletProviderSession |
getAttachedSession(javax.servlet.http.HttpServletRequest request,
boolean create)
|
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 |
sessionDidActivate(javax.servlet.http.HttpSessionEvent se)
Notification that the session has just been activated. |
void |
sessionWillPassivate(javax.servlet.http.HttpSessionEvent se)
Notification that the session is about to be passivated. |
void |
setAttribute(java.lang.String name,
java.lang.Object value)
Binds an object to this session, using the name specified. |
void |
valueBound(javax.servlet.http.HttpSessionBindingEvent event)
|
void |
valueUnbound(javax.servlet.http.HttpSessionBindingEvent event)
In case the User is attached to a session we want to be able to remove its session reference so the http session can ultimately be garbage collected. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String SESSION_ID
Method Detail |
---|
public static ServletProviderSession getAttachedSession(javax.servlet.http.HttpServletRequest request)
public static ServletProviderSession getAttachedSession(javax.servlet.http.HttpServletRequest request, boolean create)
public long getCreationTime() throws java.lang.IllegalStateException
getCreationTime
in interface ProviderSession
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 sessionpublic java.lang.String getId() throws java.lang.IllegalStateException
getId
in interface ProviderSession
java.lang.IllegalStateException
- if this method is called on an
invalidated sessionpublic long getLastAccessedTime() throws java.lang.IllegalStateException
Actions that your application takes, such as getting or setting a value associated with the session, do not affect the access time.
getLastAccessedTime
in interface ProviderSession
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 sessionpublic int getMaxInactiveInterval()
setMaxInactiveInterval
method.
getMaxInactiveInterval
in interface ProviderSession
public java.lang.Object getAttribute(java.lang.String name) throws java.lang.IllegalStateException
null
if no object is bound under the name.
getAttribute
in interface ProviderSession
name
- a string specifying the name of the object
java.lang.IllegalStateException
- if this method is called on an
invalidated sessionpublic java.util.Enumeration getAttributeNames() throws java.lang.IllegalStateException
Enumeration
of String
objects
containing the names of all the objects bound to this session.
getAttributeNames
in interface ProviderSession
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 sessionpublic void setAttribute(java.lang.String name, java.lang.Object value) throws java.lang.IllegalStateException
After this method executes, and if the object implements
HttpSessionBindingListener
, the container calls
HttpSessionBindingListener.valueBound
.
setAttribute
in interface ProviderSession
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 sessionpublic void removeAttribute(java.lang.String name) throws java.lang.IllegalStateException
After this method executes, and if the object implements
HttpSessionBindingListener
, the container calls
HttpSessionBindingListener.valueUnbound
.
removeAttribute
in interface ProviderSession
name
- the name of the object to remove from this session.
java.lang.IllegalStateException
- if this method is called on an
invalidated sessionpublic void invalidate() throws java.lang.IllegalStateException
invalidate
in interface ProviderSession
java.lang.IllegalStateException
- if this method is called on an
already invalidated sessionpublic boolean isNew() throws java.lang.IllegalStateException
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.
isNew
in interface ProviderSession
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 sessionpublic void valueBound(javax.servlet.http.HttpSessionBindingEvent event)
valueBound
in interface javax.servlet.http.HttpSessionBindingListener
public void valueUnbound(javax.servlet.http.HttpSessionBindingEvent event)
valueUnbound
in interface javax.servlet.http.HttpSessionBindingListener
public void sessionWillPassivate(javax.servlet.http.HttpSessionEvent se)
sessionWillPassivate
in interface javax.servlet.http.HttpSessionActivationListener
public void sessionDidActivate(javax.servlet.http.HttpSessionEvent se)
sessionDidActivate
in interface javax.servlet.http.HttpSessionActivationListener
|
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 |