|
Oracle Fusion Middleware extensions for Applications Core API Reference 11g Release 1 (11.1.1.5) E22562-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.apps.fnd.applcore.common.ApplSessionManagement
public class ApplSessionManagement
The ApplSessionManagement class implements the LwsSessionContext interface, and handles all aspects of LwsSession management, including creating, attaching to, validating, and destroying the session object. This class is not intended to be accessed directly by product teams, it is for applcore use only. The ApplSessionUtil package provides api's that product teams can call to access ApplSession's.
Constructor Summary | |
---|---|
ApplSessionManagement()
The ApplSessionManagement Constructor. |
|
ApplSessionManagement(java.lang.String sessionID)
The ApplSessionManagement Constructor that takes a session ID. |
Method Summary | |
---|---|
void |
attachSession(LwsSession session)
Used if we need to attach a dummy session to the context. |
void |
attachSession(LwsSession session,
java.sql.Connection conn)
Implementation of the LwsSessionContext interface. |
void |
attachSession(LwsSession session,
java.sql.Connection conn,
LwsUser lwsUser,
java.util.List<? extends LwsRole> roles)
Version of attachSession that defaults to not passing in a HashMap of attributes to set. |
void |
attachSession(LwsSession session,
java.sql.Connection conn,
LwsUser lwsUser,
java.util.List<? extends LwsRole> roles,
java.util.HashMap attrs)
Attaches the passed in session using the given connection, with the specified users and roles, and associates this session management object with that sssion. |
LwsSession |
createAttachedSession(java.sql.Connection conn)
Creates an attached session based on the current session ID. |
LwsSession |
createElevatedSession(LwsUser user,
LwsUser submittingUser,
java.util.List<java.lang.String> langAttrs,
java.sql.Connection conn)
Create an elevated session for the specified user. |
LwsSession |
createSession()
Deprecated. |
LwsSession |
createSession(java.sql.Connection conn)
Deprecated. |
LwsSession |
createSession(LwsUser user)
Deprecated. |
LwsSession |
createSession(LwsUser user,
java.sql.Connection conn)
Creates a session, without specifying any language attributes. |
LwsSession |
createSession(LwsUser user,
java.util.List<java.lang.String> langAttrs,
java.sql.Connection conn)
The primary API for creating a session - takes in the specified user, an optional list of language attributes, and a connection. |
void |
destroySession()
destroy the LWS session in the database. |
void |
destroySession(java.sql.Connection conn)
|
void |
destroySession(java.sql.Connection conn,
ApplSession session)
destroys the specified session using the passed in connection. |
void |
detachSession()
Implementation of the LwsSessionContext interface |
void |
detachSession(java.sql.Connection conn)
Counterpart to attachSession, call detachSession on the connection that was attached to when finished. |
LwsSession |
getAttachedSession()
returns the attached LWS session if the session is attached. |
java.lang.String |
getName()
Implementation of the Principal interface |
boolean |
isAttached()
checks if the LWS session of this context is in Attach state. |
void |
valueBound(javax.servlet.http.HttpSessionBindingEvent event)
Implementation of HttpSessionBindingListener. |
void |
valueUnbound(javax.servlet.http.HttpSessionBindingEvent event)
Implementation of HttpSessionBindingListener. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface java.security.Principal |
---|
equals, hashCode, toString |
Constructor Detail |
---|
public ApplSessionManagement()
public ApplSessionManagement(java.lang.String sessionID)
Method Detail |
---|
public LwsSession createSession(LwsUser user, java.util.List<java.lang.String> langAttrs, java.sql.Connection conn)
user
- the user to attach aslangAttrs
- the language attributes to set for the user.conn
- a database connection to use for the create
public LwsSession createElevatedSession(LwsUser user, LwsUser submittingUser, java.util.List<java.lang.String> langAttrs, java.sql.Connection conn)
user
- the user to attach assubmittingUser
- the user this session is being used forconn
- a database connection to use for the create
public LwsSession createSession(LwsUser user, java.sql.Connection conn)
user
- the user to attach asconn
- a database connection to use for the create
createSession(oracle.apps.fnd.applcore.common.security.LwsUser, java.util.List, java.sql.Connection);
public LwsSession createSession(LwsUser user)
createSession
in interface LwsSessionContext
public LwsSession createSession()
createSession
in interface LwsSessionContext
public LwsSession createSession(java.sql.Connection conn)
public LwsSession createAttachedSession(java.sql.Connection conn)
createAttachedSession
in interface LwsSessionContext
conn
- the connection to attach to
public void attachSession(LwsSession session, java.sql.Connection conn, LwsUser lwsUser, java.util.List<? extends LwsRole> roles, java.util.HashMap attrs) throws java.lang.Exception
session
- the session to attach the connection toconn
- a database connection to attach touser
- the user to attach asroles
- the roles to attach toattrs
- session attributes to set when the session is attached
java.lang.Exception
public void attachSession(LwsSession session, java.sql.Connection conn, LwsUser lwsUser, java.util.List<? extends LwsRole> roles) throws java.lang.Exception
session
- the session to attach the connection toconn
- a database connection to attach touser
- the user to attach asroles
- the roles to attach to
java.lang.Exception
oracle.apps.fnd.applcore.common.ApplSessionManagement#attachSession(oracle.apps.fnd.applcore.common.ApplSession, java.sql.Connection, oracle.apps.fnd.applcore.common.security.LwsUser, java.util.List, java.util.HashMap);
public void attachSession(LwsSession session, java.sql.Connection conn) throws java.lang.Exception
attachSession
in interface LwsSessionContext
java.lang.Exception
- if it fails to perform session Attach.public void attachSession(LwsSession session) throws java.lang.Exception
java.lang.Exception
public LwsSession getAttachedSession()
LwsSessionContext
getAttachedSession
in interface LwsSessionContext
public boolean isAttached()
LwsSessionContext
isAttached
in interface LwsSessionContext
public void detachSession()
detachSession
in interface LwsSessionContext
public void detachSession(java.sql.Connection conn)
public void destroySession()
LwsSessionContext
destroySession
in interface LwsSessionContext
destroySession(java.sql.Connection, oracle.apps.fnd.applcore.common.ApplSession);
public void destroySession(java.sql.Connection conn)
destroySession(java.sql.Connection, oracle.apps.fnd.applcore.common.ApplSession);
public void destroySession(java.sql.Connection conn, ApplSession session)
conn
- the connection to use to destroy the session.session
- the session to destroypublic 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 java.lang.String getName()
getName
in interface java.security.Principal
|
Oracle Fusion Middleware extensions for Applications Core API Reference 11g Release 1 (11.1.1.5) E22562-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |