The zscript-config Element

From Documentation
Revision as of 10:34, 19 January 2022 by Hawk (talk | contribs) (correct highlight (via JWB))
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)


The zscript-config Element


Syntax:

<zscript-config>
    <language-name>a_programming_language</language-name>
    <interpreter-class>a_class_name</interpreter-class>
</zscript-config>
[Optional]

Specifies an interpreter to interpret the zscript code. The allowed child element is language-name and interpreter-class. You might have multiple zscript-config elements in one zk.xml.

 <zscript-config>
     <language-name>Java</language-name><!-- case insensitive -->
     <interpreter-class>my.MySuperJavaInterpreter</interpreter-class>
 </zscript-config>

Note: Unlike most other configurations defined in WEB-INF/zk.xml, the definitions defined in zscript-config are applied to all Web applications sharing the same zk.jar.

In other words, the scripting language defined here are visible to all Web applications sharing the same zk.jar. Furthermore, it may cause errors in another Web application, if the classes or resources are available only in the Web application defining this.

Thus, if it is an issue, just put zk.jar and relevant ZK libraries under the WEB-INF/lib directory.

The language-name Element

[Required]

It specifies the language name. It is case insensitive. The previous implementation with the same language name will be replaced if any.

The interpreter-class Element

[Required]

It specifies the implementation class. It must implement the Interpreter interface. Instead of implementing it from scratch, you can derive from the GenericInterpreter class. If you want to support the hierarchical scopes (i.e., one interpreter scope per namespace), it can also implement the HierachicalAware interface.

Version History

Version Date Content
     



Last Update : 2022/01/19

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