Life Cycle Listener"

From Documentation
m
Line 9: Line 9:
 
#Register it in <tt>WEB-INF/zk.xml</tt>, or in Java.
 
#Register it in <tt>WEB-INF/zk.xml</tt>, or in Java.
  
{| border='1px' | width="100%"
+
=Interfaces=
! Version !! Date !! Content
+
{| border='1px'
 +
! Task!! Interface
 
|-
 
|-
| Scope
+
| Application Init
| Interfaces
+
| <javadoc type="interface">org.zkoss.zk.ui.util.WebAppInit</javadoc>
| Description
 
 
|-
 
|-
| Application
+
| Application Cleanup
|
+
| Cleanup: <javadoc type="interface">org.zkoss.zk.ui.util.WebAppCleanup</javadoc>
* Init: <javadoc type="interface">org.zkoss.zk.ui.util.WebAppInit</javadoc>
+
|-
* Cleanup: <javadoc type="interface">org.zkoss.zk.ui.util.WebAppCleanup</javadoc>
+
| Session Init
|
+
| <javadoc type="interface">org.zkoss.zk.ui.util.SessionInit</javadoc>
 +
|-
 +
| Session Cleanup
 +
| Cleanup: <javadoc type="interface">org.zkoss.zk.ui.util.SessionCleanup</javadoc>
 +
|-
 +
| Desktop Init
 +
| <javadoc type="interface">org.zkoss.zk.ui.util.DesktopInit</javadoc>
 +
|-
 +
| Desktop Cleanup
 +
| Cleanup: <javadoc type="interface">org.zkoss.zk.ui.util.DesktopCleanup</javadoc>
 +
|-
 +
| Execution Init
 +
| <javadoc type="interface">org.zkoss.zk.ui.util.ExecutionInit</javadoc>
 +
|-
 +
| Execution Cleanup
 +
| Cleanup: <javadoc type="interface">org.zkoss.zk.ui.util.ExecutionCleanup</javadoc>
 
|}
 
|}
  
 +
=Registration=
 
The registration in <tt>WEB-INF/zk.xml</tt> is the same, no matter what interface you implement:
 
The registration in <tt>WEB-INF/zk.xml</tt> is the same, no matter what interface you implement:
  

Revision as of 06:36, 2 December 2010


Life Cycle Listener


You could have some custom initialization and cleanup when an application, a session, a desktop or an execution is instantiated or about to being destroyed.

There are two steps:

  1. Implements the corresponding interface. For example, WebAppInit for application's initialization
  2. Register it in WEB-INF/zk.xml, or in Java.

Interfaces

Task Interface
Application Init WebAppInit
Application Cleanup Cleanup: WebAppCleanup
Session Init SessionInit
Session Cleanup Cleanup: SessionCleanup
Desktop Init DesktopInit
Desktop Cleanup Cleanup: DesktopCleanup
Execution Init ExecutionInit
Execution Cleanup Cleanup: ExecutionCleanup

Registration

The registration in WEB-INF/zk.xml is the same, no matter what interface you implement:

<listener>
    <listener-class>my.MyImplementation</listener-class>
</listener>

The registration in Java is done by Configuration.addListener(Class).

webapp.getConfiguration().addListener(my.MyImplementation.class);

Version History

Last Update : 2010/12/02


Version Date Content
     



Last Update : 2010/12/02

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.