Fuse 6 is no longer supported
As of February 2025, Red Hat Fuse 6 is no longer supported. If you are using Fuse 6, please upgrade to Red Hat build of Apache Camel.Ce contenu n'est pas disponible dans la langue sélectionnée.
Chapter 16. Groovy
Overview
Copier lienLien copié sur presse-papiers!
				Groovy is a Java-based scripting language that allows quick parsing of object. The Groovy support is part of the 
camel-script module.
			Adding the script module
Copier lienLien copié sur presse-papiers!
				To use Groovy in your routes you need to add a dependency on 
camel-script to your project as shown in Example 16.1, “Adding the camel-script dependency”.
			Example 16.1. Adding the camel-script dependency
Static import
Copier lienLien copié sur presse-papiers!
				To use the 
groovy() static method in your application code, include the following import statement in your Java source files:
			import static org.apache.camel.builder.camel.script.ScriptBuilder.*;
import static org.apache.camel.builder.camel.script.ScriptBuilder.*;Built-in attributes
Copier lienLien copié sur presse-papiers!
				Table 16.1, “Groovy attributes” lists the built-in attributes that are accessible when using Groovy.
			
| Attribute | Type | Value | 
|---|---|---|
| context | org.apache.camel.CamelContext | The Camel Context | 
| exchange | org.apache.camel.Exchange | The current Exchange | 
| request | org.apache.camel.Message | The IN message | 
| response | org.apache.camel.Message | The OUT message | 
| properties | org.apache.camel.builder.script.PropertiesFunction | Function with a resolvemethod to make it easier to use the properties component inside scripts. | 
				The attributes all set at 
ENGINE_SCOPE.
			Example
Copier lienLien copié sur presse-papiers!
				Example 16.2, “Routes using Groovy” shows two routes that use Groovy scripts.
			
Example 16.2. Routes using Groovy
Using the properties component
Copier lienLien copié sur presse-papiers!
				To access a property value from the properties component, invoke the 
resolve method on the built-in properties attribute, as follows:
			.setHeader("myHeader").groovy("properties.resolve(PropKey)")
.setHeader("myHeader").groovy("properties.resolve(PropKey)")
				Where PropKey is the key of the property you want to resolve, where the key value is of 
String type.
			
				For more details about the properties component, see chapter "Properties" in "Apache Camel Component Reference".
			
Customizing Groovy Shell
Copier lienLien copié sur presse-papiers!
				Sometimes, you might need to use the custom 
GroovyShell instance, in your Groovy expressions. To provide custom GroovyShell, add an implementation of the org.apache.camel.language.groovy.GroovyShellFactory SPI interface to your Camel registry.
			
				For example, when you add the following bean to your Spring context, Apache Camel will use the custom 
Copy to Clipboard
Copied!
 
 
Toggle word wrap
Toggle overflow
 
 
			
GroovyShell instance that includes the custom static imports, instead of the default one.