https://github.com/smooks/smooks-scripting-cartridge

Smooks Scripting Cartridge
https://github.com/smooks/smooks-scripting-cartridge

groovy smooks-cartridge

Last synced: 14 days ago
JSON representation

Smooks Scripting Cartridge

• Host: GitHub
• URL: https://github.com/smooks/smooks-scripting-cartridge
• Owner: smooks
• License: other
• Created: 2020-03-28T08:02:14.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-04-29T10:21:54.000Z (8 months ago)
• Last Synced: 2024-05-20T12:14:36.058Z (7 months ago)
• Topics: groovy, smooks-cartridge
• Language: Java
• Homepage: https://www.smooks.org
• Size: 178 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.adoc
  • License: LICENSE

Awesome Lists containing this project

README

        
= Smooks Scripting Cartridge

image:https://img.shields.io/maven-central/v/org.smooks.cartridges/smooks-scripting-cartridge[Maven Central]

image:https://img.shields.io/nexus/s/org.smooks.cartridges/smooks-scripting-cartridge?server=https%3A%2F%2Foss.sonatype.org[Sonatype Nexus (Snapshots)]

image:https://github.com/smooks/smooks-scripting-cartridge/workflows/CI/badge.svg[Build Status]

// tag::smooks-scripting-cartridge[]

Support for https://groovy-lang.org/[Groovy] scripting is made available through the `+https://www.smooks.org/xsd/smooks/groovy-2.0.xsd+` configuration namespace.

Example configuration:

.smooks-config.xml

[source,xml]

----

    

        

        

        

    

----

*Usage Tips*

. Imports can be added via the `+imports+` element. A number of classes are automatically imported:

* `+org.smooks.support.DomUtils+`

* `+org.smooks.api.bean.context.BeanContext+`

* `+org.smooks.api.bean.repository.BeanRepository+`

* `+org.w3c.dom.*+`

* `+groovy.xml.dom.DOMCategory+`, `+groovy.xml.dom.DOMUtil+`, `+groovy.xml.DOMBuilder+`

. The visited element is available to the script through the variable `+element+`. It is also available under a variable name equal to the element name, but only if the element name contains alpha-numeric characters only.

. By default, the script is executed on the _visitAfter_ event. You can direct it to be executed on the _visitBefore_ by setting the `+executeBefore+` attribute to `+true+`.

. If the script contains special XML characters, it can be wrapped in an XML Comment or CDATA section.

== Groovy Scriptlet Variables and Methods

A number of variables and methods are made directly available to groovy scriptlet code i.e. you can reference them directly in your scriptlet.

=== Variables

* `+element+`: The DOM/SAX Element (depending on which filter type is in use) i.e. `+org.w3c.dom.Element+` or `+org.api.smooks.delivery.sax.SAXElement+`.

* `+executionContext+`: The Smooks `+ExecutionContext+` instance associated with the Smooks filtering operation.

* `+nodeModels+`: A map containing all the DOM NodeModels currently available (i.e., `+Map+`).

=== Methods

* Get a bean from `+Object BeanContext#getBean(String beandId)+`.

== Adding Beans to the BeanContext

As shown above, all scriptlet code can access the beans by calling `+BeanContext#getBean(String)+` from inside the scriptlet code. One oversight when implementing this feature was that we didn't provide an `+addBean+` method for adding beans to the bean context. However, it is still possible to do so in a slightly more long-winded method via the `+executionContext+` e.g.:

[source,java]

----

executionContext.getBeanContext().addBean("myBean", myBeanInstance);

----

== Maven Coordinates

.pom.xml

[source,xml]

----

    org.smooks.cartridges

    smooks-scripting-cartridge

    2.0.1

----

// end::smooks-scripting-cartridge[]

== License

Smooks Scripting Cartridge is open source and licensed under the terms of the Apache License Version 2.0, or the GNU Lesser General Public License version 3.0 or later. You may use Smooks Scripting Cartridge according to either of these licenses as is most appropriate for your project.

`+SPDX-License-Identifier: Apache-2.0 OR LGPL-3.0-or-later+`