|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.zkoss.zk.ui.http.WebManager
public class WebManager
A bridge between Web server and ZK.
Each Web application that uses ZK will have an independent instance
of WebManager
.
Constructor Summary | |
---|---|
WebManager(javax.servlet.ServletContext ctx,
java.lang.String updateURI)
Creates the Web manager. |
Method Summary | |
---|---|
static void |
addActivationListener(javax.servlet.ServletContext ctx,
WebManagerActivationListener listener)
Register a listener to the specified context such that it will be invoked if the corresponding WebManager is created. |
void |
destroy()
|
ClassWebResource |
getClassWebResource()
Returns the handler to retrieve resource from class path, under /web. |
Desktop |
getDesktop(Session sess,
javax.servlet.ServletRequest request,
javax.servlet.ServletResponse response,
java.lang.String path,
boolean autocreate)
Returns the desktop of the specified request, or null if not found and autocreate is false, or it has been redirect or forward to other page. |
static Session |
getSession(javax.servlet.ServletContext ctx,
javax.servlet.http.HttpServletRequest request)
Returns the session associated with the specified request request. |
static Session |
getSession(javax.servlet.ServletContext ctx,
javax.servlet.http.HttpServletRequest request,
boolean create)
Returns the current HttpSession associated with this request or, if there is no current session and create is true, returns a new session. |
java.lang.String |
getUpdateURI()
Returns the URI for asynchronous update. |
WebApp |
getWebApp()
Returns the Web application. |
static WebApp |
getWebApp(javax.servlet.ServletContext ctx)
Returns the Web application of the specified context. |
static WebApp |
getWebAppIfAny(javax.servlet.ServletContext ctx)
Returns the Web application of the specified context, or null if not available. |
static WebManager |
getWebManager(javax.servlet.ServletContext ctx)
Returns the Web manager of the specified context. |
static WebManager |
getWebManager(WebApp wapp)
Returns the Web manager of the specified WebApp . |
static WebManager |
getWebManagerIfAny(javax.servlet.ServletContext ctx)
Returns the Web manager of the give context, or null if not found. |
static WebManager |
getWebManagerIfAny(WebApp wapp)
Returns the Web manager of the specified WebApp ,
or null if not found. |
static Page |
newPage(UiFactory uf,
RequestInfo ri,
PageDefinition pagedef,
javax.servlet.ServletResponse response,
java.lang.String path)
Creates a page. |
static Page |
newPage(UiFactory uf,
RequestInfo ri,
Richlet richlet,
javax.servlet.ServletResponse response,
java.lang.String path)
Creates a page. |
static void |
setDesktop(javax.servlet.http.HttpServletRequest request,
Desktop desktop)
Sets the desktop to the specified request. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public WebManager(javax.servlet.ServletContext ctx, java.lang.String updateURI)
DHtmlLayoutServlet
,
so you rarely need to create it manually.
Method Detail |
---|
public void destroy()
public final ClassWebResource getClassWebResource()
public java.lang.String getUpdateURI()
Notice that the returned URI is not encoded, i.e., it doesn't proceed with the servlet context prefix.
Desktop.getUpdateURI(java.lang.String)
,
WebApp.getUpdateURI()
public final WebApp getWebApp()
public static final void addActivationListener(javax.servlet.ServletContext ctx, WebManagerActivationListener listener)
WebManager
is created.
Note: if the Web manager is created already, WebManagerActivationListener.didActivate(org.zkoss.zk.ui.http.WebManager)
will be invoked immediately before this method returns.
public static final WebManager getWebManager(javax.servlet.ServletContext ctx)
UiException
- if not found (i.e., not initialized
properly)public static final WebManager getWebManager(WebApp wapp)
WebApp
.
public static final WebManager getWebManagerIfAny(javax.servlet.ServletContext ctx)
public static final WebManager getWebManagerIfAny(WebApp wapp)
WebApp
,
or null if not found.
public static final WebApp getWebApp(javax.servlet.ServletContext ctx)
UiException
- if not found (i.e., not initialized
properly)public static final WebApp getWebAppIfAny(javax.servlet.ServletContext ctx)
public static final Session getSession(javax.servlet.ServletContext ctx, javax.servlet.http.HttpServletRequest request)
public static final Session getSession(javax.servlet.ServletContext ctx, javax.servlet.http.HttpServletRequest request, boolean create)
create
- true to create a new session for this request if necessary;
false to return null if there's no current sessionpublic Desktop getDesktop(Session sess, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, java.lang.String path, boolean autocreate)
path
- the path of the ZUML page.autocreate
- whether to create one if not foundpublic static void setDesktop(javax.servlet.http.HttpServletRequest request, Desktop desktop)
public static Page newPage(UiFactory uf, RequestInfo ri, PageDefinition pagedef, javax.servlet.ServletResponse response, java.lang.String path)
UiFactory.newPage(org.zkoss.zk.ui.sys.RequestInfo, org.zkoss.zk.ui.metainfo.PageDefinition, java.lang.String)
. However, it prepares
Executions.getCurrent()
for IdGenerator.nextPageUuid(org.zkoss.zk.ui.Page)
Note: Use this method to create a page, rather than invoking
UiFactory.newPage(org.zkoss.zk.ui.sys.RequestInfo, org.zkoss.zk.ui.metainfo.PageDefinition, java.lang.String)
directly.
public static Page newPage(UiFactory uf, RequestInfo ri, Richlet richlet, javax.servlet.ServletResponse response, java.lang.String path)
UiFactory.newPage(org.zkoss.zk.ui.sys.RequestInfo, org.zkoss.zk.ui.metainfo.PageDefinition, java.lang.String)
. However, it prepares
Executions.getCurrent()
for IdGenerator.nextPageUuid(org.zkoss.zk.ui.Page)
Note: Use this method to create a page, rather than invoking
UiFactory.newPage(org.zkoss.zk.ui.sys.RequestInfo, org.zkoss.zk.ui.metainfo.PageDefinition, java.lang.String)
directly.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |