|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.zkoss.zk.ui.Sessions org.zkoss.zk.ui.sys.SessionsCtrl
public class SessionsCtrl
An additional utilities for implementation related to Session
.
Field Summary |
---|
Fields inherited from class org.zkoss.zk.ui.Sessions |
---|
_cnt, _sess |
Constructor Summary | |
---|---|
protected |
SessionsCtrl()
|
Method Summary | |
---|---|
static SessionCtrl |
getCurrentCtrl()
Returns the current SessionCtrl . |
static java.lang.Object |
getRawCurrent()
Returns the current session or the current session resolver. |
static Session |
getSession(WebApp wapp,
java.lang.Object navsess)
Returns the ZK session associated with the specified native session, or null if not found. |
static Session |
newSession(WebApp wapp,
java.lang.Object navsess,
java.lang.Object request)
Instantiates a ZK session that is assoicated witht the specified native session and request. |
static boolean |
requestEnter(Session sess)
Called when a servlet/portlet starts to serve a request. |
static void |
requestExit(Session sess)
Called when a servlet/portlet completes the service of a request. |
static void |
setCurrent(Session sess)
Sets the session for the current thread. |
static void |
setCurrent(SessionResolver sr)
Sets the session for the current thread. |
static void |
setRawCurrent(java.lang.Object rawsess)
Sets the current session or the current session resolver. |
static void |
updateCount(boolean inc)
Update the session count. |
Methods inherited from class org.zkoss.zk.ui.Sessions |
---|
getCount, getCurrent, getCurrent |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected SessionsCtrl()
Method Detail |
---|
public static final void setCurrent(Session sess)
public static final void setCurrent(SessionResolver sr)
setCurrent(Session)
, the session is resovled
later (when Sessions.getCurrent()
is called).
public static final SessionCtrl getCurrentCtrl()
SessionCtrl
.
public static final java.lang.Object getRawCurrent()
Session
or SessionResolver
.
setRawCurrent(java.lang.Object)
,
setCurrent(Session)
,
setCurrent(SessionResolver)
public static final void setRawCurrent(java.lang.Object rawsess)
rawsess
- the raw session. It can be null, an instance of
Session
and SessionResolver
.
Notice: it is usually the return value of getRawCurrent()
.getRawCurrent()
public static final void updateCount(boolean inc)
Called only internally.
public static boolean requestEnter(Session sess)
Configuration.getSessionMaxRequests()
.
If exceeded, false is returned, and the servlet/portlet shall stop
processing and return an error code back the client.
If not exceeded, true is returned, and the servlet/portlet
can continue the processing and it shall invoke requestExit(org.zkoss.zk.ui.Session)
in the finally clause.
public static void requestExit(Session sess)
requestEnter(org.zkoss.zk.ui.Session)
is called
and returns true. This method shall not be called, otherwise.
public static final Session getSession(WebApp wapp, java.lang.Object navsess)
navsess
- the native session (never null).
If HTTP, it is HttpSession. If portlet, it is PortletSession.public static final Session newSession(WebApp wapp, java.lang.Object navsess, java.lang.Object request)
navsess
- the native session (never null).
If HTTP, it is HttpSession. If portlet, it is PortletSession.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |