ZK AU Engine"

From Documentation
Line 54: Line 54:
 
The class must implement the <javadoc type="interface">org.zkoss.zk.au.http.AuExtension</javadoc> interface.
 
The class must implement the <javadoc type="interface">org.zkoss.zk.au.http.AuExtension</javadoc> interface.
 
|}
 
|}
 +
 +
=Map URL to ZK AU Engine=
 +
 +
<source lang="xml">
 +
<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>
 +
</source>
 +
 +
For more information, please refer to [[ZK_Configuration_Reference/web.xml/Sample_of_web.xml|a complete sample]].
  
 
=Version History=
 
=Version History=

Revision as of 07:39, 2 November 2010


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 the ZK Loader.

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.

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

	<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>

For more information, please refer to a complete sample.

Version History

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



Last Update : 2010/11/02

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