ZK Configuration"
m |
|||
| Line 16: | Line 16: | ||
<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. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=Turn on Log= | =Turn on Log= | ||
| Line 35: | Line 28: | ||
org.zkoss.util.logging.Log.lookup("org.zkoss.io.serializable").setLevel("DEBUG"); | org.zkoss.util.logging.Log.lookup("org.zkoss.io.serializable").setLevel("DEBUG"); | ||
</source> | </source> | ||
| + | |||
| + | <blockquote> | ||
| + | ---- | ||
| + | <references/> | ||
| + | </blockquote> | ||
| + | |||
| + | =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 [[ZK Developer's Reference/UI Patterns/Event Threads|Event Threads]] section. | ||
| + | |||
| + | ==Global Desktop Cache== | ||
| + | Do not use <javadoc>org.zkoss.zk.ui.impl.GlobalDesktopCacheProvider</javadoc> (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<ref>Rather, the default is <javadoc>org.zkoss.zk.ui.impl.SessionDesktopCacheProvider</javadoc>.</ref>. Just make sure you don't configure it wrong. | ||
<blockquote> | <blockquote> | ||
Revision as of 07:38, 13 June 2011
Turn on Serializable UI Factory
[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.
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.
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. |