org.zkoss.zk.config.path"
Robertwenzel (talk | contribs) m |
|||
| Line 13: | Line 13: | ||
The value could be one of the following: | The value could be one of the following: | ||
| − | * A servlet path, such as <code>/WEB-INF/config/zk-extra.xml</code> | + | * '''A servlet path''', such as <code>/WEB-INF/config/zk-extra.xml</code> |
| − | * A file path, such as <code>file:///home/http/zk.xml</code> and <code>file:///C:/test/zk.xml</code>, if you use Windows. Notice it must start with <code>file://</code><ref>For more information about the URI of a file, please refer to [http://en.wikipedia.org/wiki/File_URI_scheme File URI scheme].</ref>. | + | * '''A file path''', such as <code>file:///home/http/zk.xml</code> and <code>file:///C:/test/zk.xml</code>, if you use Windows. Notice it must start with <code>file://</code><ref>For more information about the URI of a file, please refer to [http://en.wikipedia.org/wiki/File_URI_scheme File URI scheme].</ref>. |
| − | * A URL, such as <code><nowiki>http://foo.com/config/zk.xml</nowiki></code>. Notice it must starts with <code>http://</code>, <code>https://</code>, and <code>ftp://</code>. | + | * '''A URL''', such as <code><nowiki>http://foo.com/config/zk.xml</nowiki></code>. Notice it must starts with <code>http://</code>, <code>https://</code>, and <code>ftp://</code>. |
Notice that <tt>WEB-INF/zk.xml</tt> is always loaded, and it is loaded before the configuration file specified in this system property. Thus, you could put the configurations common to each environment in <tt>WEB-INF/zk.xml</tt>, and put the difference to the extra configuration file. | Notice that <tt>WEB-INF/zk.xml</tt> is always loaded, and it is loaded before the configuration file specified in this system property. Thus, you could put the configurations common to each environment in <tt>WEB-INF/zk.xml</tt>, and put the difference to the extra configuration file. | ||
Revision as of 01:33, 12 May 2017
Property:
org.zkoss.zk.config.path
Applicable:globally in zk.xml via <library-property>
not as <custom-attribute>
Default: none [since 5.0.7]
It specifies the second configuration file in addition to WEB-INF/zk.xml. This is useful if you have two or more environments, such as testing and production. Then, you could put the different configuration into separated files and load the required files based on the requirement.
The value could be one of the following:
- A servlet path, such as
/WEB-INF/config/zk-extra.xml - A file path, such as
file:///home/http/zk.xmlandfile:///C:/test/zk.xml, if you use Windows. Notice it must start withfile://[1]. - A URL, such as
http://foo.com/config/zk.xml. Notice it must starts withhttp://,https://, andftp://.
Notice that WEB-INF/zk.xml is always loaded, and it is loaded before the configuration file specified in this system property. Thus, you could put the configurations common to each environment in WEB-INF/zk.xml, and put the difference to the extra configuration file.
For example, assume you put the configuration in a file called /configs/zk-production.xml, then you could specify -Dorg.zkoss.zk.config.path=file:/configs/zk-production.xml as one of the arguments when starting the Web server.
Another example is to provide an ID generator for the testing purpose. For more information, please refer to ZK Developer's Reference: Testing Tips.
- ↑ For more information about the URI of a file, please refer to File URI scheme.
Version History
| Version | Date | Content |
|---|---|---|
| 5.0.7 | April, 2011 | Introduced |