Various custom configuration elements support a common content model used to supply JSR-223 scripts inside other object configurations. Where applicable, the specific configuration elements that share this content model will link to this page. These include the following documentation pages:
This feature is new in V3.4 and is a supplement to the older supported approach of defining scripted beans in native Spring files and referring to the beans by reference.
Namespace and Schema
Configuration elements that contain scripts are of type ScriptType, which is a type used across a number of namespaces. The specific namespace will depend on where the element shows up in your configuration.
The following sections describe the attributes and child elements of an element of type ScriptType.
Attributes
An element of type ScriptType has the following XML attributes:
Name | Type | Use | Default | Description |
|---|---|---|---|---|
language | string | optional | "javascript" | Defines the JSR-223 language to use. The default is ECMAScript using either the Rhino (Java 7) or Nashorn (Java 8) engines. |
| string | optional | The ID of a Spring bean defined elsewhere in the configuration. |
If the customObjectRef attribute is present, the result of the referenced Spring bean is made available to the script in a variable named custom. This is in addition to the normal script context discussed below.
Child Elements
An element of type ScriptType has the following child elements:
| Name | Cardinality | Description |
|---|---|---|
<Script> |
| An inline script |
<ScriptFile> | Path to a local file or classpath resource containing the script |
The script may be stored in a local file (with <ScriptFile>) or written inline (with <Script>). An inline script should be wrapped with a CDATA section to prevent interpretation of any special XML characters that may be included in the script.
Always wrap inline scripts with a CDATA section
Always wrap inline scripts with a CDATA section, even if the script contains no special XML characters. This will future-proof your script.
Script Context
Each element of type ScriptType provides relevant script context, that is, one or more input objects to be utilized by the script. For specific details, consult the individual configuration element pages listed above.
Examples
The following example illustrates the use of a CDATA section
<Script>
<![CDATA[
// script goes here
]]>
</Script>
For additional examples of scripts, consult the individual configuration element pages listed above.