ZK AU Engine

From Documentation


DHtmlUpdateServlet

[Required] Class: DHtmlUpdateServlet


ZK AU Engine, aka., ZK Update Engine, is a servlet that handles AJAX requests asynchronously and automatically.

Notice that the URL pattern mapped to this engine must be consistent with the update-uri parameter of ZK Loader.

Here is a complete sample.

The Initial Parameters

init-param
Descriptions
compress [Optional][Default:true][since 3.6.3]


It specifies whether to compress the output of this Servlet, if the browser supports the compression (Accept-Encoding). Notice that it affects no only the AU response, but also JavaScript and CSS files loaded from this Servlet.

<init-param>
	<param-name>compress</param-name>
	<param-value>false</param-value>
</init-param>
extension0

extension1

extension2

...

[Optional] [since 5.0]

It specifies an AU extension The first processor must be specified with the name called extension0, second extension1 and so on.

The syntax of the value is

/prefix=class

For example,

<init-param>
	<param-name>extension0</param-name>
	<param-value>/upload=com.super.MyUploader</param-value>
</init-param>
<init-param>
	<param-name>extension1</param-name>
	<param-value>/extra=com.super.MyExtra</param-value>
</init-param>


The class must implement the AuExtension interface.

Map URL to ZK AU Engine

Mapping URL to ZK AU Engine is straightforward:

	<servlet>
		<servlet-name>auEngine</servlet-name>
		<servlet-class>org.zkoss.zk.au.http.DHtmlUpdateServlet</servlet-class>
	</servlet>
	<servlet-mapping>
		<servlet-name>auEngine</servlet-name>
		<url-pattern>/zkau/*</url-pattern>
	</servlet-mapping>

Notice that the URL pattern mapped to this engine must be consistent with the update-uri parameter of ZK Loader.

Here is a complete sample.

Version History

Version Date Content
5.0.0 07/14/10 processor0, processor1, processor2 parameters have been depreciated.



Last Update : 2012/03/14

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