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 28. Ruby
Overview
Copier lienLien copié sur presse-papiers!
				Ruby is a dynamic, open source programming language with a focus on simplicity and productivity. It has an elegant syntax that is natural to read and easy to write. The Ruby support is part of the 
camel-script module.
			Adding the script module
Copier lienLien copié sur presse-papiers!
				To use Ruby in your routes you need to add a dependency on 
camel-script to your project as shown in Example 28.1, “Adding the camel-script dependency”.
			Example 28.1. Adding the camel-script dependency
Static import
Copier lienLien copié sur presse-papiers!
				To use the 
ruby() 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 28.1, “Ruby attributes” lists the built-in attributes that are accessible when using Ruby.
			
| 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 28.2, “Route using Ruby” shows a route that uses Ruby.
			
Example 28.2. Route using Ruby
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").ruby("properties.resolve(PropKey)")
.setHeader("myHeader").ruby("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".