User Guide

Table Of Contents

Introduction

This is the user guide for the Smooks for Mule module. The Smooks for Mule
module has two different versions. One for Mule 1.x and one for Mule 2.x. Both versions currently have almost the same features. That is why there is only one User guide.

Note that this user guide does not explain Smooks itself. The Smooks project has it's own User Guide for that. You can find it here.

Installation

There are installation packages for both the Mule 1.x and Mule 2.x versions of the Smooks for Mule module. Go to the Download page to download the package for the Mule version that you need. Take a look at the README.txt file for the installation instructions.

Configuration

The following sections explain the configuration options for the components. The configuration options for the Mule 1.x and Mule 2.x versions are the same.

For Mule 2.x the Smooks for Mule module provides a Mule configuration XML Schema. The namespace and schema location are as followed:
Namespace: http://www.muleforge.org/smooks/schema/mule-module-smooks/1.0
Schema location: http://dist.muleforge.org/smooks/schema/mule-module-smooks/1.0/mule-module-smooks.xsd

Transformer Configuration

Mule 1.x

The transformer is configured in your Mule Xml configuration file as follows:

<transformers>
    <transformer name="SmooksTransformer"  className="org.milyn.smooks.mule.Transformer">
            <properties>
                <property name="configFile" value="smooks-config.xml"/>
            </properties>
     </transformer>
</transformers>

And then specified for the inbound and/or outbound routers like this:

<inbound-router>
    <endpoint address="stdio://System.in" transformers="SmooksTransformer"/>
</inbound-router>

Mule 2.x

The transformer is configured in your Mule Xml configuration file as follows:

<smooks:transformer name="smooksTransformer" configFile="/transformer-smooks-config.xml" />

And then specified for the inbound and/or outbound routers like this:

<inbound>
    <vm:inbound-endpoint path="messageInput" transformer-refs="smooksTransformer"/>
</inbound>

Configuration Properties (Mule version independent)

Outbound Router Configuration

Mule 1.x

The router is configured in your Mule Xml configuration file as follows:

<outbound-router>
    <router className="org.milyn.smooks.mule.Router">
        <endpoint name="order" address="jms://order.queue"/>
        <endpoint name="order-important" address="jms://order.important.queue"/>
        <properties>
            <property name="configFile" value="/router-smooks-config.xml" />
        </properties>
    </router>
</outbound-router>

In the Smooks configuration you use the org.milyn.smooks.mule.MuleDispatcher to route to one of the endpoints you defined in the Mule configuration. More on the MuleDispatcher can be found in the Smooks MuleDispatcher section.

Mule 2.x

The router is configured in your Mule Xml configuration file as follows:

<outbound>
    <smooks:router configFile="/smooks-config.xml">
        <jms:outbound-endpoint name="order" queue="order.queue"/>
        <jms:outbound-endpoint name="order-important" queue="order.important.queue"/>
    </smooks:router>
</outbound>

In the Smooks configuration you use the org.milyn.smooks.mule.MuleDispatcher to route to one of the endpoints you defined in the Mule configuration. More on the MuleDispatcher can be found in the Smooks MuleDispatcher section.

Configuration Properties (Mule version independent)

Smooks MuleDispatcher

A MuleDispatcher is defined as follows:

<resource-config selector="order">
    <resource>org.milyn.smooks.mule.MuleDispatcher</resource>
    <param name="endpointName">order</param>
    <param name="beanId">order</param>
</resource-config>

MuleDispatcher messageProperties attribute
Message properties are defined as folows:

<resource-config selector="order">
    <resource>org.milyn.smooks.mule.MuleDispatcher</resource>
    <param name="endpointName">testEndpoint</param>
    <param name="beanId">test</param>
    <param name="messageProperties">
        <property name="prop1" value="prop1Value" />
        <property name="prop2">"prop2Value"</property>
        <property name="intProp" value="10" type="Integer" />
        <property name="dateProp" value="2008-07-11 12:30:56" type="DateTime" />
    </param>
</resource-config>

<resource-config selector="decoder:DateTime">
   <resource>org.milyn.javabean.decoders.DateDecoder</resource>
   <param name="format">yyyy-MM-dd HH:mm:ss</param>
</resource-config>

The following points explain the four properties:

• The first property uses a attribute to set the value.
• The second property takes the property element content and parses it as a MVEL expression.
• The third property uses the type attribute to define a Integer type. This will convert the value into an Integer. This uses the standard DataDecoder feature from Smooks.
• The fourth property uses the type attribute to define a custom configured Date type. This will convert the value into a Date. The configuration is set in the resource-config with the "decoder:DateTime" selector. This uses the standard DataDecoder feature from Smooks.

Description of the property attributes

Description of the property element content
The property element content is parsed as a MVEL expression. This gives great flexibility. The MVEL context contains all the beans from the bean map. The type and value attribute are ignored when the element content is set.