ZK Configuration Reference/zk.xml/The richlet-mapping Element

Once a richlet is declared, you could map it to any number of URL by use of richlet-mapping as depicted below.

<richlet-mapping>
	<richlet-name>Test</richlet-name>
	<url-pattern>/test</url-pattern>
</richlet-mapping>
<richlet-mapping>
	<richlet-name>Test</richlet-name>
	<url-pattern>/some/more/*</url-pattern>
</richlet-mapping>

The mapping should consider with the servlet-mapping of ZK Loader in web.xml, for example, if you want the Richlet work for /path/*, you may specify the servlet-mapping in web.xml as follows:

<servlet-mapping>
	<servlet-name>zkLoader</servlet-name>
	<url-pattern>/path/*</url-pattern>
</servlet-mapping>

and the richlet-mapping as follows:

<richlet-mapping>
	<richlet-name>Test</richlet-name>
	<url-pattern>/*</url-pattern>
</richlet-mapping>

In this case, both Richlet and ZUL will work great. If swap the servlet-mapping and richlet-mapping, only the richlet will work well but will not able to access any ZUL file.

The URL specified in the url-pattern element must start with /. If the URI ends with /*, then it is matched to all request with the same prefix. To retrieve the real request, you can check the value returned by Page.getRequestPath() of the current page.

 public void service(Page page) {
     if ("/some/more/hi".equals(page.getRequestPath()) {
         ...
     }
 }

Version History

Version	Date	Content