ZK Configuration"
Robertwenzel (talk | contribs) |
|||
| Line 3: | Line 3: | ||
=Turn on Serializable UI Factory= | =Turn on Serializable UI Factory= | ||
| − | + | {{Notice| text=Required}} | |
To use ZK in a clustering environment, you have to use the serializable UI factory. It could be done by specifying the following statement in <tt>WEB-INF/zk.xml</tt>: | To use ZK in a clustering environment, you have to use the serializable UI factory. It could be done by specifying the following statement in <tt>WEB-INF/zk.xml</tt>: | ||
| Line 15: | Line 15: | ||
</source> | </source> | ||
| − | <javadoc>org.zkoss.zk.ui.http.SerializableUiFactory</javadoc> is the UI factory that will instantiate serializable sessions such that the sessions, components, pages and desktops will be serialized when a session is about to deactivate. | + | <javadoc>org.zkoss.zk.ui.http.SerializableUiFactory</javadoc> is the UI factory that will instantiate serializable sessions such that the sessions, components, pages, and desktops will be serialized when a session is about to deactivate. |
=Additional settings for various servers= | =Additional settings for various servers= | ||
Revision as of 06:09, 5 November 2020
Turn on Serializable UI Factory
Notice: Required
To use ZK in a clustering environment, you have to use the serializable UI factory. It could be done by specifying the following statement in WEB-INF/zk.xml:
<zk>
<system-config>
<ui-factory-class>org.zkoss.zk.ui.http.SerializableUiFactory</ui-factory-class>
</system-config>
</zk>
SerializableUiFactory is the UI factory that will instantiate serializable sessions such that the sessions, components, pages, and desktops will be serialized when a session is about to deactivate.
Additional settings for various servers
Please refer to the following links for detailed settings.
Turn on Log
[Optional]
If an attribute or a listener is not serializable, ZK will skip it, i.e., not to serialize it (similar to how a Servlet container serializes the attributes of sessions). It is sometimes hard to know what are ignored, since it is common for a developer to forget to declare a value or a listener as serializable.
To detect this problem, you could turn on the logger for org.zkoss.io.serializable to the DEBUG level[1]. The logger is the standard logger. You could consult the configuration of the Web server you use. Or, you could run the following statement when your application starts[2].
org.zkoss.util.logging.Log.lookup("org.zkoss.io.serializable").setLevel("DEBUG");
- ↑ Available in 5.0.7
- ↑ It can be done by use of theWebAppInit listener. For more information, please refer to the Customization section.
Disable the Use of zscript
[Optional] [since 5.0.8]
The interpreter (BeanShell) does not work well under the clustering environment. Since the serialization is not stable, zscript cannot be used in a clustering environment. To avoid accidental or unintended use it is recommended to disable zscript in your ZK application with the following configuration (in zk.xml):
<system-config>
<disable-zscript>true</disable-zscript>
</system-config>
Configuration Not Allowed
Here are a list of configuration that can not be used in the clustering environment. They are disabled by default. However, it is worth to double check if any of your members enables it accidentally.
Event Processing Thread
Do not enable the event processing thread. The event processing thread might be suspended, while the (suspended) thread cannot be migrated from one machine to another.
It is disabled by default. For more information, please refer to the Event Threads section.
Global Desktop Cache
Do not use GlobalDesktopCacheProvider (global desktop cache). The global desktop cache is stored in the servlet context, while only the data stored in sessions are migrated when failover takes place.
The desktop desktop cache is not used by default[1]. Just make sure you don't configure it wrong.
- ↑ Rather, the default is SessionDesktopCacheProvider.
Version History
| Version | Date | Content |
|---|---|---|
| 5.0.7 | April 2011 | The log called org.zkoss.io.serializable was introduced. |
| 5.0.8 | June 2011 | The listener called org.zkoss.zkplus.cluster.ClusterSessionPatch was introduced. |