Space Details Key:
MULE2USER
Name:
Mule 2.x User Guide
Description:
Mule Users Guide for the 2.x release line
Creator (Creation Date):
ross (Jan 30, 2008)
Last Modifier (Mod. Date): tcarlson (Apr 15, 2008)
Available Pages •
Home Storing Objects in the Registry • About Transports • •
Available Transports BPM Transport • CXF Transport • Building a CXF Web Service • CXF Transport Configuration Reference • •
Enabling WS-Addressing
•
Enabling WS-Security
•
Supported Web Service Standards
•
Using a Web Service Client as an Outbound Endpoint
•
Using a Web Service Client Directly
•
Using HTTP GET Requests
•
Using MTOM • EJB Transport
•
Email Transport
•
File Transport
•
FTP Transport
•
HTTPS Transport
•
HTTP Transport
•
IMAPS Transport
•
IMAP Transport
•
JDBC Transport JDBC Transport Examples • JDBC Transport Performance Benchmark Results •
• •
Jetty Transport Jetty SSL transport • JMS Transport
•
Mule WMQ Transport
•
Multicast Transport
•
POP3S Transport
•
POP3 Transport
•
Quartz Transport
Document generated by Confluence on Mar 11, 2009 14:57
Page 1
•
RMI Transport
•
Servlet Transport
•
SMTPS Transport
•
SMTP Transport
•
SOAP Transport
•
SSL Transport
•
STDIO Transport
•
TCP Transport
•
UDP Transport
•
VM Transport
•
WSDL Transport
•
XMPP Transport • Bootstrapping the Registry
•
Choosing the Right Topology
•
Configuration Overview
•
Configuration Reference Asynchronous Reply Router Configuration Reference • Catch All Strategy Configuration Reference • •
Component Configuration Reference
•
Endpoint Configuration Reference
•
Exception Strategy Configuration Reference
•
Filters Configuration Reference
•
Global Settings Configuration Reference
•
Inbound Router Configuration Reference
•
Model Configuration Reference
•
Notifications Configuration Reference
•
Outbound Router Configuration Reference
•
Properties Configuration Reference
•
Service Configuration Reference
•
Transactions Configuration Reference • Configuring a Mule Instance Configuring Endpoints • Mule Endpoint URIs •
•
Using Filters • Configuring a Transport Configuring Retry Policies •
•
Configuring Logging
•
Configuring Queues
•
Configuring Security Component Authorization Using Acegi • Component Authorization Using Spring Security • •
Configuring the Acegi Security Manager
Document generated by Confluence on Mar 11, 2009 14:57
Page 2
•
Configuring the Spring Security Manager
•
Encryption Strategies
•
Setting up LDAP Provider for Acegi
•
Setting up LDAP Provider for Spring Security
•
Upgrading from Acegi to Spring Security • Controlling the Infrastructure with Mule Galaxy
•
Creating a Custom XML Namespace
•
Creating Custom Routers
•
Creating Transports Transport Archetype •
•
Transport Service Descriptors • Deployment Scenarios Deploying Mule to WebLogic • Embedding Mule in a Java Application or Webapp • •
•
JBoss Integration Mule as MBean • Developing Service Components Entry Point Resolver Configuration Reference •
•
Error Handling
•
Functional Testing
•
Open MQ Integration
•
Internationalizing Strings
•
Introduction to Extending Mule
•
Introduction to Testing Mule
•
Models
•
Mule Agents Jmx Management •
•
Mule Server Notifications
•
Profiling Mule
•
Resource Adapter
•
Suggested Reading
•
Third-party Software in Mule
•
Transaction Management
•
Tuning Performance
•
Unit Testing
•
Using IDEs
•
Using Mule HQ Installing Mule HQ with an External Database • Mule HQ Agent Settings •
•
Using Mule Modules Acegi Module • JAAS Module • •
JBoss Transaction Manager
Document generated by Confluence on Mar 11, 2009 14:57
Page 3
•
•
•
Scripting Module
•
Spring Extras Module
•
SXC Module
•
XML Module DomToXml Transformer • JXPath Extractor Transformer • •
XmlObject Transformers
•
XmlToXMLStreamReader Transformer
•
XPath Extractor Transformer
XSLT Transformer • Using Mule with Spring Sending and Receiving Mule Events in Spring • Spring Application Contexts • Using Spring Beans as Service Components • Using the Mule Client
•
Using the Mule RESTpack Architecting RESTful HTTP applications • Making Sense of REST •
•
Using Transformers Creating Custom Transformers • Transformers Configuration Reference •
•
•
•
XmlPrettyPrinter Transformer • Using Web Services Axis • Axis SOAP Styles • Axis SOAP Transports • •
Axis Transport
•
Axis Web Services and Mule
•
Configuring Axis • Proxying Web Services
•
Using .NET Web Services with Mule
Web Service Wrapper • Working with Services Configuring Components • Configuring Java Components • •
Using Interceptors • Configuring the Service
•
MEPs
•
Mule Messaging Styles
•
Using Message Routers Component Bindings • Using the WireTap Inbound Router •
XML Configuration
Document generated by Confluence on Mar 11, 2009 14:57
Page 4
•
ActiveMQ Integration
•
Example Archetype
•
Fiorano Integration
•
Integrating SwiftMQ with Mule
•
Jaas Security
•
JavaRebel Integration
•
JBoss Jms Integration
•
Module Archetype
•
OpenJms Integration
•
PGP Security
•
Project Archetype
•
SeeBeyond JMS Server Integration
•
SonicMQ Integration
•
Sun JMS Grid Integration
•
Tibco EMS Integration
•
Using Expressions Creating Expression Evaluators • Expressions Configuration Reference •
•
WebLogic JMS Integration
•
WebSphere MQ Integration
Document generated by Confluence on Mar 11, 2009 14:57
Page 5
Home This page last changed on Feb 24, 2009 by jackie.wheeler.
Some of the documentation on this site is under construction for the current release. If you have any feedback on the content, or would like to sign up to become a site contributor or editor, please contact us.
Getting Started (Click the arrow to expand the topics from the Getting Started guide, including an introduction to Mule, steps to get started, and migration information.) Click here to expand... • Introduction ° What is Mule? ° Understanding the Messaging Framework ° Understanding the Mule Architecture ° Understanding the Logical Data Flow ° Integrating Mule into Your Environment ° Summary • Getting Started ° Quick Start ° Download Page ° Installing Mule ° Running Mule ° Setting Up Eclipse ° Examples ° Basic Usage ° What's New in This Release ° Migrating Mule
Using Mule • Configuring Mule ° Configuration Overview ° XML Configuration ° Configuring a Mule Instance ° Configuring Endpoints ° Using Transformers ° About Models • Working with Services ° Configuring the Service ° Configuring Components ° Using Message Routers ° Using Filters ° Mule Messaging Styles ° Using Web Services ° Using Spring Beans as Service Components • Customizing Behavior ° Developing Service Components ° Creating Custom Transformers ° Creating Custom Routers ° Creating Custom Filters
Document generated by Confluence on Mar 11, 2009 14:57
Using Transports • About Transports • Available Transports • Configuring a Transport
Mule Deployment Architecture • Deployment Scenarios • Choosing the Right Topology
Mule Administration • Managing and Monitoring Deployments °
Using Mule HQ Jmx Management • Controlling the Infrastructure with Mule Galaxy °
Extending Mule • • • • • • •
Introduction to Extending Mule Creating Transports Creating a Custom XML Namespace Creating Expression Evaluators Bootstrapping the Registry Internationalizing Strings Using MuleForge
Testing Mule • • • • •
Introduction to Testing Mule Functional Testing Unit Testing Running Benchmark Tests Profiling Mule
Development Tools • • • •
Developer's Guide Using IDEs Mule IDE User Guide Using Maven
Page 6
Using Interceptors Configuring Retry Policies • Beyond the Basics ° Using Expressions ° Using Mule with Spring ° Using the Mule RESTpack ° Using Mule Modules ° Error Handling ° Storing Objects in the Registry ° Configuring Security ° Using the Mule Client ° Tuning Performance ° Configuring Queues ° Managing Transactions ° Using Agents ° Mule Server Notifications ° Configuring Logging ° °
Reference • • • • • • • •
Glossary Configuration Reference API Reference Test API Reference Third-party Software in Mule Suggested Reading Distribution Contents PDF versions of the User's Guide for offline reading
Documentation for Previous Releases Click a link below to view the documentation for that release.
Mule 1.x • Getting Started • User Guide
Document generated by Confluence on Mar 11, 2009 14:57
Page 7
Storing Objects in the Registry This page last changed on Feb 14, 2009 by tcarlson.
Storing Objects in the Registry If you need to store runtime data that is available across the application, you can store the data as objects in the Registry . You can get a handle to the Registry from anywhere that you have access to the MuleContext , as in most Mule entities. For example, you could store the object as follows:
muleContext.getRegistry().registerObject("foo", new MyFoo());
You could then update the object from somewhere else:
Foo foo = (Foo) muleContext.getRegistry().lookupObject("foo"); foo.setBarVal(25); // Replace the previous object muleContext.getRegistry().registerObject("foo", foo);
This approach is useful for storing an object that is needed by multiple components across your application.
Document generated by Confluence on Mar 11, 2009 14:57
Page 8
About Transports This page last changed on Nov 19, 2008 by jackie.wheeler.
About Transports A transport is responsible for carrying messages from application to application in the Mule framework. A transport provides a set of functionality that handles messages on a specific channel. For example, the HTTP transport handles messages sent via the HTTP protocol, whereas the File transport picks up files placed on the server's file system. The heart of a transport is the connector. The connector maintains the configuration and state for the transport. When receiving messages, a connector uses a message receiver, which reads the data, packages it as a message, and passes it to the service component's inbound router. When sending messages, the connector uses a message dispatcher, which receives the messages and routing instructions from the service component's outbound router and sends the message to the next service component or application.
Related Topics Available Transports Configuring a Transport Creating Transports
Document generated by Confluence on Mar 11, 2009 14:57
Page 9
Available Transports This page last changed on Jan 19, 2009 by jackie.wheeler.
Available Transports [ Mule Transports ] [ Transports Feature Matrix ] Following is a list of known transports (also called "providers") for Mule. Some functionality is contained within modules instead of transports--see Using Mule Modules. For more information on transports, see the following topics: • About Transports • Configuring a Transport • Creating Transports If you have created a transport for Mule and would like to share it with the Mule community, please contact us. The following list includes some prominent transports from MuleForge (denoted by are available only in Mule Enterprise Edition are denoted by
). Transports that
.
Mule Transports Transport
AS400 DQ Transport
Description Connectivity to IBM AS400 Data Queue messaging server. This transport is available on MuleForge.
Axis Transport
Allows Mule managed components to be published as Axis services and allows components to invoke web services using Axis client calls.
BPM Transport
Allows Mule events to initiate and/or advance processes in a Business Process Management System (BPMS) a.k.a. Process Engine.
CXF Transport
Provides support for web service integration via Apache CXF.
EJB Transport
Allows EJB invocations to be made using outbound endpoints.
Email Transport
This transport supplies various email connectivity options.
File Transport
This transport allows files to be read and written to directories on the local file system. The connector can be configured to filter the file it reads and the way files are written, such as whether binary output is used or the file is appended to.
FTP Transport
Allows files to be read / written to a remote FTP server.
Document generated by Confluence on Mar 11, 2009 14:57
Page 10
HTTP Transport
This transport supplies HTTP transport of Mule messages between applications and other Mule servers.
HTTPS Transport
A secure version of the HTTP transport.
IMAP Transport
Connectivity to IMAP mail folders.
IMAPS Transport
A secure version of the IMAP transport.
JCR Transport
JDBC Transport
A transport that reads from, writes to, and observes JCR 1.0 containers. This transport is available on MuleForge. A transport for JDBC connectivity. Some of its features are available only in Mule Enterprise Edition.
Jetty Transport
Provides support for exposing services over HTTP by embedding a light-weight Jetty server. For inbound endpoints only.
Jetty SSL transport
A secure version of the Jetty transport.
JMS Transport
A Mule transport for JMS connectivity. Mule itself is not a JMS server but can use the services of any JMS 1.1 or 1.02b compliant server such as ActiveMq, OpenJms, Joram, JBossMQ, and commercial vendors such as WeblogicMQ, WebsphereMQ, SonicMQ, SeeBeyond, etc.
Multicast Transport
Allows your components to receive and send events via IP multicast groups.
POP3 Transport
Connectivity to POP3 inboxes.
POP3S Transport
A secure version of the POP3 transport.
Quartz Transport
Provides scheduling facilities with cron / interval definitions and allows Mule events to be scheduled/rescheduled.
RMI Transport
Enables events to be sent and received over RMI via JRMP.
Servlet Transport
Provides facilities for Mule components to listen for events received via a servlet request. There is also a servlet implementation that uses the Servlet transport to enable REST style services access. This transport is now bundled with the HTTP transport.
SMTP Transport
Connectivity to SMTP servers.
SMTPS Transport
A secure version of the SMTP transport.
SOAP Transport
Enables your components to be exposed as web services and to act as SOAP clients. The SOAP transport supports CXF and Apache Axis.
SSL Transport
Provides secure socket-based communication using SSL or TLS.
Document generated by Confluence on Mar 11, 2009 14:57
Page 11
STDIO Transport
This transport provides connectivity to streams such as System.in and System.out and is useful for testing.
TCP Transport
Enables events to be sent and received over TCP sockets.
UDP Transport
Enables events to be sent and received as datagram packets.
VM Transport
Enables event sending and receiving over VM, embedded memory, or persistent queues. A Mule transport for WebSphere MQ. This transport is available with Mule Enterprise version 1.6 and later.
WebSphere MQ Transport
WSDL Transport
Invokes remote web services by obtaining the service WSDL. Mule will create a dynamic proxy for the service and then invoke it.
XMPP Transport
Provides connectivity over the XMPP (Jabber) instant messaging protocol.
Transports Feature Matrix The following table shows the different messaging styles and options that each of the Mule transports support. The headings are described below the table.
Transport Receive Events
Dispatch Events
Request Events
Request/ Transactions Streaming Inbound Response MEPs Events
Outbound MEPs
Axis
InOnly InOut InOptionalOut
Out-Only OutIn OutOptionalIn
BPM
InOnly InOut InOptionalOut
Out-Only
CXF
InOnly InOut InOptionalOut
Out-Only OutIn OutOptionalIn
EJB
In-Only
Out-Only OutIn OutOptionalIn
Email
In-Only
Out-Only
Document generated by Confluence on Mar 11, 2009 14:57
Page 12
File
In-Only
Out-Only
FTP
In-Only
Out-Only
HTTP
InOut InOptionalOut
OutIn OutOptionalIn
HTTPS
InOut InOptionalOut
OutIn OutOptionalIn
IMAP
In-Only
IMAPS
In-Only
JDBC
InOnly InOut InOptionalOut
Jetty
InOnly InOut InOptionalOut
Jetty SSL
InOnly InOut InOptionalOut
JMS
InOnly InOut InOptionalOut
Out-Only OutIn OutOptionalIn
Multicast
InOut InOptionalOut
OutIn OutOptionalIn
POP3
In-Only
POP3S
In-Only
Quartz
In-Only
Out-Only
RMI
In-Only
Out-Only Out-In
Servlet
InOnly InOut In-
Document generated by Confluence on Mar 11, 2009 14:57
Out-Only OutIn OutOptionalIn
Page 13
OptionalOut SMTP
Out-Only
SMTPS
Out-Only
SOAP
InOnly InOut InOptionalOut
Out-Only OutIn OutOptionalIn
STDIO
In-Only
Out-Only
TCP
InOut InOptionalOut
OutIn OutOptionalIn
UDP
InOut InOptionalOut
OutIn OutOptionalIn
VM
InOnly InOut InOptionalOut
Out-Only OutIn OutOptionalIn
XMPP
InOnly InOut InOptionalOut
Out-Only OutIn OutOptionalIn
Heading Descriptions Transport - The name/protocol of the transport Receive Events - Whether the transport can receive events and can be used for an inbound endpoint Dispatch - Whether events can be sent asynchronously Request - Whether this endpoint can be queried directly with a request Request/Response - Whether this endpoint can be queried directly with a request and return a response (implementation of the request() method in MessageRequester) Transactions - Whether transactions are supported by the transport. Transports that support transactions can be configured in a distributed two-phase commit (distributed) transaction. Streaming - Whether this transport can stream data between endpoints. This allows for very efficient processing of large data. Inbound and Outbound MEPs - The messaging exchange patterns (MEPs) supported by the inbound and outbound endpoints of the transport. See Mule Messaging Styles for more information on the messaging styles Mule supports and how they map to MEPs.
Document generated by Confluence on Mar 11, 2009 14:57
Page 14
BPM Transport This page last changed on Feb 20, 2009 by jackie.wheeler.
BPM Transport [ Features ] [ Usage ] [ Integration with BPM Engines ] [ Configuration ] [ Connector ] The BPM transport allows Mule events to initiate and/or advance processes in a Business Process Management System (BPMS), also known as a process engine. It also allows executing processes to generate Mule events. For a high-level introduction to Business Process Management with Mule and the concepts involved, see the presentation from MuleCon 2007. To see the BPM Connector in action (with JBoss jBPM), take a look at the LoanBroker BPM example (available in the full Mule distribution). Javadocs for the BPM transport are available here .
Features • Incoming Mule events can launch new processes, advance or terminate running processes. • A running process can generate synchronous or asynchronous Mule events. • Endpoints of type "bpm://MyProcess" are used to intelligently route process-generated events within Mule. • Synchronous responses from Mule are automatically fed back into the running process. • Mule can interact with different running processes in parallel. BPEL The connector can only integrate with BPM engines that provide a Java API. If you need to integrate with a BPEL engine that only exposes SOAP endpoints (i.e., "a black box"), you will need to use standard web services. For an example, see MULE and Oracle SOA BPEL Integration.
Usage Sending events to the BPMS The basic URI for a new process is: bpm://ProcessType
For a running process, use: bpm://ProcessType/ProcessID
Initiate a new process of type "MyBigProcess" bpm://MyBigProcess
Advance an already running process with ID = 4561 bpm://MyBigProcess?processId=4561&action=advance
(advance is the default action for an already-running process) or just bpm://MyBigProcess/4561
Update process variables (without advancing the process) bpm://MyBigProcess/4561?action=update
Document generated by Confluence on Mar 11, 2009 14:57
Page 15
Abort a running process (this might not be supported by every BPMS) bpm://MyBigProcess/4561?action=abort
In a real system, you will most likely want to set the "processId" dynamically as a property on the message.
Incoming Messages to the BPMS When a message is received by the BPMS, two things automatically happen: • The message payload is stored in a process variable named "incoming" • The endpoint on which the message was originally received by Mule is stored in a process variable named "incomingSource" These process variables may then be used to drive the logic of the running process.
Generating Events from the BPMS The actual syntax for generating events from a running process will depend on the BPMS used. Messages generated by a running process will be received by Mule on the best-matching endpoint available. For example, suppose a Mule message is generated by the running process called "MyBigProcess" with ID = 4561. The incoming message would preferably be received by this endpoint: bpm://MyBigProcess/4561
and if not, then by this endpoint: bpm://MyBigProcess
and finally, if the "allowGlobalReceiver" property is true, by this endpoint: bpm://*
The new message will then be routed from the component on which it is received (unless the connector's allowGlobalDispatcher property is true). If the message is synchronous, the response will automatically be sent back to the generating process.
Integration with BPM Engines One of the basic design principles of Mule is to promote maximum flexibility for the user. Based on this, the user should ideally be able to "plug in" any BPM engine to use with Mule. Unfortunately, there is no standard JEE specification to enable this. JSR-207 was one attempt but has made no progress. BPEL has also tried to solve this, but like JBI, is exclusive to SOAP web services and XML, which defeats Mule's flexibility principle. Therefore, until such a specification ever emerges, the Mule BPM Transport simply defines its own.
public interface BPMS { // Start a new process. public Object startProcess(Object processType, Map processVariables); // Advance an already-running process. public Object advanceProcess(Object processId, Object transition, Map processVariables); // Update the variables/parameters for an already-running process. public Object updateProcess(Object processId, Map processVariables); // Abort a running process (end abnormally). public void abortProcess(Object processId);
Document generated by Confluence on Mar 11, 2009 14:57
Page 16
// MessageService is a callback method used to generate Mule messages from your process. public void setMessageService(MessageService msgService); }
Any BPM engine that implements the interface ( org.mule.transport.bpm.BPMS ) can "plug in" to Mule via the BPM transport. The JBoss jBPM engine is available with Mule.
Integration with JBoss jBPM For general information on jBPM and how to configure it, refer to http://docs.jboss.com/jbpm/v3/ userguide The org.mule.transport.bpm.jbpm.Jbpm class implements the BPMS interface for jBPM and must be set as the bpms property on your connector. You can browse the rest of the Javadocs for Mule's jBPM integration here . Configuration The recommended way to configure jBPM with Mule is using Spring and Spring's jBPM Module
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:spring="http://www.springframework.org/schema/beans" xmlns:context="http://www.springframework.org/schema/context" xmlns:bpm="http://www.mulesource.org/schema/mule/bpm/2.2" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/springbeans-2.5.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/ spring-context-2.5.xsd http://www.mulesource.org/schema/mule/core/2.2 http://www.mulesource.org/schema/mule/core/2.2/ mule.xsd http://www.mulesource.org/schema/mule/bpm/2.2 http://www.mulesource.org/schema/mule/bpm/2.2/ mule-bpm.xsd">
<spring:bean id="jbpm" class="org.mule.transport.bpm.jbpm.Jbpm" destroy-method="destroy"> <spring:property name="jbpmConfiguration"> <spring:ref local="jbpmConfig" /> <spring:bean id="jbpmConfig" class="org.springmodules.workflow.jbpm31.LocalJbpmConfigurationFactoryBean"> <spring:property name="sessionFactory"> <spring:ref local="jbpmSessionFactory" /> <spring:property name="configuration"> <spring:value>jbpm.cfg.xml <spring:property name="processDefinitions"> <spring:list> <spring:bean id="loanBroker" class="org.springmodules.workflow.jbpm31.definition.ProcessDefinitionFactoryBean"> <spring:property name="definitionLocation"> <spring:value>loan-broker-process.xml
Document generated by Confluence on Mar 11, 2009 14:57
Page 17
<spring:property name="createSchema"> <spring:value>false
<spring:bean id="jbpmSessionFactory" class="org.springframework.orm.hibernate3.LocalSessionFactoryBean"> <spring:property name="dataSource"> <spring:ref local="jbpmDataSource" /> <spring:property name="mappingLocations"> <spring:value>classpath*:/org/jbpm/**/*.hbm.xml <spring:property name="typeDefinitions"> <spring:ref local="jbpmTypes" /> <spring:property name="hibernateProperties"> <spring:props> <spring:prop key="hibernate.dialect">org.hibernate.dialect.DerbyDialect <spring:prop key="hibernate.cache.provider_class">org.hibernate.cache.HashtableCacheProvider <spring:prop key="hibernate.hbm2ddl.auto">update <spring:bean id="jbpmDataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource"> <spring:property name="driverClassName"> <spring:value>org.apache.derby.jdbc.EmbeddedDriver <spring:property name="url"> <spring:value>jdbc:derby:muleEmbeddedDB;sql.enforce_strict_size=true <spring:bean id="jbpmTypes" class="org.springframework.orm.hibernate3.TypeDefinitionBean"> <spring:property name="typeName"> <spring:value>string_max <spring:property name="typeClass"> <spring:value>org.jbpm.db.hibernate.StringMax
If you want to configure jBPM without using Spring, you create the org.mule.transport.bpm.jbpm.Jbpm wrapper based on your jBPM instance and set it as the bpms property on the BPM connector:
ProcessConnector connector = new ProcessConnector(); BPMS bpms = new org.mule.transport.bpm.jbpm.Jbpm(yourJbpmInstance); connector.setBpms(bpms);
Document generated by Confluence on Mar 11, 2009 14:57
Page 18
MuleManager.getInstance().registerConnector(connector);
Generating a Mule Message from jBPM Use the org.mule.transport.bpm.jbpm.actions.SendMuleEvent ActionHandler to generate a Mule message from your jBPM process:
<process-definition name="sendMessageProcess"> <description>Generates a simple Mule event. <start-state name="start">
<state name="sendMessage"> <event type="node-enter">
<endpoint>file:///tmp <payload>Message in a bottle. <synchronous>false <end-state name="end" />
jBPM Action Handlers for Mule The primary way of adding custom functionality to jBPM is via ActionHandlers. The BPM transport provides a few such ActionHandlers, which are useful for integrating your jBPM process with Mule. SendMuleEvent : Sends a Mule message to the specified endpoint. If the message is synchronous, the response from Mule will be automatically stored in the "incoming" process variable. StoreIncomingData : Stores the incoming message payload into the specified variable. ValidateMessageSource : Throws an exception if the message's source is not as expected. ValidateMessageType : Throws an exception if the incoming message's class is not as expected.
Configuration Following is a simple configuration example:
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:spring="http://www.springframework.org/schema/beans" xmlns:context="http://www.springframework.org/schema/context" xmlns:bpm="http://www.mulesource.org/schema/mule/bpm/2.2" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/springbeans-2.5.xsd
Document generated by Confluence on Mar 11, 2009 14:57
Page 19
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/ spring-context-2.5.xsd http://www.mulesource.org/schema/mule/core/2.2 http://www.mulesource.org/schema/mule/core/2.2/ mule.xsd http://www.mulesource.org/schema/mule/bpm/2.2 http://www.mulesource.org/schema/mule/bpm/2.2/ mule-bpm.xsd">
<model name="bpm_example"> <service name="ToBPMS">
<service name="FromBPMS">
Message Properties
Property
Description
processType
The name of the process
yes
processId
The unique ID of the running process
yes, unless action = "start"
action
Action to perform on the BPMS: "start" / "advance" / "update" / "abort"
transition
Transition to take if more than one exit path is available for the current process state
Document generated by Confluence on Mar 11, 2009 14:57
Default
"advance" if processId exists, otherwise "start"
Required
no
no
Page 20
Connector Attributes of
Name
Type
Required
bpms-ref
name (no spaces)
no
Default
Description A reference to the underlying BPMS, which must implement the org.mule.transport.bpm.BPMS interface to exchange messages through Mule using the BPM transport.
allowGlobalReceiver boolean
no
false
The global receiver allows an endpoint of type "bpm://*" to receive any incoming message to the BPMS, regardless of the process. If this is false, the process name must be specified for each endpoint. For example, "bpm:// MyProcess" will only receive messages for the process "MyProcess".
allowGlobalDispatcherboolean
no
false
If false, any message generated by the process is routed from the component on which it is received. If true, a process can send messages to any endpoint on any component.
processIdField
no
string
Document generated by Confluence on Mar 11, 2009 14:57
This field will be used to correlate messages with processes.
Page 21
CXF Transport This page last changed on Feb 09, 2009 by jackie.wheeler.
CXF Transport [ Introduction ] [ Features ] [ Using the CXF Transport ] [ Troubleshooting ] [ Suggested Reading ]
Introduction The Mule CXF Transport provides support for web service integration via Apache CXF. Apache CXF is an open source services framework that helps you build and develop services using front-end programming APIs, like JAX-WS. These services can speak a variety of protocols such as SOAP, XML/HTTP, RESTful HTTP, or CORBA and work over a variety of transports such as HTTP, JMS, VM, or JBI. Note: The CXF transport requires Java 5.0.
Features The CXF transport is an evolution of the XFire transport, which was available with earlier versions of Mule. The CXF transport includes the following features: • Integrated Installer: CXF and XFire have some conflicting libraries and therefore cannot both be deployed in the same instance of Mule. The Mule Enterprise installer allows you to install CXF when you're installing Mule and handles all library changes for you. This is an enhancement over the snapshot version of the CXF transport on MuleForge. • Bookstore Example: A complete example of using the CXF transport to send complex objects. • MTOM Support: The CXF transport supports SOAP Message Transmission Optimization Mechanism (MTOM), which specifies an optimized method for sending binary data as part of a SOAP message. • Complete Functional Tests: The functional tests have been converted from XFire to CXF.
Using the CXF Transport Use the following links for information on configuring and using the CXF transport with your implementation of Mule. Building a CXF Web Service Using Web Services over Jetty Using a Web Service Client as an Outbound Endpoint Using a Web Service Client Directly Using HTTP GET Requests Using MTOM Proxying Web Services Supported Web Service Standards Enabling WS-Addressing Enabling WS-Security Bookstore Example Configuration Reference
Troubleshooting This section includes common problems and solutions you might encounter when using the CXF transport. I've received a "java.lang.IllegalArgumentException: wrong number of arguments" when using the CXF outbound endpoint The CXF outbound endpoint uses the CXF generated to client to send messages. Because of this, your message payload must match the signature of the operation being invoked. This error results when the payload does not match the signature.
Document generated by Confluence on Mar 11, 2009 14:57
Page 22
Here's an example. If you have an operation on the client like this:
public void sendData(String data1, String data2, String data3);
Your message payload must be like this:
Object payload = new Object[] { "data1", "data2", "data3" };
My WSDL does not have the correct service address (i.e. its localhost instead of foo.com) If you are doing WSDL-first development, ensure that your @WebService annotation on your service implementation has the correct serviceName, targetNamespace, and portName attributes. If these are not correct, CXF cannot navigate your WSDL, find the address, and replace it with the address currently being used. Your WebService annotation should look like this:
@WebService(serviceName = "YourServiceName", portName = "YourPortName", targetNamespace = "http://your-namespace", endpointInterface = "your.endpoint.Interface", wsdlLocation = "your.wsdl")
Suggested Reading XFire->CXF Migration Guide XFire and Celtix Merge FAQ
Document generated by Confluence on Mar 11, 2009 14:57
Page 23
Building a CXF Web Service This page last changed on Oct 15, 2008 by [email protected].
Building a CXF Web Service [ Creating a JAX-WS Service ] [ Configuring Mule to Use the Web Service ] [ Using WSDL-first Methodologies ] [ Changing the Data Binding ] [ Setting the Binding URI ] [ Changing the Default Message Style ] This page describes how to build a CXF web service and use it in Mule.
Creating a JAX-WS Service The JAX-WS specification is a series of APIs and annotations to help you build web services. This section describes how to create a very simple JAX-WS web service. First, you write the service interface. For example, you could write an operation called "sayHello" that says "Hello" to whoever submits their name.
package org.example; import javax.jws.WebService; @WebService public interface HelloWorld { String sayHi(String text); }
Your implementation would then look like this:
package demo.hw.server; import javax.jws.WebService; @WebService(endpointInterface = "demo.hw.server.HelloWorld", serviceName = "HelloWorld") public class HelloWorldImpl implements HelloWorld { public String sayHi(String text) { return "Hello " + text; } }
Configuring Mule to Use the Web Service To configure Mule to use the service, simply declare your service and use a CXF endpoint as shown in the following example:
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.1" xmlns:xsi="http://www.w3.org/2001/ XMLSchema-instance" xmlns:spring="http://www.springframework.org/schema/beans" xmlns:cxf="http://www.mulesource.org/schema/mule/cxf/2.1" xsi:schemaLocation="http://www.springframework.org/schema/beans
Document generated by Confluence on Mar 11, 2009 14:57
Page 24
http://www.springframework.org/schema/beans/spring-beans-2.5.xsd http://www.mulesource.org/schema/mule/core/2.1 http://www.mulesource.org/schema/mule/core/2.1/mule.xsd http://www.mulesource.org/schema/mule/cxf/2.1 http://www.mulesource.org/schema/mule/cxf/2.1/mule-cxf.xsd"> <model name="CxfExample"> <service name="helloService"> <singleton-object class="org.example.HelloServiceImpl" /> ...
If you go to "http://localhost:63081/hello?wsdl", you will see the WSDL that CXF generates for you. If you want to use a POJO instead of creating a JAX-WS service, you could host the POJO as a service component in Mule and use the simple front-end client with its CXF inbound endpoint. You would configure the POJO as follows:
The frontend property can be "jaxws" (the default) or "simple".
Using WSDL-first Methodologies In addition to the code-first approach outlined above, you can also use CXF to do WSDL-first services. While the details are out of the scope of this guide, the CXF distribution includes many examples of how to do this. First, you generate your web service interface from your WSDL. You can do this using the WSDL to Java tool from CXF or the Maven plugin. Next, you write a service implementation class that implements your service interface. You can then use this implementation class in the Mule configuration exactly as in the previous example. Supplying the Original WSDL to CXF You can supply your original WSDL to CXF by using the @WebService attribute:
WebService(endpointInterface = "demo.hw.server.HelloWorld", serviceName = "HelloWorld", wsdlLocation="foo/bar/hello.wsdl") public class HelloWorldImpl implements HelloWorld
Another way is to specify the wsdlLocation property on the endpoint:
CXF is able to locate this WSDL inside your webapp, on the classpath, or on the file system.
Document generated by Confluence on Mar 11, 2009 14:57
Page 25
Changing the Data Binding You can use the databinding property on an endpoint to configure the data binding to use with that service. Following are the types of data bindings available with CXF: 1. AegisDatabinding 2. JAXBDatabinding (Default) 3. StaxDatabinding You specify the databinding class to use as follows:
<spring:bean class="org.apache.cxf.aegis.databinding.AegisDatabinding"/>
Setting the Binding URI The bindingUri attribute specifies how your service operations are mapped to resources. You configure this attribute as follows:
Changing the Default Message Style By default, CXF uses the Document/Literal message style. However, you can change the service to be exposed as RPC instead of document or to send complex types as wrapped instead of literal. To change the message style, you set the @SOAPBinding annotation on the service's interface, specifying the style, use, and optionally the parameterStyle. In the following example, the parameter style is set to BARE. This means that each parameter is placed into the message body as a child element of the message root. This is WRAPPED by default.
@SOAPBinding(style=SOAPBinding.Style.DOCUMENT, use=SOAPBinding.Use.LITERAL, parameterStyle=SOAPBinding.ParameterStyle.BARE) @WebService public interface Echo { String echo(String src); }
For more information on the supported message styles, go to Optional Annotations.
Document generated by Confluence on Mar 11, 2009 14:57
Page 26
CXF Transport Configuration Reference This page last changed on Feb 20, 2009 by jackie.wheeler.
CXF Transport Configuration Reference [ Connector ] [ Inbound Endpoint ] [ Outbound Endpoint ] [ Endpoint ] [ Common CXF Endpoint Elements ] [ Wrapper Component ] [ Stax ] This page provides reference information about the elements and attributes you can configure for the CXF Transport.
Connector Attributes of
Name
Type
Required
Default
Description
defaultFrontend
string
no
jaxws
The CXF frontend that is used to build an internal service representation from your Java classes. The default is "jaxws". The "simple" frontend is also supported.
configurationLocationstring
no
initializeStaticBusInstance boolean
no
The location of a CXF configuration file, if any needs to be supplied. true
Initialize the static CXF Bus with a Bus configured to use Mule for all transports. This will affect any CXF generated clients that you run standalone. Defaults to true.
Default
Description
Inbound Endpoint Attributes of
Name
Type
Required
frontend
jaxws/simple
no
Document generated by Confluence on Mar 11, 2009 14:57
The CXF frontend that is used to build an internal service
Page 27
representation from your Java classes. The default is "jaxws". The "simple" frontend is also supported. bindingUri
string
no
The binding that should be used for this service. It defaults to the SOAP binding by default.
endpointName
string
no
The WSDL endpoint name of your service.
serviceClass
string
no
The class CXF should use to construct its service model. This is optional, and by default it will use the implementation class of your component.
serviceName
string
no
The WSDL service name of your service.
applyFiltersToProtocolboolean
no
Whether to apply the filters to the protocol endpoint.
applySecurityToProtocol boolean
no
Whether to apply the security filter to the protocol endpoint.
proxy
boolean
no
Whether or not this outbound endpoint is acting as a web service proxy. If so, it will expect raw xml as the input parameter and return an XML stream as the output.
mtomEnabled
boolean
no
Whether or not MTOM (attachment support) is enabled for this endpoint.
wsdlLocation
string
no
The location of the WSDL for your
Document generated by Confluence on Mar 11, 2009 14:57
Page 28
service. If this is a server side endpoint it will served to your users. protocolConnector
string
applyTransformersToProtocol boolean
no
The name of the connector that you wish to use to send/receive messages on with CXF. (As of 2.1)
no
Whether to apply the transformers to the protocol endpoint. Defaults to true for Mule 2.2+ and false for 2.1 and previous versions.
The element also supports the common CXF endpoint elements.
Outbound Endpoint Attributes of
Name
Type
Required
wsdlPort
string
no
The WSDL port you want to use to communicate with the service.
clientClass
string
no
The name of the client class that CXF generated using CXF's wsdl2java tool. You must use wsdl2java if you do not have both the client and the server in the same JVM. Otherwise, this can be optional if the endpoint address is the same in both cases.
operation
string
no
The operation you want to invoke on the outbound endpoint.
proxy
boolean
no
Whether or not this outbound endpoint is acting
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 29
as a web service proxy. If so, it will expect raw xml as the input parameter and return an XML stream as the output. mtomEnabled
boolean
no
Whether or not MTOM (attachment support) is enabled for this endpoint.
wsdlLocation
string
no
The location of the WSDL for your service. If this is a server side endpoint it will served to your users.
protocolConnector
string
no
The name of the connector that you wish to use to send/receive messages on with CXF. (As of 2.1)
no
Whether to apply the transformers to the protocol endpoint. Defaults to true for Mule 2.2+ and false for 2.1 and previous versions.
applyTransformersToProtocol boolean
The element also supports the common CXF endpoint elements.
Endpoint Attributes of <endpoint...>
Name
Type
Required
frontend
jaxws/simple
no
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description The CXF frontend that is used to build an internal service representation from your Java classes. The default is "jaxws". The "simple" frontend is also supported.
Page 30
bindingUri
string
no
The binding that should be used for this service. It defaults to the SOAP binding by default.
endpointName
string
no
The WSDL endpoint name of your service.
serviceClass
string
no
The class CXF should use to construct its service model. This is optional, and by default it will use the implementation class of your component.
serviceName
string
no
The WSDL service name of your service.
applyFiltersToProtocolboolean
no
Whether to apply the filters to the protocol endpoint.
applySecurityToProtocol boolean
no
Whether to apply the security filter to the protocol endpoint.
wsdlPort
string
no
The WSDL port you want to use to communicate with the service.
clientClass
string
no
The name of the client class that CXF generated using CXF's wsdl2java tool. You must use wsdl2java if you do not have both the client and the server in the same JVM. Otherwise, this can be optional if the endpoint address is the same in both cases.
operation
string
no
The operation you want to invoke on the outbound endpoint.
Document generated by Confluence on Mar 11, 2009 14:57
Page 31
proxy
boolean
no
Whether or not this outbound endpoint is acting as a web service proxy. If so, it will expect raw xml as the input parameter and return an XML stream as the output.
mtomEnabled
boolean
no
Whether or not MTOM (attachment support) is enabled for this endpoint.
wsdlLocation
string
no
The location of the WSDL for your service. If this is a server side endpoint it will served to your users.
protocolConnector
string
no
The name of the connector that you wish to use to send/receive messages on with CXF. (As of 2.1)
no
Whether to apply the transformers to the protocol endpoint. Defaults to true for Mule 2.2+ and false for 2.1 and previous versions.
applyTransformersToProtocol boolean
The <endpoint> element also supports the common CXF endpoint elements.
Common CXF Endpoint Elements Following are the sub-elements you can set on CXF endpoints. For further information on CXF interceptors, see the CXF documentation.
Name
Description
databinding
The databinding implementation that should be used. By default, this is JAXB for the JAX-WS frontend and Aegis for the simple frontend. This should be specified in the form of a Spring bean.
features
Any CXF features you want to apply to the client/ server. See the CXF documentation for more information on features.
Document generated by Confluence on Mar 11, 2009 14:57
Page 32
inInterceptors
Additional incoming interceptors for this service.
inFaultInterceptors
Additional incoming fault interceptors.
outInterceptors
Additional outgoing interceptors.
outFaultInterceptors
Additional outgoing fault interceptors.
Wrapper Component The WebServiceWrapperComponent class allows you to send the result of a web service call to another endpoint.
Attributes of <wrapper-component...>
Name
Type
Required
Default
Description
address
string
no
The URL of the web service.
addressFromMessageboolean
no
Specifies that the URL of the web service will be obtained from the message itself.
wsdlPort
string
no
The WSDL port you want to use to communicate to the service.
operation
string
no
The operation you want to invoke on the outbound endpoint.
Stax Attributes of <stax...>
Name
Type
Required
xmlInputFactory
string
no
xmlOutputFactory
string
no
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 33
Enabling WS-Addressing This page last changed on Nov 04, 2008 by [email protected].
Enabling WS-Addressing To enable your services to use WS-Addressing, you must configure the CXF endpoint to use the WSAdressing feature:
<wsa:addressing />
This works with outbound endpoints as well:
<wsa:addressing />
Note that currently "decoupled" reply to endpoints are not supported with Mule.
Manipulating WS-Addressing Headers To manipulate the WS-Addressing headers inside the messages, you can write a JAX-WS handler or a CXF interceptor. For a quick start, see the WS-Addressing sample inside the CXF distribution.
Document generated by Confluence on Mar 11, 2009 14:57
Page 34
Enabling WS-Security This page last changed on Feb 09, 2009 by jackie.wheeler.
Enabling WS-Security [ UsernameToken Scenario ] [ Server Configuration ] [ Client Configuration ] [ Configure the CXF Client to Use WS-Security ] [ Client Password Callback ] [ UsernameToken verification with the Mule SecurityManager ] This page describes how to configure a client and service to use WS-Security. You should already have a basic client and server running. For further information on how to configure WS-Security with CXF, you should consult the CXF documentation which goes into more detail on how to configure the CXF service interceptors.
UsernameToken Scenario The UsernameToken feature in WS-Security is an interoperable way to exchange security tokens inside a SOAP message. The following section describes how to configure the client and server to exchange a username/password security token.
Server Configuration On the server side, you do the following: • Create a Mule service for your component implementation • Configure the WSS4JInInterceptor and the SAAJInInterceptor. The former is responsible for checking the security of your message. • Write a server PasswordCallback that verifies the password. You configure the server in the Mule configuration file. Following is an example:
<service name="greeterService"> <spring:bean class="org.apache.cxf.binding.soap.saaj.SAAJInInterceptor" /> <spring:bean class="org.apache.cxf.ws.security.wss4j.WSS4JInInterceptor"> <spring:constructor-arg> <spring:map> <spring:entry key="action" value="UsernameToken" /> <spring:entry key="passwordCallbackRef" value-ref="serverCallback" /> <singleton-object class="org.apache.hello_world_soap_http.GreeterImpl" />
The element configures the incoming interceptors on the service. The WSS4JInInterceptor performs the security operations on the incoming SOAP message. The "action" parameter controls which actions it performs on the incoming message - in this case the "UsernameToken" action specifies that it will verify the username token via a specified password callback. The password callback is specified by the "passwordCallbackRef" property, which is detailed in the next
Document generated by Confluence on Mar 11, 2009 14:57
Page 35
section. The SAAJInInterceptor is also installed here. It enables the use of SAAJ, an in-memory DOM document format, which is required by WSS4J. Server callbacks verify passwords by supplying the password with which the incoming password will be compared.
import java.io.IOException; import javax.security.auth.callback.Callback; import javax.security.auth.callback.CallbackHandler; import javax.security.auth.callback.UnsupportedCallbackException; import org.apache.ws.security.WSPasswordCallback; public class ServerPasswordCallback implements CallbackHandler { public void handle(Callback[] callbacks) throws IOException, UnsupportedCallbackException { WSPasswordCallback pc = (WSPasswordCallback) callbacks[0]; if (pc.getIdentifer().equals("joe")) { // set the password on the callback. This will be compared to the // password which was sent from the client. pc.setPassword("password"); } } }
This allows you to write custom code which can load and compare passwords from custom backends, such as databases or LDAP.
Client Configuration On the client side, you do the following: • Set up the CXF outbound endpoint • Configure the CXF client so that it uses ws-security • Set up a ClientPasswordCallback that supplies the password for the invocation Following is a simple example that configures a CXF outbound endpoint:
<spring:bean class="org.apache.cxf.binding.soap.saaj.SAAJOutInterceptor" /> <spring:bean class="org.apache.cxf.ws.security.wss4j.WSS4JOutInterceptor"> <spring:constructor-arg> <spring:map> <spring:entry key="action" value="UsernameToken" /> <spring:entry key="user" value="joe" /> <spring:entry key="passwordType" value="PasswordDigest" /> <spring:entry key="passwordCallbackRef" value-ref="clientCallback" />
Document generated by Confluence on Mar 11, 2009 14:57
Page 36
Configure the CXF Client to Use WS-Security To use WS-Security, you add a configuration section to your "my-cxf-config.xml" file. Note: if your client and your server are on separate machines, you create two separate files and then a CXF connector configuration on each one.
<jaxws:client name="{http://apache.org/hello_world_soap_http}SoapPort" createdFromAPI="true"> <jaxws:outInterceptors> <map> <entry key="action" value="UsernameToken" /> <entry key="user" value="joe" /> <entry key="passwordType" value="PasswordDigest" /> <entry key="passwordCallbackRef" value-ref="clientCallback" />
The above configuration specifies the following: • • • •
CXF should invoke the UsernameToken action. The user name is "joe" Send the password in digest form. Use the "clientCallback" bean to supply the password. (see below)
Client Password Callback Following is a simple example client password callback that sets the password to use for the outgoing invocation:
import java.io.IOException; import javax.security.auth.callback.Callback; import javax.security.auth.callback.CallbackHandler; import javax.security.auth.callback.UnsupportedCallbackException; import org.apache.ws.security.WSPasswordCallback; public class ClientPasswordCallback implements CallbackHandler { public void handle(Callback[] callbacks) throws IOException, UnsupportedCallbackException { WSPasswordCallback pc = (WSPasswordCallback) callbacks[0]; // set the password for our message. pc.setPassword("yourpassword"); }
Document generated by Confluence on Mar 11, 2009 14:57
Page 37
}
UsernameToken verification with the Mule SecurityManager If you're using the Mule security manager, you can set up WSS4J to verify passwords with it. This allows you to easily integrate your own authentication mechanisms or use Mule's support for Spring Security. First, you'll want to set up your security manager:
<mule-ss:security-manager> <mule-ss:delegate-security-provider name="memory-dao" delegate-ref="authenticationManager"/> <spring:beans> <ss:authentication-manager alias="authenticationManager"/> <ss:authentication-provider> <ss:user-service id="userService"> <ss:user name="joe" password="password" authorities="ROLE_ADMIN" /> <ss:user name="anon" password="anon" authorities="ROLE_ANON" />
Next, you'll want to create a element. This callback is responsible for bridging together the Mule security manager and WSS4J.
<spring:beans> ...
Finally, you'll want to set up your server side WSS4J handlers to use this callback:
<spring:bean class="org.apache.cxf.binding.soap.saaj.SAAJInInterceptor" /> <spring:bean class="org.apache.cxf.ws.security.wss4j.WSS4JInInterceptor"> <spring:constructor-arg> <spring:map> <spring:entry key="action" value="UsernameToken" /> <spring:entry key="passwordCallbackRef" value-ref="serverCallback" />
In this example, the CXF inbound-endpoint creates a WSS4JInInterceptor which performs UsernameToken verification of the message. Once it reads in the username/password, it will perform a callback to the Mule security manager using the .
Document generated by Confluence on Mar 11, 2009 14:57
Page 38
On the client side, you'll want to use plaintext passwords for this to work. To do this, set the "passwordType" property on the WSS4JOutInterceptor to "PasswordText".
Document generated by Confluence on Mar 11, 2009 14:57
Page 39
Supported Web Service Standards This page last changed on Dec 16, 2008 by jackie.wheeler.
Web Service Standards The CXF transport supports a variety of web service standards. • • • • • • • • • •
SOAP 1.1 and 1.2 WSDL 1.1 WS Addressing WS Security 1.1 WS Policy WS-I BasicProfile 1.1 WS-I SecurityProfile SAML 1.0 (with WS-Security) MTOM SOAP with attachments
Future versions of Mule may support WS-ReliableMessaging. Although CXF currently supports it, it is not easy to support "decoupled" WS-RM over non-native CXF transports, so it does not work well with Mule transports. One-way channels might work but are currently untested.
Future Releases In version 2.2, the CXF transport is slated to support the following additional standards: • • • •
WS-Trust WS-SecureConversation WS-SecurityPolicy WS-Security
Document generated by Confluence on Mar 11, 2009 14:57
Page 40
Using a Web Service Client as an Outbound Endpoint This page last changed on Oct 15, 2008 by jackie.wheeler.
Using a Web Service Client as an Outbound Endpoint You can use a CXF-generated client as an outbound endpoint. First, you generate a CXF client using the WSDL to Java tool from CXF or the Maven plugin. Next, you configure the client as an outbound endpoint using the following properties: • • • •
clientClass: The client class generated by CXF, which extends javax.xml.ws.Service. port: The WSDL port to use for communicating with the service wsdlLocation: The location of the WSDL for the service. CXF uses this to configure the client. operation: The operation name to invoke on the web service. The objects that you pass to the outbound router must match the signature of the method for this operation. If your method takes multiple parameters, they must be put in an Object[] array.
Following is a simple example:
<service name="csvPublisher">
Document generated by Confluence on Mar 11, 2009 14:57
Page 41
Using a Web Service Client Directly This page last changed on Oct 15, 2008 by jackie.wheeler.
Using a Web Service Client Directly This page describes how to use a standalone CXF-generated client with Mule. This approach is different from the outbound router approach, which is typically a more appropriate fit for most applications. There are two ways to use CXF clients. First, you can generate a client from WSDL using the CXF WSDL to Java tool. Second, if you've built your service via "code-first" methodologies, you can use the service interface to build a client proxy object. When using a CXF client, it automatically discovers the Mule instance (provided you're in the same JVM/ Classloader) and uses it for your transport. Therefore, if you've generated a client from WSDL, invoking a service over Mule can be as simple as the following:
HelloWorldService service = new HelloWorldService(); HelloWorld hello = service.getSoapPort(); // Possibly set an alternate request URL: // ((BindingProvider) greeter).getRequestContext().put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, "http://localhost:63081/greeter"); String sayHi = hello.sayHi();
Building a Client Proxy Following is an example of how to construct a client using the service that was developed in Building a CXF Web Service:
QName SERVICE_NAME = new QName("http://server.hw.demo/", "HelloWorld"); QName PORT_NAME = new QName("http://server.hw.demo/", "HelloWorldPort"); Service service = Service.create(SERVICE_NAME); // Endpoint Address String endpointAddress = http://localhost:63081/hello"; // Add a port to the Service service.addPort(PORT_NAME, SOAPBinding.SOAP11HTTP_BINDING, endpointAddress); HelloWorld hw = service.getPort(HelloWorld.class); System.out.println(hw.sayHi("World"));
Additional Resources • Developing a JAX-WS consumer • WSDL to Java • CXF Maven plugin
Document generated by Confluence on Mar 11, 2009 14:57
Page 42
Using HTTP GET Requests This page last changed on Feb 09, 2009 by [email protected].
Using HTTP GET Requests CXF has built-in support for understanding GET requests, which use the following format: http://host/service/OPERATION/PARAM_NAME/PARAM_VALUE
For example:
@WebService(endpointInterface = "org.mule.samples.echo.components.EchoService", serviceName = "echo") public class EchoComponent implements EchoService { public String echo(String string) { return string; } }
The above Echo service is hosted in Mule on the endpoint cxf:http://localhost:65081/services/EchoUMO, so you can access the service from a simple web browser by typing the following: http://localhost:65081/services/EchoUMO/echo/string/hello
This will send the value "hello" for the string parameter to the echo() method. Due to a bug in CXF, this is only supported with the JAX-WS frontend.
Document generated by Confluence on Mar 11, 2009 14:57
Page 43
Using MTOM This page last changed on Nov 25, 2008 by jackie.wheeler.
Using MTOM [ Writing an MTOM-enabled WSDL ] [ Generating Server Stubs and/or a Client ] [ Configuring the CXF Inbound Endpoint ] [ Configuring the CXF Outbound Endpoint ] This page describes the basics of how to use MTOM inside your service. For more information, go to the MTOM documentation for CXF. Portions of the examples on this page are from that guide. For a WSDL-first service, the general process is as follows: 1. Write your WSDL 2. Generate your server stubs 3. Configure the CXF endpoint in Mule
Writing an MTOM-enabled WSDL To get started, write a WSDL like you would normally. Use xsd:base64Binary schema types to represent any binary data that you want to send. Normally, when creating XML schema types for binary data, you would write a schema type like this:
<element name="yourData" type="xsd:base64Binary"/>
To tell CXF to treat this binary type as an attachment, you must add an xmime:expectedContentTypes attribute to it:
<schema targetNamespace="http://mediStor.org/types/" xmlns="http://www.w3.org/2001/XMLSchema" xmlns:xmime="http://www.w3.org/2005/05/xmlmime"> <element name="yourData" type="xsd:base64Binary" xmime:expectedContentTypes="application/octet-stream"/> ...
Generating Server Stubs and/or a Client After writing your WSDL, you run wsdl2java on it to generate server stubs and a client (if you are creating outbound endpoints). To do this, download the CXF distribution, extract it, and then enter the following command:
$ ./apache-cxf-2.1.2-incubator/bin/wsdl2java -d outputDirectory path/to/your.wsdl
Configuring the CXF Inbound Endpoint The above command generates a server stub interface. This is the interface that your service must implement. Each method will correspond to an operation in your WSDL. If the base64Binary type is an argument to one of your operations, CXF will generate a method like this:
Document generated by Confluence on Mar 11, 2009 14:57
Page 44
public void yourOperation(DataHandler handler) { ... }
You can use this DataHandler method to access the attachment data by calling "handler.getInputStream();". When you configure the endpoint, set the mtomEnabled attribute to true to enable MTOM:
<service name="mtomService"> <singleton-object class="org.mule.transport.cxf.testmodels.TestMtomImpl" />
Configuring the CXF Outbound Endpoint The configuration of an MTOM client endpoint is exactly like the configuration of a normal CXF outbound endpoint, except that you must specify the mtomEnabled attribute. For example:
See the Using a Web Service Client as an Outbound Endpoint page for more information.
Document generated by Confluence on Mar 11, 2009 14:57
Page 45
EJB Transport This page last changed on Feb 20, 2009 by jackie.wheeler.
EJB Transport The EJB transport allows EJB session beans to be invoked as part of an event flow. Components can be given an EJB outbound endpoint, which will invoke the remote object and optionally return a result. The Javadoc for this transport can be found here .
Connector The Mule EJB Connector provides connectivity for EJB beans.
Attributes of
Name
Type
Required
Default
Description
pollingFrequency
long
no
Period (ms) between polling connections.
securityManagerref
name (no spaces)
no
Bean reference to the security manager that should be used.
securityPolicy
string
no
The security policy (file name) used to enable connections.
serverClassName
name (no spaces)
no
The target class name.
serverCodebase
string
no
The target method.
For example:
<ejb:connector name="ejb" jndiContext-ref="jndiContext" securityPolicy="rmi.policy" />
Using the EJB Connector EJB endpoints are configured the same way as RMI endpoints. Note that only outbound endpoints can use the EJB transport. For a given endpoint, you must provide the following information: • • • •
registry host registry port remote home name remote method name
These values will be used to establish the dispatcher connection. For example:
Document generated by Confluence on Mar 11, 2009 14:57
Page 46
<ejb:endpoint host="localhost" port="1099" object="SomeService" method="remoteMethod"/>
Alternatively, you could use URI-based configuration:
If the method can take one or more input arguments, you configure their types as a comma-separated list using the methodArgumentTypes attribute. Multiple arguments are passed in as an array of objects as the payload of the Mule message.
Transformers There are no specific transformers required for EJB.
Document generated by Confluence on Mar 11, 2009 14:57
Page 47
Email Transport This page last changed on Feb 20, 2009 by jackie.wheeler.
Email Transport The Email transport provides a standard email connector that is extended by each of the email protocols.
Protocols Each email protocol has a dedicated transport and configuration schema. The transports can be used to connect to POP3 and IMAP mailboxes and for sending messages over SMTP using the javax.mail API. For each of the protocols, SSL is supported and is enabled using POP3S, IMAPS, and SMTPS. The email transports support protocol features such as attachments, replyTo, CC and BCC addresses, binary content types, and custom headers. Each email transport supports the following attributes for connecting to the mail server:
Attribute
Description
user
The user name for connecting to the mail server
password
The password for connecting to the mail server
host
The host of the mail server
port
The port of the mail server
The Javadoc for the email transports can be found here . For information about configuring specific endpoints, see the following links: • SMTP and SMTPS Transport • POP3 and POP3S Transport • IMAP and IMAPS Transport
Filters Filters can be set on an endpoint to filter out any unwanted messages. The Email transport provides a couple of filters that can either be used directly or extended to implement custom filtering rules.
Filter
Description
org.mule.transport.email.filters.AbstractMailFilter
A base filter implementation that must be extended by any other mail filter.
org.mule.transport.email.filters.MailSubjectRegExFilter Applies a regular expression to a Mail Message subject. For more information on filters, see Using Filters.
Transformers These are transformers specific to this transport. Note that these are added automatically to the Mule registry at start up. When doing automatic transformations these will be included when searching for the correct
Document generated by Confluence on Mar 11, 2009 14:57
Page 48
transformers.
Name
Description
email-to-string-transformer
Converts an email message to string format.
string-to-email-transformer
Converts a string message to email format.
object-to-mime-transformer
Converts an object to MIME format.
mime-to-bytes-transformer
Converts a MIME message to a byte array.
bytes-to-mime-transformer
Converts a byte array message to MIME format.
Document generated by Confluence on Mar 11, 2009 14:57
Page 49
File Transport This page last changed on Mar 04, 2009 by jackie.wheeler.
File Transport [ Connector ] [ Endpoint ] [ Inbound Endpoint ] [ Outbound Endpoint ] [ File To Byte Array Transformer ] [ File To String Transformer ] [ Legacy Filename Parser ] [ Expression Filename Parser ] [ Custom Filename Parser ] [ Abstract Filenameparser ] [ Expressing File Endpoints ] The File transport allows files to be read and written to and from directories on the local file system. The connector can be configured to filter the file it reads and the way files are written, such as whether the output will be placed in a new file or if it should be appended.
Connector The File connector configures the default behavior for File endpoints that reference the connector. If there is only one File connector configured, all file endpoints will use that connector.
Attributes of
Name
Type
Required
writeToDirectory
string
no
The directory path where the file should be written on dispatch. This path is usually set as the endpoint of the dispatch event, however this allows you to explicitly force a single directory for the connector.
readFromDirectory
string
no
The directory path where the file should be read from. This path is usually set as the inbound endpoint, however this allows you to explicitly force a single directory for the connector.
autoDelete
boolean
no
Document generated by Confluence on Mar 11, 2009 14:57
Default
true
Description
If set to true (the default), it will cause the file to be deleted once it is read. If streaming is turned on, this occurs when the InputStream for the file is closed. Otherwise the
Page 50
file will be read into memory and deleted immediately. To access the java.io.File object set this property to false and specify a NoActionTransformer transformer for the connector. Mule will not delete the file, so it is up to the component to delete it when it is done. If the moveToDirectory is set, the file is first moved, then the File object of the moved file is passed to the component. It is recommended that a moveToDirectory is specified when turning autoDelete off. outputAppend
boolean
no
serialiseObjects
boolean
no
streaming
boolean
no
pollingFrequency
long
no
Document generated by Confluence on Mar 11, 2009 14:57
false
Whether the output should be appended to the existing file. Default is false. Determines whether objects should be serialized to the file. If false (the default), the raw bytes or text is written.
true
Whether a FileInputStream should be sent as the message payload (if true) or a file (if false). The default is true. The frequency in milliseconds that the read directory should be checked (default is 0). Note that the read directory is specified by
Page 51
the endpoint of the listening component. fileAge
long
no
Miniumum age (ms) for a file to be processed. This can be useful when consuming large files. It tells Mule to wait for a period of time before consuming the file, allowing the file to be completely written before the file is processed.
moveToPattern
string
no
The pattern to use when moving a read file to a new location determined by the moveToDirectory property. This can use the patterns supported by the filename parser configured for this connector.
moveToDirectory
string
no
The directory path where the file should be written after it has been read. If this is not set, the file is deleted after it has been read.
comparator
class name
no
Sorts incoming files using the specified comparator, such as comparator="org.mule.transpor The class must implement the java.util.Comparator interface.
reverseOrder
boolean
no
Whether the comparator order should be reversed. Default is false.
outputPattern
string
no
The pattern to use when writing a file to disk. This can use the patterns supported by the filename parser
Document generated by Confluence on Mar 11, 2009 14:57
Page 52
configured for this connector.
Child Elements of
Name
Cardinality
Description
abstract-filenameParser
0..1
The abstract-filenameParser element is a placeholder for filename parser elements. The filename parser is set on the connector used when writing files to a directory. The parser will convert the outputPattern attribute to a string using the parser and the current message. The default implmentation used is legacy-filename-parser, but you can specify expressionfilename-parser or customfilename-parser.
Endpoint Attributes of <endpoint...>
Name
Type
Required
path
string
no
A file directory location.
pollingFrequency
long
no
The frequency in milliseconds that the read directory should be checked (default is 0). Note that the read directory is specified by the endpoint of the listening component.
fileAge
long
no
Miniumum age (ms) for a file to be processed. This can be useful when consuming large files. It tells Mule to wait for a period of time before consuming the file, allowing the file to be completely written before the file is processed.
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 53
moveToPattern
string
no
The pattern to use when moving a read file to a new location determined by the moveToDirectory property. This can use the patterns supported by the filename parser configured for this connector.
moveToDirectory
string
no
The directory path where the file should be written after it has been read. If this is not set, the file is deleted after it has been read.
comparator
class name
no
Sorts incoming files using the specified comparator, such as comparator="org.mule.transpor The class must implement the java.util.Comparator interface.
reverseOrder
boolean
no
Whether the comparator order should be reversed. Default is false.
outputPattern
string
no
The pattern to use when writing a file to disk. This can use the patterns supported by the filename parser configured for this connector.
Inbound Endpoint Attributes of
Name
Type
Required
path
string
no
A file directory location.
pollingFrequency
long
no
The frequency in milliseconds that the read directory
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 54
should be checked (default is 0). Note that the read directory is specified by the endpoint of the listening component. fileAge
long
no
Miniumum age (ms) for a file to be processed. This can be useful when consuming large files. It tells Mule to wait for a period of time before consuming the file, allowing the file to be completely written before the file is processed.
moveToPattern
string
no
The pattern to use when moving a read file to a new location determined by the moveToDirectory property. This can use the patterns supported by the filename parser configured for this connector.
moveToDirectory
string
no
The directory path where the file should be written after it has been read. If this is not set, the file is deleted after it has been read.
comparator
class name
no
Sorts incoming files using the specified comparator, such as comparator="org.mule.transpor The class must implement the java.util.Comparator interface.
reverseOrder
boolean
no
Whether the comparator order should be reversed. Default is false.
Document generated by Confluence on Mar 11, 2009 14:57
Page 55
Outbound Endpoint Attributes of
Name
Type
Required
Default
Description
path
string
no
A file directory location.
outputPattern
string
no
The pattern to use when writing a file to disk. This can use the patterns supported by the filename parser configured for this connector.
File To Byte Array Transformer The file-to-byte-array-transformer element configures a transformer that reads the contents of a java.io.File into a byte array (byte[]).
File To String Transformer The file-to-string-transformer element configures a transformer that reads the contents of a java.io.File into a java.lang.String.
Legacy Filename Parser The legacy-filename-parser element configures the default filename parser used by the File connector. It understands the following patterns: • • • • • •
#[DATE] - The current date in the format dd-MM-yy_HH-mm-ss.SS #[DATE:dd-MM-yy] - The current date using the specified format #[SYSTIME] - The current system time milliseconds #[UUID] - A generated universally unique ID #[ORIGINALNAME] - The original file name if the file being written was read from another location #[COUNT] - An incremental counter.
Expression Filename Parser The expression-filename-parser element configures the ExpressionFilenameParser, which can use any expression language supported by Mule to construct a file name for the current message. Expressions can be xpath, xquery, ognl, mvel, header, function, and more. For example, an XPath expression can be defined to pull a message ID out of an XML message and use that as the file name as follows: #[xpath:/message/header/@id]
Following is an example of using the parser:
Document generated by Confluence on Mar 11, 2009 14:57
Page 56
...
This parser supersedes from previous releases of Mule. The following demonstrates how to achieve the same results when using <expression-filename-parser> over . #[DATE] : #[function:dateStamp] #[DATE:dd-MM-yy] : #[function:dateStamp:dd-MM-yy] #[SYSTIME] : #[function:systime] #[UUID] : #[function:uuid] #[ORIGINALNAME] : #[header:originalFilename] #[COUNT] : #[function:counter] - note that this is a global counter. If you want a local counter per file connector then you should use the legacy-filename-parser. • #[message property name] : #[header:message property name] • • • • • •
Custom Filename Parser The custom-filename-parser element allows the user to specify a custom filename parser. The implementation must implement org.mule.transport.file.FilenameParser.
Attributes of <custom-filename-parser...>
Name
Type
Required
class
name (no spaces)
no
Default
Description
The implementation class name that implements org.mule.transport.file.Filename
Abstract Filenameparser The abstract-filenameParser element is a placeholder for filename parser elements. The filename parser is set on the connector used when writing files to a directory. The parser will convert the outputPattern attribute to a string using the parser and the current message. The default implmentation used is legacyfilename-parser, but you can specify expression-filename-parser or custom-filename-parser.
Expressing File Endpoints File endpoints can be expressed using standard File URI syntax: file://<path>[MULE:?params]
For example, to connect to a directory called /temp/files Unix file:///temp/files
Note the extra slash to denote a path from the root (absolute path). Windows file:///C:/temp/files
The Unix style will still work in Windows if you map to a single drive (the one Mule was started from).
Document generated by Confluence on Mar 11, 2009 14:57
Page 57
To specify a relative path use: file://./temp
or file://temp
Note only two slashes are used for the protocol, so it's a relative path. or file://?address=./temp
To connect to a windows network drive: file:////192.168.0.1/temp/
Document generated by Confluence on Mar 11, 2009 14:57
Page 58
FTP Transport This page last changed on Mar 04, 2009 by jackie.wheeler.
FTP Transport Table of Contents Click here to expand... • FTP Transport ° Connector • ° - Attributes of - Child Elements of ° ° ° ° ° ° ° ° °
Mule Enterprise Connector Attributes Endpoint - Attributes of <endpoint...> Inbound Endpoint - Attributes of Outbound Endpoint - Attributes of Generic FTP Endpoints Filename Filters - Property Overrides
The FTP transport provides connectivity to FTP servers to allow files to be read and written as messages in Mule.
Connector The FTP connector is used to configure the default behavior for FTP endpoints that reference the connector. If there is only one FTP connector configured, all FTP endpoints will use that connector.
Attributes of
Name
Type
Required
streaming
boolean
no
Whether an InputStream should be sent as the message payload (if true) or a byte array (if false). Default is false.
no
A class that extends FtpConnectionFactory. The FtpConnectionFactory is responsible for creating a connection to the server using the credentials provided by the endpoint.
connectionFactoryClass class name
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 59
The default implementation supplied with Mule uses the Commons Net project from Apache. pollingFrequency
long
no
How frequently in milliseconds to check the read directory. Note that the read directory is specified by the endpoint of the listening component.
outputPattern
string
no
The pattern to use when writing a file to disk. This can use the patterns supported by the filename-parser configured for this connector
binary
boolean
no
Select/disable binary file transfer type. Default is true.
passive
boolean
no
Select/disable passive protocol (more likely to work through firewalls). Default is true.
Child Elements of
Name
Cardinality
Description
file:abstract-filenameParser
0..1
The filenameParser is used when writing files to an FTP server. The parser will convert the outputPattern attribute to a string using the parser and the current message. To add a parser to your configuration, you import the "file" namespace into your XML configuration. For more information about filenameParsers, see the File Transport.
Mule Enterprise Connector Attributes The following additional attributes are available on the FTP connector in Mule Enterprise only (as of version 1.6):
Document generated by Confluence on Mar 11, 2009 14:57
Page 60
moveToDirectory
The directory path where the file should be written after it has been read. If this property is not set, the file is deleted.
moveToPattern
The pattern to use when moving a read file to a new location as specified by the moveToDirectory property. This property can use the patterns supported by the filenameParser configured for this connector.
fileAge
Does not process the file unless it's older than the specified age in milliseconds.
Endpoint Attributes of <endpoint...>
Name
Type
Required
path
string
no
A file location on the remote server.
user
string
no
If FTP is authenticated, this is the username used for authenitcation.
password
string
no
The password for the user being authenticated.
host
string
no
An IP address (such as www.mulesource.com, localhost, or 192.168.0.1).
port
port number
no
The port number to connect on.
binary
boolean
no
Select/disable binary file transfer type. Default is true.
passive
boolean
no
Select/disable passive protocol (more likely to work through firewalls). Default is true.
pollingFrequency
long
no
How frequently in milliseconds to check the read directory. Note that the read directory
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 61
is specified by the endpoint of the listening component. outputPattern
string
no
The pattern to use when writing a file to disk. This can use the patterns supported by the filename-parser configured for this connector
Inbound Endpoint Attributes of
Name
Type
Required
path
string
no
A file location on the remote server.
user
string
no
If FTP is authenticated, this is the username used for authenitcation.
password
string
no
The password for the user being authenticated.
host
string
no
An IP address (such as www.mulesource.com, localhost, or 192.168.0.1).
port
port number
no
The port number to connect on.
binary
boolean
no
Select/disable binary file transfer type. Default is true.
passive
boolean
no
Select/disable passive protocol (more likely to work through firewalls). Default is true.
pollingFrequency
long
no
How frequently in milliseconds to check the read directory. Note that the read directory is specified by
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 62
the endpoint of the listening component.
Outbound Endpoint Attributes of
Name
Type
Required
Default
Description
path
string
no
A file location on the remote server.
user
string
no
If FTP is authenticated, this is the username used for authenitcation.
password
string
no
The password for the user being authenticated.
host
string
no
An IP address (such as www.mulesource.com, localhost, or 192.168.0.1).
port
port number
no
The port number to connect on.
binary
boolean
no
Select/disable binary file transfer type. Default is true.
passive
boolean
no
Select/disable passive protocol (more likely to work through firewalls). Default is true.
outputPattern
string
no
The pattern to use when writing a file to disk. This can use the patterns supported by the filename-parser configured for this connector
Generic FTP Endpoints FTP endpoints can be expressed using standard FTP URI syntax: ftp://<username>:<password>@/[MULE:address]
which would render a URI like this:
Document generated by Confluence on Mar 11, 2009 14:57
Page 63
ftp://joe:[email protected]/~
This URI would connect to the FTP server at mycompany.com with a user name of joe with password 123456 and would work on Joe's home directory. Escape Your Credentials If you use a URI-style endpoint and you include the user name and password, escape any characters that are illegal for URIs, such as the @ character. For example, if the user name is [email protected], you should enter it as user%40myco.com.
Filename Filters Filters can be set on the endpoint to control which files are received by the endpoint. The filters are expressed in a comma-separated list. To set up a filter to only read .XML and .TXT files, you would use the following code:
Property Overrides You can override certain properties when defining FTP endpoints to control the endpoint's configuration. These properties can be set on the endpoint or the current message (see the appropriate endpoint attributes). For example, to set the output pattern:
Or to specify the same endpoint using a URI: ftp://joe:[email protected]/ftp/done?outputPattern=FtpFile-${DATE}.done
For more information about configuring endpoints, see Configuring Endpoints.
Document generated by Confluence on Mar 11, 2009 14:57
Page 64
HTTPS Transport This page last changed on Sep 19, 2008 by jackie.wheeler.
HTTPS Transport [ HTTPS Connector ] [ Polling Connector ] [ HTTPS Endpoints ] The Secure HTTP transport provides support for exposing services over HTTP and making HTTP client requests from Mule services to external services as part of service event flows. Mule supports secure inbound, secure outbound, and secure polling HTTP endpoints. These endpoints support all common features of the HTTP spec, such as ETag processing, cookies, and keepalive. Both HTTP 1.0 and 1.1 are supported.
HTTPS Connector This connector provides Secure HTTP connectivity on top of what is already provided with the Mule HTTP Transport. Secure connections are made on behalf of an entity, which can be anonymous or identified by a certificate. The key store provides the certificates and associated private keys necessary for identifying the entity making the connection. Additionally, connections are made to trusted systems. The public certificates of trusted systems are stored in a trust store, which is used to verify that the connection made to a remote system matches the expected identity.
Property
Description
tls-client
Configures the client key store with the following attributes: • path: The location (which will be resolved relative to the current classpath and file system, if possible) of the keystore that contains public certificates and private keys for identification • storePassword: The password used to protect the keystore • class: The type of keystore used (a Java class name)
tls-key-store
Configures the direct key store with the following attributes: • path: The location (which will be resolved relative to the current classpath and file system, if possible) of the keystore that contains public certificates and private keys for identification • class: The type of keystore used (a Java class name) • keyPassword: The password used to protect the private key • storePassword: The password used to protect the keystore • algorithm: The algorithm used by the keystore
tls-server
Configures the trust store. The attributes are: • path: The location (which will be resolved relative to the current classpath and file
Document generated by Confluence on Mar 11, 2009 14:57
Page 65
• • • • • •
tls-protocol-handler
system, if possible) of the trust store that contains public certificates of trusted servers storePassword: The password used to protect the trust store class: The type of trust store used (a Java class name) algorithm: The algorithm used by the trust store factory-ref: Reference to the trust manager factory explicitOnly: Whether this is an explicit trust store requireClientAuthentication: Whether client authentication is required
Configures the global Java protocol handler. It has one attribute, property, which specifies the java.protocol.handler.pkgs system property.
For example:
Polling Connector The polling connector allows Mule to poll an external HTTP server and generate events from the result. This is useful for pull-only web services. This connector provides a secure version of the PollingHttpConnector. It includes all the properties of the HTTPS connector plus the following optional attributes:
Attribute
Description
pollingFrequency
The time in milliseconds to wait between each request to the remote http server.
checkEtag
Whether the ETag header from the remote server is processed if the header is present.
discardEmptyContent
Whether Mule should discard any messages from the remote server that have a zero content length. For many services, a zero length would mean there was no data to return. If the remote HTTP server does return content to say that the request is empty, users can configure a content filter on the endpoint to filter these messages out.
For example:
Document generated by Confluence on Mar 11, 2009 14:57
Page 66
HTTPS Endpoints An inbound HTTPS endpoint exposes a service securely over HTTPS, essentially making it an HTTP server. If polling of a remote HTTP service is required, this endpoint should be configured with a polling HTTPS connector. An outbound HTTPS endpoint allows Mule to send requests securely using SSL to external servers or Mule inbound HTTP endpoints using HTTP over SSL protocol. A global HTTPS endpoint can be referenced by services. Services can augment the configuration defined in the global endpoint with local configuration elements. For more information on configuring HTTP endpoints, see HTTP Transport.
Document generated by Confluence on Mar 11, 2009 14:57
Page 67
HTTP Transport This page last changed on Feb 20, 2009 by jackie.wheeler.
HTTP Transport Table of Contents Click here to expand... • HTTP Transport ° Connector • ° - Attributes of ° Inbound Endpoint ° - Attributes of ° Outbound Endpoint ° - Attributes of ° Endpoint ° - Attributes of <endpoint...> ° Transformers ° Polling Connector ° - Attributes of <polling-connector...> ° Rest Service Component ° - Attributes of - Child Elements of ° Security ° - Sending Credentials ° Cookies ° Polling HTTP Services ° Handling HTTP Content-Type and Encoding ° - Sending HTTP - Receiving HTTP ° Including Custom Header Properties ° Handling Redirects ° Getting a Hash Map of Properties The HTTP transport provides support for exposing services over HTTP and making HTTP client requests from Mule services to external services as part of service event flows. Mule supports inbound, outbound, and polling HTTP endpooints. These endpoints support all common features of the HTTP spec, such as ETag processing, cookies, and keepalive. Both HTTP 1.0 and 1.1 are supported.
Connector Allows Mule to communicate over HTTP. All parts of the HTTP spec are covered by Mule, so you can expect ETags to be honored as well as keep alive semantics and cookies.
Attributes of
Name
Type
Required
cookieSpec
netscape/rfc2109
no
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description The cookie specification to be used by this connector when cookies are enabled.
Page 68
proxyHostname
string
no
The proxy host name or address.
proxyPassword
string
no
The password to use for proxy access.
proxyPort
port number
no
The proxy port number.
proxyUsername
string
no
The username to use for proxy access.
enableCookies
boolean
no
Whether to support cookies.
Inbound Endpoint An inbound HTTP endpoint exposes a service over HTTP, essentially making it an HTTP server. If polling of a remote HTTP service is required, this endpoint should be configured with a polling HTTP connector.
Attributes of
Name
Type
Required
user
string
no
The user name (if any) that will be used to authenticate against.
password
string
no
The password for the user.
host
string
no
The host to connect to. For inbound endpoints, this should be an address of a local network interface.
port
port number
no
The port number to use when a connection is made.
path
string
no
The path for the HTTP URL.
contentType
string
no
The HTTP ContentType to use.
method
httpMethodTypes
no
The HTTP method to use.
keep-alive
boolean
no
Controls if the socket connection
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 69
is kept alive. If set to true, a keepalive header with the connection timeout specified in the connector will be returned. If set to false, a "Connection: close" header will be returned.
Outbound Endpoint The HTTP outbound endpoint allows Mule to send requests to external servers or Mule inbound HTTP endpoints using the HTTP protocol.
Attributes of
Name
Type
Required
user
string
no
The user name (if any) that will be used to authenticate against.
password
string
no
The password for the user.
host
string
no
The host to connect to. For inbound endpoints, this should be an address of a local network interface.
port
port number
no
The port number to use when a connection is made.
path
string
no
The path for the HTTP URL.
contentType
string
no
The HTTP ContentType to use.
method
httpMethodTypes
no
The HTTP method to use.
keep-alive
boolean
no
Controls if the socket connection is kept alive. If set to true, a keepalive header with the connection timeout specified in the connector
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 70
will be returned. If set to false, a "Connection: close" header will be returned.
Endpoint Configures a 'global' HTTP endpoint that can be referenced by services. Services can augment the configuration defined in the global endpoint with local configuration elements.
Attributes of <endpoint...>
Name
Type
Required
user
string
no
The user name (if any) that will be used to authenticate against.
password
string
no
The password for the user.
host
string
no
The host to connect to. For inbound endpoints, this should be an address of a local network interface.
port
port number
no
The port number to use when a connection is made.
path
string
no
The path for the HTTP URL.
contentType
string
no
The HTTP ContentType to use.
method
httpMethodTypes
no
The HTTP method to use.
keep-alive
boolean
no
Controls if the socket connection is kept alive. If set to true, a keepalive header with the connection timeout specified in the connector will be returned. If set to false, a "Connection: close" header will be returned.
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 71
Transformers These are transformers specific to this transport. Note that these are added automatically to the Mule registry at start up. When doing automatic transformations these will be included when searching for the correct transformers.
Name
Description
http-response-to-object-transformer
A transformer that converts an HTTP response to a Mule Message. The payload may be a String, stream, or byte array.
http-response-to-string-transformer
Converts an HTTP response payload into a string. The headers of the response will be preserved on the message.
object-to-http-request-transformer
This transformer will creat a valid HTTP request using the current message and any HTTP headers set on the current message.
message-to-http-response-transformer
This transformer will creat a valid HTTP response using the current message and any HTTP headers set on the current message.
Polling Connector Allows Mule to poll an external HTTP server and generate events from the result. This is useful for pullonly web services.
Attributes of <polling-connector...>
Name
Type
Required
cookieSpec
netscape/rfc2109
no
The cookie specification to be used by this connector when cookies are enabled.
proxyHostname
string
no
The proxy host name or address.
proxyPassword
string
no
The password to use for proxy access.
proxyPort
port number
no
The proxy port number.
proxyUsername
string
no
The username to use for proxy access.
enableCookies
boolean
no
Whether to support cookies.
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 72
pollingFrequency
long
no
The time in milliseconds to wait between each request to the remote HTTP server.
checkEtag
boolean
no
Whether the ETag header from the remote server is processed if the header is present.
discardEmptyContentboolean
no
Whether Mule should discard any messages from the remote server that have a zero content length. For many services a zero length would mean there was no data to return. If the remote HTTP server does return content to say that that the request is empty, users can configure a content filter on the endpoint to filter these messages out.
Rest Service Component Built-in RestServiceWrapper can be used to proxy REST style services as local Mule components.
Attributes of
Name
Type
Required
Default
Description
httpMethod
GET/POST
no
GET
The HTTP method to use when making the service request.
serviceUrl
no
Document generated by Confluence on Mar 11, 2009 14:57
The service URL to use when making the request. This should not contain any parameters, since these should be configured on the component. The service URL can contain Mule expressions, so
Page 73
the URL can be dynamic for each message request.
Child Elements of
Name
Cardinality
Description
error-filter
0..1
An error filter can be used to detect whether the response from the remote service resulted in an error.
payloadParameterName
0..*
If the payload of the message is to be attached as a URL parameter, this should be set to the parameter name. If the message payload is an array of objects that multiple parameters can be set to, use each element in the array.
requiredParameter
0..*
These are parameters that must be available on the current message for the request to be successful. The Key maps to the parameter name, the value can be any one of the valid expressions supported by Mule.
optionalParameter
0..*
These are parameters that if they are on the current message will be added to the request, otherwise they will be ignored. The Key maps to the parameter name, the value can be any one of the valid expressions supported by Mule.
Security You can use the HTTPS Transport to create secure connections over HTTP. If you want to secure requests to your HTTP endpoint, the HTTP connector supports HTTP Basic/Digest authentication methods (as well as the Mule generic header authentication). To configure HTTP Basic, you configure a Security Endpoint Filter on an HTTP endpoint.
You must configure the security manager on the Mule instance against which this security filter will authenticate. For information about security configuration options and examples, see Configuring Security. If you want to make an HTTP request that requires authentication, you can set the credentials on the endpoint:
Document generated by Confluence on Mar 11, 2009 14:57
Page 74
For general information about endpoint configuration, see Configuring Endpoints.
Sending Credentials If you want to make an HTTP request that requires authentication, you can set the credentials on the endpoint: http://user:[email protected]/secure
Cookies If you want to send cookies along on your outgoing request, simply configure them on the endpoint:
<properties> <spring:entry key="Content-Type" value="text/xml" /> <spring:entry key="cookies"> <spring:map> <spring:entry key="customCookie" value="yes" />
Polling HTTP Services The HTTP transport supports polling an HTTP URL, which is useful for grabbing periodic data from a page that changes or to invoke a REST service, such as polling an Amazon Queue. To configure the HTTP Polling receiver, you include an HTTP polling-connector configuration in your Mule configuration:
To use the connector in your endpoints, use:
Handling HTTP Content-Type and Encoding Sending HTTP The following behavior applies when sending POST request bodies as a client and when returning a response body:
Document generated by Confluence on Mar 11, 2009 14:57
Page 75
For a String, char[], Reader, or similar: • • • •
If the endpoint has encoding set explicitly, use that Otherwise, take it from the message's property Content-Type If none of these is set, use the Mule Context's configuration default. For Content-Type, send the message's property Content-Type but with the actual encoding set.
For binary content, encoding is not relevant. Content-Type is set as follows: • If the Content-Type property is set on the message, send that. • Send "application/octet-stream" as Content-Type if none is set on the message.
Receiving HTTP When receiving HTTP responses, the payload of the MuleMessage will always be the InputStream of the HTTP response.
Including Custom Header Properties When making a new HTTP client request, Mule filters out any existing HTTP request headers because they are often from a previous request. For example, if you have an HTTP endpoint that proxies another HTTP endpoint, you wouldn't want to copy the Content-Type header property from the first HTTP request to the second request. If you do want to include HTTP headers, you can specify them as properties on the outbound endpoint as follows:
<property key="Content-Type" value="image/png"/> <property key="Accept" value="*.*"/>
Handling Redirects To redirect an HTTP client, you must set two properties on the endpoint. First, set the http.status property to '307', which instructs the client that the resource has be temporarily redirected. Alternatively, you can set the property to '301' for a permanent redirect. Second, set the Location property, which specifies the location where you want to redirect your client. See the HTTP protocol specification for detailed information about status codes at http:// www.w3.org/Protocols/rfc2616/rfc2616-sec10.html. Following is an example of a service that is listening on the local address http://localhost:8080/ mine and will send a response with the redirection code, instructing the client to go to http:// mule.mulesource.org/.
<service name="redirecter"> <property key="http.status" value="307"/> <property key="Location" value="http://mule.mulesource.org/"/>
Document generated by Confluence on Mar 11, 2009 14:57
Page 76
Note that you must set the synchronous attribute to true. Otherwise, the service will be asynchronous, and a response will be immediately returned while the request is placed on an internal queue.
Getting a Hash Map of Properties You can use the custom transformer HttpRequestBodyToParamMap on your inbound endpoint to return the message properties as a hash map of name-value pairs. This transformer handles GET and POST with application/x-www-form-urlencoded content type. For example:
<custom-transformer name="myTransformer" class="org.mule.transport.http.transformers.HttpRequestBodyToParamMap" />
Document generated by Confluence on Mar 11, 2009 14:57
Page 77
IMAPS Transport This page last changed on Sep 19, 2008 by jackie.wheeler.
IMAPS Transport TLS/SSL connections are made on behalf of an entity, which can be anonymous or identified by a certificate. The key store provides the certificates and associated private keys necessary for identifying the entity making the connection. Additionally, connections are made to trusted systems. The public certificates of trusted systems are stored in a trust store, which is used to verify that the connection made to a remote system matches the expected identity. The IMAPS connector enables IMAP over SSL using the javax.mail APIs. It supports all the elements and attributes of the IMAP connector plus some required properties for setting up the client key store and the trust store for the SSL connection.
Property
Description
tls-client
Configures the client key store with the following attributes: • path: The location (which will be resolved relative to the current classpath and file system, if possible) of the keystore that contains public certificates and private keys for identification • storePassword: The password used to protect the keystore • class: The type of keystore used (a Java class name)
tls-trust-store
Configures the trust store. The attributes are: • path: The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store that contains public certificates of trusted servers • storePassword: The password used to protect the trust store
For example:
<model name="test"> <service name="relay"> ...
For information on configuring endpoints using the IMAPS connector, see IMAP Transport. The IMAPS transport supports the same filters and transformers as the Email Transport.
Document generated by Confluence on Mar 11, 2009 14:57
Page 78
IMAP Transport This page last changed on Nov 26, 2008 by jackie.wheeler.
IMAP Transport The IMAP transport can be used for receiving messages from IMAP inboxes using the javax.mail API. The IMAPS Transport uses secure connections over SSL/TLS. The IMAP transport uses the same filters and transformers as the Email Transport. The Javadoc for this provider can be found here .
IMAP Connector The IMAP connector supports all the common connector attributes and properties and the following additional attributes:
Attribute
Description
Default
Required
backupEnabled
Whether to save copies to the backup folder.
False
No
backupFolder
The folder where messages are moved for audit purposes after they have been read.
checkFrequency
Determines how often (in milliseconds) the IMAP mailbox is polled for new messages.
60000
Yes
mailboxFolder
The remote folder to check for email.
INBOX
No
deleteReadMessages
Whether to delete messages after they have been downloaded. If set to false, the messages are set to SEEN.
true
No
No
Endpoints IMAP and IMAPS endpoints include details about connecting to an IMAP mailbox. You configure the endpoints just as you would with any other transport, with the following additional attributes: • • • •
user: the user name of the mailbox owner password: the password of the user host: the IP address of the IMAP server, such as www.mulesource.com, localhost, or 127.0.0.1 port: the port number of the IMAP server. If not set for the IMAPS connector, the default port is 993.
For example:
or for IMAPS:
Document generated by Confluence on Mar 11, 2009 14:57
Page 79
This will log into the bob mailbox on localhost on port 65433 using password password and will check the mailbox for new messages every 30 seconds. You can also specify the endpoint settings using a URI, but the above syntax is easier to read. Escape Your Credentials If you use a URI-style endpoint and you include the user name and password, escape any characters that are illegal for URIs, such as the @ character. For example, if the user name is [email protected], you should enter it as user%40myco.com.
Document generated by Confluence on Mar 11, 2009 14:57
Page 80
JDBC Transport This page last changed on Feb 27, 2009 by jackie.wheeler.
JDBC Transport [ Introduction ] [ Features ] [ Transactions ] [ API Documentation and Notes ] [ Runnable Examples ] [ Performance Results ]
Introduction The JDBC Transport allows you to send and receive messages with a database using the JDBC protocol. Common usage includes retrieving, inserting, updating, and deleting database records, as well as invoking stored procedures (e.g., to create new tables dynamically). Some features are available only with the Mule Enterprise version of the JDBC transport, which is available with version 1.6 and later of Mule Enterprise Edition. These EE-only features are noted below.
Features The Mule Enterprise JDBC Transport provides key functionality, performance improvements, transformers, and examples not available in the Mule Community edition. The following table summarizes the feature differences.
Feature
Summary
Mule Community
Mule Enterprise
Inbound SELECT Queries
Retrieve records using the SQL SELECT statement configured on inbound endpoints.
x
x
Large Dataset Retrieval
Enables retrieval arbitrarily large datasets by consuming records in smaller batches.
Acknowledgment Statements
Supports ACK SQL statements that update the source or other table after a record is read.
x
x
Basic Insert/Update/ Delete Statements
Individual SQL INSERT, UPDATE, and DELETE queries specified on outbound endpoints. One statement is executed at a time.
x
x
Batch Insert/Update/ Delete Statements
Support for JDBC batch INSERT, UPDATE, and DELETE statements, so that many statements can be executed together.
x
Advanced JDBC-related Transformers
XML and CSV transformers for easily
x
Document generated by Confluence on Mar 11, 2009 14:57
x
Page 81
converting to and from datasets in these common formats. Outbound SELECT Queries
Retrieve records using SQL SELECT statement configured on outbound endpoints. Supports synchronous queries with dynamic runtime parameters.
x
Stored Procedure Support - Basic
Ability to invoke stored procedures. Supports IN parameters but not OUT parameters.
Stored Procedure Support - Advanced
Same as Basic but includes both IN and OUT parameter support. OUT parameters can be simple data types or cursors
Unnamed Queries
Queries that can be invoked programmatically from within service components or other Java code. This is the most flexible option, but also requires writing code.
x
x
Flexible Data Source Configuration
Support for configuration of data sources through JNDI, XAPool, or Spring.
x
x
Transactions
Support for transactions via underlying Transaction Manager.
x
x
x
x
x
Important Note on Namespaces When using JDBC EE features, you will need to import the EE namespace for the JDBC transport, which has .com instead of .org in the URL, and the XSD name is mule-jdbc-ee.xsd instead of mule-jdbc.xsd. For example, in Mule 2.1:
<mule xmlns:jdbc="http://www.mulesource.com/schema/mule/jdbc/2.1" xsi:schemaLocation="http://www.mulesource.com/schema/mule/jdbc/2.1 http://www.mulesource.com/ schema/mule/jdbc/2.1/mule-jdbc-ee.xsd">
As of Mule EE 2.2, the path will be slightly different (.org instead of .com, addition of /ee in path):
<mule xmlns:jdbc="http://www.mulesource.org/schema/mule/ee/jdbc/2.2"
Document generated by Confluence on Mar 11, 2009 14:57
Page 82
xsi:schemaLocation="http://www.mulesource.org/schema/mule/ee/jdbc/2.2 http://www.mulesource.org/ schema/mule/ee/jdbc/2.2/mule-jdbc-ee.xsd">
If you are not using JDBC EE features, you can use the normal CE namespace:
<mule xmlns:jdbc="http://www.mulesource.org/schema/mule/jdbc/2.2" xsi:schemaLocation="http://www.mulesource.org/schema/mule/jdbc/2.2 http://www.mulesource.org/ schema/mule/jdbc/2.2/mule-jdbc.xsd">
Inbound SELECT Queries Inbound SELECT queries are queries that are executed periodically (according to the pollingFrequency set on the connector). Here is an example:
<spring:bean id="jdbcDataSource" class="org.enhydra.jdbc.standard.StandardDataSource" destroymethod="shutdown"> <spring:property name="driverName" value="oracle.jdbc.driver.OracleDriver"/> <spring:property name="url" value="jdbc:oracle:thin:user/pass@host:1521:db"/> ... <jdbc:connector name="jdbcConnector" pollingFrequency="10000" dataSource-ref="jdbcDataSource"> <jdbc:query key="selectLoadedMules" value="SELECT ID, MULE_NAME, RANCH, COLOR, WEIGHT, AGE from mule_source where ID between 0 and 20"/> ... <model name="ExampleModel"> <service name="InboundSelectExample"> <jdbc:inbound-endpoint queryKey="selectMules"/> <pass-through-router> ...
In this example, the inboundSelectQuery would be invoked every 10 seconds (pollingFrequency=10000 ms). Each record from the result set is converted into a Map (consisting of column/value pairs), and this payload is sent to the VM endpoint shown above. Inbound SELECT queries are limited because (1) generally, they cannot be called synchronously (unnamed queries are an exception), and (2) they do not support runtime parameters.
Document generated by Confluence on Mar 11, 2009 14:57
Page 83
Large Dataset Retrieval Overview Large dataset retrieval is a strategy for retrieving large datasets by fetching records in smaller, more manageable batches. Mule Enterprise Edition provides the key components and transformers needed to implement a wide range of these strategies. When To Use It • When the dataset to be retrieved is large enough to overwhelm memory and connection resources. • When preserving the order of messages is important. • When resumable processing is desired (that is, retrieval of the dataset can pick up where it left off, even after service interruption). • When load balancing the data retrieval among clustered Mule nodes. How It Works Large dataset retrieval does not use conventional inbound SELECT queries to retrieve data. Instead, it uses a Batch Manager component to compute ID ranges for the next batch of records to be retrieved. An outbound SELECT query uses this range to actually fetch the records. The Batch Manager also controls batch processing flow to make sure that it does not process the next batch until the previous batch has finished processing. Detailed usage of the large dataset retrieval feature is shown in JDBC Example #4. Important Limitations Large dataset retrieval requires that: 1. The source data contains a unique, sequential numeric ID. Records should also be fetched in ascending order with respect to this ID. 2. There are no large gaps in these IDs (no larger than the configured batch size). In Combination with Batch Inserts Combining large dataset retrieval with batch inserts can support simple but powerful ETL use cases. See Example #4 and JDBC Transport Performance Benchmark Results for more details on how Mule can be used to transport millions of records an hour from one database table to another.
Acknowledgment (ACK) Statements ACK statements are optional SQL statements that are paired with inbound SELECT queries. When an inbound SELECT query is invoked by Mule, the ACK statement is invoked for each record returned by the query. Typically, the ACK statement is an UPDATE, INSERT, or DELETE. Continuing the inbound SELECT query example above, the ACK statement would be configured as follows:
... <jdbc:connector name="jdbcConnector" pollingFrequency="10000" dataSource-ref="jdbcDataSource"> <jdbc:query key="selectLoadedMules" value="SELECT ID, MULE_NAME, RANCH, COLOR, WEIGHT, PROCESSED from mule_source where ID between 0 and 20"/> <jdbc:query key="selectMules.ack" value="update mule_source set PROCESSED='Y' where ID = #[map-payload:ID] "/>
Document generated by Confluence on Mar 11, 2009 14:57
Page 84
...
Notice the convention of appending an ".ack" extension to the query name. This convention lets Mule know which inbound SELECT query to pair with the ACK statement. Also, note that the ACK statement supports parameters. These parameters are bound to any of the column values from the inbound SELECT query (such as #[ID] in the case above). ACK statements are useful when you want an inbound SELECT query to retrieve records from a source table no more than once. Be careful, however, when using ACK statements with larger result sets. As mentioned earlier, an ACK statement gets issued for each record retrieved, and this can be very resourceintensive for even a modest number of records per second (> 100).
Basic Insert/Update/Delete Statements SQL INSERT, UPDATE, and DELETE statements are specified on outbound endpoints. These statements are typically configured with parameters, which are bound with values passed along to the outbound endpoint from an upstream component. Basic statements execute just one statement at a time, as opposed to batch statements, which execute multiple statements at a time. Basic statements are appropriate for low-volume record processing (<20 records per second), while batch statements are appropriate for high-volume record processing (thousands of records per second). For example, when a message with a java.util.Map payload is sent to a basic insert/update/delete endpoint, the parameters in the statement are bound with corresponding entries in the Map. In the configuration below, if the message contains a Map payload with {ID=1,TYPE=1,DATA=hello,ACK=0}, the following insert will be issued: "INSERT INTO TEST (ID,TYPE,DATA,ACK) values (1,1,'hello',0)".
<jdbc:connector name="jdbcConnector" pollingFrequency="10000" dataSource-ref="jdbcDataSource"> <jdbc:query key="outboundInsertStatement" value="INSERT INTO TEST (ID, TYPE, DATA, ACK) VALUES (#[map-payload:ID], #[map-payload:TYPE],#[map-payload:DATA], #[map-payload:ACK])"/> ... <model name="ExampleModel"> <service name="outboundInsertExample"> <pass-through-router> <jdbc:outbound-endpoint queryKey="outboundInsertStatement"/> ...
Batch Insert/Update/Delete Statements As mentioned above, batch statements represent a significant performance improvement over their basic counterparts. Records can be inserted at a rate of thousands per second with this feature. Usage of batch INSERT, UPDATE, and DELETE statements is the same as for basic statements, except the payload sent to the VM endpoint should be a List of Maps, instead of just a single Map. Examples #1 and #4 demonstrate this feature. Batch statements are available in Mule Enterprise Edition only.
Document generated by Confluence on Mar 11, 2009 14:57
Page 85
Batch Callable Statements are also supported. Usage is identical to Batch Insert/Update/Delete.
Advanced JDBC-related Transformers Common integration use cases involve moving CSV and XML data from files to databases and back. This section describes the transformers that perform these actions. These transformers are available in Mule Enterprise Edition only. XML-JDBC Transformer The XML Transformer converts between XML and JDBC-format Maps. The JDBC-format Maps can be used by JDBC outbound endpoints (for select, insert, update, or delete operations). Transformer Details:
Name
Class
Input
Output
XML -> Maps
org.mule.providers.jdbc.transformers.XMLToMapsTransformer java.lang.String (XML) java.util.List (List of Maps. Each Map corresponds to a "record" in the XML.)
Maps -> XML
org.mule.providers.jdbc.transformers.MapsToXMLTransformer java.util.List java.lang.String (XML) (List of Maps. Each Map will be converted into a "record" in the XML)
Also, the XML message payload (passed in or out as a String) must adhere to a particular schema format:
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified"> <xs:element name="table"> <xs:complexType> <xs:sequence> <xs:element ref="record"/> <xs:element name="record"> <xs:complexType> <xs:sequence> <xs:element maxOccurs="unbounded" ref="field"/> <xs:element name="field"> <xs:complexType> <xs:simpleContent> <xs:extension base="xs:NMTOKEN"> <xs:attribute name="name" use="required" type="xs:NCName"/> <xs:attribute name="type" use="required" type="xs:NCName"/>
Here is an example of a valid XML instance:
Document generated by Confluence on Mar 11, 2009 14:57
Page 86
The transformer converts each "record" element to a Map of column/value pairs using "fields". The collection of Maps is returned in a List. See Example #2, which uses the XML Transformer to convert results from a database query into an XML document. CSV-JDBC Transformer The CSV Transformer converts between CSV data and JDBC-format Maps. The JDBC-format Maps can be used by JDBC outbound endpoints (for select, insert, update, or delete operations). Transformer Details:
Name
Class
Input
Output
CSV -> Maps
org.mule.providers.jdbc.transformers.CSVToMapsTransformer java.lang.String java.util.List (CSV data) (List of Maps. Each Map corresponds to a "record" in the CSV)
Maps -> CSV
org.mule.providers.jdbc.transformers.MapsToCSVTransformer java.util.List java.lang.String (List of Maps. Each Map (CSV data) will be converted into a "record" in the CSV)
The following table summarizes the properties that can be set on this transformer:
Property
Description
delimiter
The delimiter character used in the CSV file. Defaults to comma.
qualifier
The qualifier character used in the CSV file. Used to signify if text contains the delimiter character.Defaults to double quote.
ignoreFirstRecord
Instructs transformer to ignore the first record. Defaults to false.
mappingFile
Location of Mapping file. Required. Can either be physical file location or classpath resource name. The DTD format of the Mapping File can be found at: http://flatpack.sourceforge.net/ flatpack.dtd. For examples of this format, see http://flatpack.sourceforge.net/documentation/ index.html.
For an example, see Example #1, which uses the CSV Transformer to load data from a CSV file to a database table.
Document generated by Confluence on Mar 11, 2009 14:57
Page 87
Outbound SELECT Queries An inbound SELECT query is invoked on an inbound endpoint according to a specified polling frequency. A major improvement to the inbound SELECT query is the outbound SELECT query, which can be invoked on an outbound endpoint. As a result, the outbound SELECT query can do many things that the inbound SELECT query cannot, such as: 1. Support synchronous invocation of queries. For example, you can implement the classic use case of a web page that serves content from a database using an HTTP inbound endpoint and an outbound SELECT query endpoint. 2. Allows parameters so that values can be bound to the query at runtime. This requires that the message contain a Map payload containing key names that match the parameter names. For example, the following configuration could be used to retrieve an outbound SELECT query:
... <jdbc:connector name="jdbcConnector" dataSource-ref="jdbcDataSource"> <jdbc:query key="selectMules" value="select * from mule_source where ID between 0 and #[map-payload:ID]"/> ... <model name="ExampleModel"> <service name="selectOutboundExample"> <pass-through-router> <jdbc:outbound-endpoint queryKey="selectMules"/>
In this scenario, if a Map is sent to the vm://mapReceiver endpoint containing this key/value pair:
key=ID value=3
The following query is executed:
SELECT * FROM mule_source WHERE ID between 0 and 3
See Examples #2 and #3 for further outbound SELECT query examples. Note that this feature is available in Mule Enterprise Edition only.
Stored Procedure Support - Basic Like any other query, stored procedure queries can be listed in the "queries" map. Following is an example of how stored procedure queries could be defined:
<jdbc:connector name="jdbcConnector" pollingFrequency="10000" dataSource-ref="jdbcDataSource"> <jdbc:query key="storedProc" value="CALL addField()"/>
Document generated by Confluence on Mar 11, 2009 14:57
Page 88
To denote that we are going to execute a stored procedure and not a simple SQL query, we must start off the query by the text CALL followed by the name of the stored procedure. Parameters to stored procedures can be forwarded by either passing static parameters in the configuration or using the same syntax as for SQL queries. For example:
<jdbc:query key="storedProc1" value="CALL addFieldWithParams(24)"/> <jdbc:query key="storedProc2" value="CALL addFieldWithParams(#[map-payload:value])"/> ... <pass-through-router> <jdbc:outbound-endpoint queryKey="storedProc1"/> ... <pass-through-router> <jdbc:outbound-endpoint address="jdbc://storedProc2?value=25"/> ...
If you do not want to poll the database, you can write a stored procedure that uses HTTP to start a Mule service. The stored procedure can be called from an Oracle trigger. If you take this approach, make sure the Mule service is asynchronous. Otherwise, the trigger/ transaction won't commit until the HTTP post returns.
Stored Procedure Support - Advanced Mule Enterprise Edition provides advanced stored procedure support not available in Mule Community Edition. This section describes the advanced support. OUT Parameters In Mule Enterprise, you can execute your stored procedures with out and inout scalar parameters. The syntax for such parameters is:
<jdbc:query key="storedProc1" value="CALL myProc(#[a], #[b;int;inout], #[c;string;out])"/>
You must specify the type of each output parameter (OUT, INOUT) and its data type (int, string, etc.). The result of such stored procedures is a map containing (out parameter name, value) entries. See Example #3 for more examples. Oracle Cursor Support For Oracle databases only, an OUT parameter can return a cursor. The following example shows how this works. If you want to handle the cursor as a java.sql.ResultSet, see the "cursorOutputAsResultSet" service below, which uses the "MapLookup" transformer to return the ResultSet. If you want to handle the cursor by fetching the java.sql.ResultSet to a collection of Map objects, see the "cursorOutputAsMaps" service below, which uses both the "MapLookup" and "ResultSet2Maps" transformers to achieve this result.
Document generated by Confluence on Mar 11, 2009 14:57
Page 89
<jdbc:connector name="jdbcConnector" pollingFrequency="1000" cursorTypeConstant="-10" dataSource-ref="jdbcDataSource"> <jdbc:query key="SingleCursor" value="call TEST_CURSOR(#[mules;resultSet;out])"/> <custom-transformer class="org.mule.transformer.simple.MapLookup" name="MapLookup"> <spring:property name="key" value="mules"/> <jdbc:resultset-to-maps-transformer name="ResultSet2Maps"/> <model name="SPModel"> <service name="cursorOutputAsMaps"> <pass-through-router> <jdbc:outbound-endpoint queryKey="SingleCursor"/> <service name="cursorOutputAsResultSet"> <pass-through-router> <jdbc:outbound-endpoint queryKey="SingleCursor"/>
In the above example, note that it is also possible to call a function that returns a cursor ref. For example, if TEST_CURSOR2() returns a cursor ref, the following statement could be used to get that cursor as a ResultSet:
<jdbc:query key="SingleCursor" value="call #[mules;resultSet;out] := TEST_CURSOR2()"/>
Important note on transactions: When calling stored procedures or functions that return cursors (ResultSet), it is recommended that you process the ResultSet within a transaction.
Unnamed Queries SQL statements can also be executed without configuring queries in the Mule configuration file. For a given endpoint, the query to execute can be specified as the address of the URI.
MuleMessage msg = eventContext.receiveEvent("jdbc://SELECT * FROM TEST", 0);
Document generated by Confluence on Mar 11, 2009 14:57
Page 90
Flexible Data Source Configuration You can use any JDBC data source library with the JDBC Connector. The "myDataSource" reference below refers to a DataSource bean created in Spring:
<jdbc:connector name="jdbcConnector" pollingFrequency="10000" dataSource-ref="myDataSource"> ...
You can also create a JDBC connection pool so that you don't create a new connection to the database for each message. You can easily create a pooled data source in Spring using xapool. The following example shows how to create the Spring bean right in the Mule configuration file.
<spring:bean id="pooledDS" class="org.enhydra.jdbc.standard.StandardDataSource" destroymethod="shutdown"> <spring:property name="driverName" value="oracle.jdbc.driver.OracleDriver"/> <spring:property name="url" value="jdbc:oracle:thin:user/pass@host:1521:db"/>
If you need more control over the configuration of the pool, you can use the standard JDBC classes. For example, you could create the following beans in the Spring configuration file (you could also create them in the Mule configuration file by prefixing everything with the Spring namespace):
//create the data source that will establish the connection <property name="driverClassName" value="oracle.jdbc.driver.OracleDriver"/> <property name="url" value="jdbc:oracle:thin:@mydb:1521:orcl"/> <property name="username" value="my_user"/> <property name="password" value="xyz123"/> //create the pool <property name="minEvictableIdleTimeMillis" value="300000" /> <property name="timeBetweenEvictionRunsMillis" value="60000"/> <property name="maxActive" value="256"/> <property name="maxIdle" value="100"/> <property name="whenExhaustedAction" value="2"/> //create a connection factory for the data source
//create a poolable connection factory based on the above pool and connection factory
Document generated by Confluence on Mar 11, 2009 14:57
Page 91
You could then reference the pooledDS bean in your Mule configuration:
<jdbc:connector name="jdbcConnector" dataSource-ref="pooledDS"/>
To retrieve the data source from a JNDI repository, you would configure the connector as follows:
<spring:beans> <jee:jndi-lookup id="myDataSource" jndi-name="yourJndiName" environment-ref="yourJndiEnv" /> <spring:entry key="java.naming.factory.initial" value="yourJndiFactory" />
The above example shows how to create the Spring beans right in the Mule configuration file. This approach would require the following namespaces:
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:spring="http://www.springframework.org/schema/beans" xmlns:jee="http://www.springframework.org/schema/jee" xmlns:util="http://www.springframework.org/schema/util" xmlns:jdbc="http://www.mulesource.org/schema/mule/jdbc/2.2" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/springbeans-2.0.xsd http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/springjee-2.0.xsd http://www.springframework.org/schema/util http://www.springframework.org/schema/util/springutil-2.0.xsd http://www.mulesource.org/schema/mule/core/2.2 http://www.mulesource.org/schema/mule/core/2.2/ mule.xsd http://www.mulesource.org/schema/mule/jdbc/2.2 http://www.mulesource.org/schema/mule/jdbc/2.2/ mule-jdbc.xsd">
Transactions Transactions are supported on JDBC Endpoints. See Transaction Management for details.
API Documentation and Notes Connector Properties You can set the following properties on the JDBC connector.
Property
Description
Document generated by Confluence on Mar 11, 2009 14:57
Default
Required
Page 92
dataSource-ref
Reference to the JDBC data source to use. When using XA transactions, an XADataSource object must be provided.
Yes
pollingFrequency
The delay in milliseconds that will be used during two subsequent polls to the database
No
resultSetHandler-ref
Reference to ResultSetHandler used to pass back query results. For more information about this object, see the examples.
org.apache.commons.dbutils. No handlers.MapListHandler
queryRunner-ref
Reference to the QueryRunner to use when executing a Query. For more information about this object, see the examples.
org.apache.commons.dbutils. no QueryRunner
transactionPerMessage
Whether each database record should be received in a separate transaction. If false, there will be a single transaction for the entire result set.
true
No
Extending the SQL Strategy As of Mule 2.2, you can use the <sqlStatementStrategyFactory> child element to override the default SqlStatementStrategyFactory using the class or ref attribute. It determines the execution strategy based on the SQL provided. For example:
<jdbc:connector name="jdbcConnector4" dataSource-ref="testDS2"> <jdbc:sqlStatementStrategyFactory class="org.mule.transport.jdbc.config.JdbcNamespaceHandlerTestCase $TestSqlStatementStrategyFactory"/> <jdbc:connector name="jdbcConnector5" dataSource-ref="testDS2"> <jdbc:sqlStatementStrategyFactory ref="sqlStatementStrategyFactory"/>
Notes on Configuring Queries SQL queries are used by endpoints and should be configured on the connector using the "query" element:
Document generated by Confluence on Mar 11, 2009 14:57
Page 93
<jdbc:query key="myQuery" value="select * from blah"/>
The queries can be parameterized using the #[...] pattern that follows the Expression Evaluation Framework.
Runnable Examples For examples of using the Mule Enterprise version of the JDBC transport, see JDBC Transport Examples.
Performance Results For information on performance testing on the Mule Enterprise version of the JDBC transport, see JDBC Transport Performance Benchmark Results.
Document generated by Confluence on Mar 11, 2009 14:57
Page 94
JDBC Transport Examples This page last changed on Feb 24, 2009 by jackie.wheeler.
JDBC Transport Examples This page describes the examples you can run for the Mule Enterprise JDBC transport. These examples are designed to work with Oracle databases only.
Setup The Mule Enterprise JDBC Examples are located in your installation at $MULE_HOME/examples/jdbc. 1. Before running any examples, do the following: • Run the statements in scripts/tables.ddl to create tables in your favorite database. • Edit the conf/db.properties file with your database connection configuration. • Copy your database driver to your $MULE_HOME/lib/user directory. 2. Run the examples using the "jdbc.bat" or "jdbc" shell script provided in this directory. After running the script, you will see the following: $ ./jdbc.bat Examples require that you set up your database first. See README for more details. After your database is set up, choose one of the following examples to run: 1. Mules are born. Read in 50 baby mules from a CSV File and create records in mule_source table. 2. View Mules. Generate an XML report of Mules. (http://localhost:8080/first20) 3. Clone Mules. Clone mules using a Stored Procedure. (http://localhost:8080/clone) 4. Retire Mules. Send mules to a retirement ranch (a.k.a the mule_target table). 5. Cleanup Mules. Reset tables to run examples again (http://localhost:8080/cleanup). Select the one you wish to execute and press Enter...
3. Choose the number of the Example you want to run. The examples are designed to be run in order.
Example 1 - Mules Are Born This example loads records from a CSV file to the database. The CSV file ("data/mules.csv") contains information about 50 baby mules born at various local ranches. The goal is to upload these records into a database table called "mule_source".
Configuration See conf/jdbc-csv.xml
Features Used This example uses the CSV Transformer to convert the CSV file into JDBC-format Maps and inserts these records into the database using a batch INSERT.
Running the Example To run the example, choose option "1" after starting the Mule server. When the server starts, Mule will immediately load all the records. To verify that the example loaded correctly, use your favorite database tool to see that there were 50 records inserted into the mule_source table. SQL> select count(1) from mule_source;
Document generated by Confluence on Mar 11, 2009 14:57
Page 95
COUNT(1) ---------50
If you want to run the example again, first delete the records from mule_source.
Example 2 - See the Baby Mules This example displays the mule records loaded into the database in Example 1.
Configuration See conf/jdbc-xml-report.xml
Features Used This example uses an outbound SELECT query to synchronously query the database. The results are transformed into XML using the XML transformer.
Running the Example Start the Mule server and choose Example 2. Then, enter the URL http://localhost:8080/first20 into your web browser. You should see the first 20 mule records presented in XML format.
Example 3 - Mule Cloning The following example assumes that you are using an Oracle database. However, you can adapt the stored procedure for other database platforms. This example shows how to invoke a stored procedure in Mule. This particular stored procedure clones the records in the mule_source database (doubling the size of the table each time it is run). The goal is to create a large dataset that we can use in Example 4.
Configuration See conf/jdbc-stored-procedure.xml
Features Used This page uses an outbound SELECT query and stored procedure support to synchronously call a stored procedure.
Running the Example Before running this example, run the statements in the scripts/oracle_procs.ddl to create the stored procedure and sequence. Start the Mule server and choose Example 3. Then, enter the URL http://localhost:8080/clone into your web browser. You should see the current count of the number of mules in mule_source. Each time you refresh the page, the number of mules should double. Try refreshing several times until there are thousands or even millions of mules or more in the table. The mules multiply quickly!
Example 4 - Mass Mule Retirement This example retires all our mules by transferring them from one database table (mule_source) to another (mule_target). We can think of this as a simple ETL use case.
Document generated by Confluence on Mar 11, 2009 14:57
Page 96
Configuration See conf/jdbc-etl.xml
Features Used This page uses large dataset retrieval, an outbound SELECT query, and batch INSERT statements to transfer arbitrarily large numbers of records from one table another.
Running the Example Before running this example, you can optionally change the location of the ID store in jdbc-etl.xml:
<spring:bean id="idStore" class="org.mule.transport.jdbc.util.IdStore"> <spring:property name="fileName" value="/tmp/eg-batches.txt"/>
The default location is /tmp/eg-batches.txt on Linux/Unix and c:/tmp/eg-batches.txt on Windows. Next, for better visibility into batch activity, add the following line to your log4j.properties file (in $MULE_HOME/conf): log4j.logger.org.mule.providers.jdbc.components=DEBUG
Finally, start the server and choose Example 4. You should see the batches of records being processed in the logs: DEBUG 2008-04-10 20:20:03,625 \[next_batch.2\] Processing next batch DEBUG 2008-04-10 20:20:03,625 \[next_batch.2\] range: {lowerId=1, upperId=3000} DEBUG 2008-04-10 20:20:04,531 \[next_batch.2\] Processing next batch DEBUG 2008-04-10 20:20:04,531 \[next_batch.2\] range: {lowerId=3001, upperId=6000} DEBUG 2008-04-10 20:20:05,531 \[next_batch.2\] Processing next batch DEBUG 2008-04-10 20:20:05,531 \[next_batch.2\] range: {lowerId=6001, upperId=9000}
org.mule.transport.jdbc.components.BatchManager: org.mule.transport.jdbc.components.BatchManager: Next org.mule.transport.jdbc.components.BatchManager: org.mule.transport.jdbc.components.BatchManager: Next org.mule.transport.jdbc.components.BatchManager: org.mule.transport.jdbc.components.BatchManager: Next
In this example, batches are configured to occur every 1 second, with a batch size of 3000. Note that if you stop and restart the Mule server, the batches should resume processing where they left off.
Re-running the Examples If you want to run these examples again, just delete all records from both mule_source and mule_target tables, and remove the file "/tmp/eg-batches.txt". In Oracle, this may be most efficiently done by using truncate, e.g. truncate table mule_source. Alternatively, if on Oracle, start the server choose "Example 5" to cleanup the tables mule_source and mule_target. You still need to manually remove the file "/tmp/eg-batches.txt".
Document generated by Confluence on Mar 11, 2009 14:57
Page 97
JDBC Transport Performance Benchmark Results This page last changed on May 21, 2008 by jackie.wheeler.
JDBC Transport Performance Benchmark Results This page describes the performance benchmark results for the Mule Enterprise JDBC transport.
Configuration Mule
Enterprise 1.6 (default 512mb max heap size)
JDK
1.5.0.11
OS
Red Hat Enterprise 4.0
Mule CPUs
4-CPU Dell
Database
Oracle 10g (separate 4-CPU host)
Mule Configuration
See Examples in $MULE_HOME/examples/jdbc. Used "Simple ETL" use case for this benchmark
Scenario Details The ETL use case from the Examples directory was used for this benchmark. This example retrieves records from a table called mule_source and inserts them into a table called mule_target. The scenario involves processing a backlog of 10 million records in the mule_source table. Records are read from the source table once every 1 second, at a batch size of 3000 records per read and 3000 records per commit.
Results Mule took 55 minutes to complete processing of the 10 million record backlog. Therefore, with this configuration, the Mule Enterprise JDBC Transport could move over 10 million records an hour.
Comparison to Mule Community Edition
Document generated by Confluence on Mar 11, 2009 14:57
Page 98
Document generated by Confluence on Mar 11, 2009 14:57
Page 99
Jetty Transport This page last changed on Feb 20, 2009 by jackie.wheeler.
Jetty Transport [ Connector ] [ Endpoints ] [ Using Web Services over Jetty ] The Jetty transport provides support for exposing services over HTTP by embedding a light-weight Jetty server. The Jetty SSL transport works the same way but over SSL. You can only define inbound endpoints with this transport. The Javadoc for this transport can be found here .
Connector Allows Mule to expose Mule Services over HTTP using a Jetty HTTP server. A single Jetty server is created for each connector instance. One connector can serve many endpoints. Users should rarely need to have more than one Jetty connector. The Jetty connector can be configured using a Jetty XML config file, but the default configuration is sufficient for most scenarios.
Attributes of
Name
Type
Required
Default
Description
configFile
string
no
The location of the Jetty config file to configure this connector with.
useContinuations
boolean
no
Whether to use continuations to free up connections in high load situations.
For example:
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:jetty="http://www.mulesource.org/schema/mule/jetty/2.2" xsi:schemaLocation="http:// www.mulesource.org/schema/mule/jetty/2.2 http://www.mulesource.org/schema/mule/jetty/2.2/mule-jetty.xsd http://www.mulesource.org/schema/mule/ core/2.2 http://www.mulesource.org/schema/mule/core/2.2/mule.xsd"> <jetty:connector name="httpConnector" useContinuations="true" /> ...
Endpoints Jetty endpoints are configured the same way as HTTP endpoints. Note that only inbound endpoints can use the Jetty transport. For example:
Document generated by Confluence on Mar 11, 2009 14:57
Page 100
<jetty:endpoint name="serverEndpoint" host="localhost" port="60203" path="services/Foo" synchronous="false" /> <model name="main"> <service name="testComponent">
Using Web Services over Jetty Mule supports using web services over Jetty. This allows you to achieve improved HTTP performance and scalability due to Jetty's NIO support. Using the Jetty transport simply requires that you use the "jetty://" URL scheme as opposed to the regular HTTP scheme. For example:
<service name="greeterService"> <singleton-object class="org.apache.hello_world_soap_http.GreeterImpl"/>
Due to limitations of the CXF and HTTP transports, if you are talking to outbound endpoints that do not use a CXF client underneath and are of the form "cxf:http://locahost/service? method=echo", this will not work. We hope to address this during a future refactoring of the HTTP transport.
Document generated by Confluence on Mar 11, 2009 14:57
Page 101
Jetty SSL transport This page last changed on Feb 20, 2009 by jackie.wheeler.
Jetty SSL Transport The Jetty SSL transport works exactly the same way as the HTTPS Transport with one additional optional attribute, configFile, which allows you to specify the location of the Jetty config file to configure this connector with. For example, the following configuration specifies the HTTPS and Jetty-SSL connectors:
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:spring="http://www.springframework.org/schema/beans" xmlns:https="http://www.mulesource.org/schema/mule/https/2.2" xmlns:jetty="http://www.mulesource.org/schema/mule/jetty-ssl/2.2" xmlns:test="http://www.mulesource.org/schema/mule/test/2.0" xsi:schemaLocation="http://www.mulesource.org/schema/mule/test/2.2 http://www.mulesource.org/schema/mule/test/2.0/mule-test.xsd http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd http://www.mulesource.org/schema/mule/core/2.2 http://www.mulesource.org/schema/mule/core/2.2/mule.xsd http://www.mulesource.org/schema/mule/https/2.2 http://www.mulesource.org/schema/mule/https/2.2/mule-https.xsd http://www.mulesource.org/schema/mule/jetty-ssl/2.2 http://www.mulesource.org/schema/mule/jetty-ssl/2.2/mule-jetty-ssl.xsd"> <jetty:connector name="jettyConnector"> <jetty:tls-client path="clientKeystore" storePassword="mulepassword" /> <jetty:tls-key-store path="serverKeystore" keyPassword="mulepassword" storePassword="mulepassword" / > <jetty:tls-server path="trustStore" storePassword="mulepassword" /> <model name="main"> <custom-service name="testComponent" class="org.mule.tck.testmodels.mule.TestSedaService"> <jetty:inbound-endpoint host="localhost" port="60202" synchronous="true" connectorref="jettyConnector" />
If you do not need this level of security, you can use the Jetty Transport instead.
Document generated by Confluence on Mar 11, 2009 14:57
Page 102
JMS Transport This page last changed on Feb 20, 2009 by jackie.wheeler.
JMS Transport Table of Contents Click here to expand... • JMS Transport ° JMS Configuration • ° - Using Topics, Queues, or Both - Specifying Credentials - Specifying Additional Information - JMS Selectors - Durable Subscribers - Overloading JMS Behavior - Looking Up JMS Objects from JNDI - JMS Transformers - JMS Header Properties ° Configuring Specific JMS Servers ° Schema Reference ° Connector ° - Attributes of ° Custom Connector ° - Attributes of <custom-connector...> ° Activemq Connector ° - Attributes of ° Activemq Xa Connector ° - Attributes of ° Weblogic Connector ° - Attributes of <weblogic-connector...> ° Websphere Connector ° - Attributes of <websphere-connector...> ° Transaction ° Client Ack Transaction ° Jmsmessage To Object Transformer ° Object To Jmsmessage Transformer ° Inbound Endpoint ° - Attributes of ° Outbound Endpoint ° - Attributes of ° Endpoint ° - Attributes of <endpoint...> ° Property Filter ° - Attributes of <property-filter...> This page describes the JMS transport, which provides a standard JMS 1.0.2b and 1.1 connector. This connector exposes all features defined in the 1.0.2b/1.1 specification. It also provides links to information on configuring various types of JMS, such as ActiveMQ. Note that if you are using Oracle AQ, you can use the JMS transport without any special configuration if you are using Oracle 10 or later. For details, see the example on the Mule Cookbook. For information on managing JMS local and distributed (XA) transactions, as well as multi-resource transactions (for Mule Enterprise Edition users), see Transaction Management. Additionally, the Error Handler Example and Loan Broker Example demonstrate using the Active MQ connector and various JMS transformers. The Javadoc for the JMS transport can be found here .
Document generated by Confluence on Mar 11, 2009 14:57
Page 103
JMS Configuration This section provides general information about JMS configuration with Mule. For links to information on specific JMS servers, see Configuring Specific JMS Servers below.
Using Topics, Queues, or Both When specifying a destination name in a URI, and JNDI destinations are not being used, the default destination created is a queue. For example, the following JMS endpoint will manifest itself as a JMS queue called my.destination.
jms://my.destination
To make this destination a topic instead of a queue, you must prepend the destination name with topic: in the URI. In transport-specific endpoints, you set the topic and queue attributes explicitly. For example:
jms://topic:my.destination
or
<jms:inbound-endpoint topic="my.destination"/> <jms:outbound-endpoint queue="my.destination"/>
Note that topics are not officially supported with Mule and WebSphere MQ. If you are using a JMS 1.1 compliant server, you can use the same JMS connector for both queues and topics. If you are using a JMS 1.0.2b server, and you want to use both queues and topics in your Mule configuration, you must create two JMS connectors: one with a JNDI connection factory that references a QueueConnectionFactory, and another that references a TopicConnectionfactory. Each JMS endpoint must reference the correct connector depending on whether the destination is a topic or a queue. To specify the connector on a JMS endpoint, you add the connector parameter to the URI or the connector-ref attribute on a transport-specific endpoint:
jms://my.destination?connector=jmsQueueConnector jms://topic:my.destination?connector=jmsTopicConnector
or
<jms:outbound-endpoint queue="my.destination" connector-ref="jmsQueueConnector"/> <jms:inbound-endpoint topic="my.destination" connector-ref="jmsTopicConnector"/>
Specifying Credentials Client connections might require a username and password when creating a connection. This information can be specified on the URI or transport-specific endpoint as follows:
Document generated by Confluence on Mar 11, 2009 14:57
Page 104
jms://ross:secret@topic:my.destination
or
<jms:inbound-endpoint topic="my.destination" username="ross" password="secret"/>
Specifying Additional Information When creating JMS connectors, more information is needed such as ConnectionFactory JNDI details. This information can be set as parameters on the URI, but this can get difficult to manage and read. The recommend approach is to set default properties on the connector as described in Looking Up JMS Objects from JNDI below.
JMS Selectors You can set a JMS selector as a filter on an endpoint. The JMS selector simply sets the filter expression on the consumer.
<jms:endpoint queue="important.queue" connector-ref="..."> <jms:selector expression="JMSPriority=9"/>
Durable Subscribers You can use durable subscribers by setting the durable attribute on the JMS connector. This attribute tells the connector to make all topic subscribers durable (it does not apply to queues). You can override the connector's durable attribute at the endpoint level. For example, you can set durable to false on the connector and set it to true just on the endpoints that require it.
<jms:connector name="jmsTopicConnector" durable="false"/> ... <jms:inbound-endpoint topic=durable.topic" connector-ref="jmsTopicConnector"> <property key="durable" value="true"/>
When using a durable subscription, the JMS server requires a durable name to identify this subscriber. By default, Mule generates the durable name in the following format: mule..
If you want to set the durable name yourself, you can set the durableName property on the endpoint.
<jms:inbound-endpoint topic="durable.topic" connector-ref="jmsTopicConnector"> <property key="durable" value="true"/> <property key="durableName" value="myDurableSubscription"/>
The URI equivalent would be:
Document generated by Confluence on Mar 11, 2009 14:57
Page 105
jms://topic:durable.topic?durableName=myDurableSubscription
Overloading JMS Behavior Some JMS servers require a different sequence of calls when creating JMS resources. For example, Oracle's Advanced Queuingrequires that the connection is started before listeners can be registered. In this scenario the user can overload the JmsSupport class to customize the way JMS resources are initialized. Configuring this customization requires that you tell the JMS connector to use a custom JmsSupport class.
<spring:bean id="customJmsSupport" class="org.foo.jms.CustomJmsSupport"/> <jms:connector name="jmsConnector"> <property key="jmsSupport" ref="customJmsSupport"/>
For more information about configuring specific JMS servers, see Configuring Specific JMS Servers below.
Looking Up JMS Objects from JNDI Mule can be configured to look up connection factories, queues, and topics from JNDI. Use the following connector attributes to configure your JNDI connection:
Connector Attribute
Description
jndiInitialFactory
Class name of the InitialContextFactory
jndiProviderUrl
URL for the JNDI connection
jndiProviderProperties-ref
Reference to a Spring map with additional properties that will be passed on when creating the InitialContext
connectionFactoryJndiName
JNDI lookup name of the connection factory
jndiDestinations
Set this flag to true to look up queues or topics from JNDI. If a queue cannot be found on JNDI, it well be created using the existing JMS session (you can prevent this by using the forceJndiDestinations attribute). The default is false.
forceJndiDestinations
Set this connector property to false if you want Mule to fail if a queue or topic could not be looked up in JNDI. The default is false.
Note that JNDI configuration on the connector takes precedence over a Spring-configured connection factory. Configuration example:
<jms:connector name="jmsJndiConnector" jndiInitialFactory="com.sun.jndi.ldap.LdapCtxFactory" jndiProviderUrl="ldap://localhost:10389/" connectionFactoryJndiName="cn=ConnectionFactory,dc=example,dc=com" jndiDestinations="true"
Document generated by Confluence on Mar 11, 2009 14:57
Page 106
forceJndiDestinations="true"/>
JMS Transformers Transformers for the JMS provider can be found at org.mule.transport.jms.transformers .
Transformer
Description
AbstractJmsTransformer
This is a base class that provides general JMS message transformation support. You can extend this class to create your own specialized JMS transformers, but usually the defaults are sufficient.
JMSMessageToObject
Converts a javax.jms.Message or sub-type into an object by extracting the message payload. Users of this transformer can set different return types on the transformer to control the way it behaves: javax.jms.TextMessage - java.lang.String javax.jms.ObjectMessage - java.lang.Object javax.jms.BytesMessage - Byte[]. Note that the transformer will check if the payload is compressed and automatically decompress the message. javax.jms.MapMessage - java.util.Map javax.jms.StreamMessage - java.util.Vector of objects from the Stream Message.
ObjectToJMSMessage
Converts any object to a javax.jms.Message or sub-type. One of the following types of JMS messages will be created based on the type of object passed in: java.lang.String - javax.jms.TextMessage byte[] - javax.jms.BytesMessage java.util.Map - javax.jms.MapMessage java.io.InputStream - javax.jms.StreamMessage javalang.Object - javax.jms.ObjectMessage
JMS Header Properties When the message is received and transformed, all the message properties are still available via the MuleMessage object. To access standard JMS properties such as JMSCorrelationID and JMSRedelivered, simply use the property name, as shown in the following example:
String corrId = (String) muleMessage.getProperty("JMSCorrelationID"); boolean redelivered = muleMessage.getBooleanProperty("JMSRedelivered");
You can access any custom header properties on the message in the same way.
Configuring Specific JMS Servers The following links describe how to set up various JMS servers in Mule. Note that the configurations provided are just examples. Configuration values will change depending on your application environment. • ActiveMQ
Document generated by Confluence on Mar 11, 2009 14:57
Page 107
• • • • • • • • • • • •
FioranoMQ JBoss MQ OpenJms Open MQ Oracle AQ SeeBeyond SonicMQ Sun JMS Grid SwiftMQ Tibco EMS WebLogic JMS WebSphere MQ
Schema Reference Connector The connector element configures a generic connector for sending and receiving messages over JMS queues.
Attributes of
Name
Type
Required
connectionFactoryref
name (no spaces)
no
Reference to the connection factory, which is required for non-vendor JMS configurations.
redeliveryHandlerFactoryname (no spaces) ref
no
Reference to the redelivery handler.
acknowledgementMode AUTO_ACKNOWLEDGE/ no CLIENT_ACKNOWLEDGE/ DUPS_OK_ACKNOWLEDGE
Default
Description
AUTO_ACKNOWLEDGE The acknowledgement mode to use: AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE, or DUPS_OK_ACKNOWLEDGE.
clientId
string
no
The ID of the JMS client.
durable
boolean
no
Whether to make all topic subscribers durable.
noLocal
boolean
no
If set to true, a subscriber will not receive messages that were published by its own connection.
persistentDelivery
boolean
no
If set to true, the JMS provider logs
Document generated by Confluence on Mar 11, 2009 14:57
Page 108
the message to stable storage as it is sent so that it can be recovered if delivery is unsuccessful. honorQosHeaders
boolean
no
If set to true, the message's QoS headers are honored. If false (the default), the connector settings override the message headers.
maxRedelivery
integer
no
The maximum number of times to try to redeliver a message.
cacheJmsSessions
boolean
no
Whether to cache and re-use the JMS session object instead of recreating the connection each time.
eagerConsumer
boolean
no
Whether to create a consumer right when the connection is created instead of using lazy instantiation in the poll loop.
specification
1.0.2b/1.1
no
username
string
no
The user name for the connection
password
string
no
The password for the connection
no
The number of concurrent consumers that will be used to receive JMS messages. (Note: If you use this attribute, you should not configure the 'numberOfConcurrentTransacted which has the same effect.)
numberOfConsumersinteger
Document generated by Confluence on Mar 11, 2009 14:57
1.0.2b
The JMS specification to use: 1.0.2b (the default) or 1.1
Page 109
jndiInitialFactory
string
no
The initial factory class to use when connecting to JNDI.
jndiProviderUrl
string
no
The URL to use when connecting to JNDI.
jndiProviderPropertiesstring ref
no
Reference to a Map that contains additional provider properties.
connectionFactoryJndiName string
no
The name to use when looking up the connection factory from JNDI.
jndiDestinations
boolean
no
Set this attribute to true if you want to look up queues or topics from JNDI instead of creating them from the session.
forceJndiDestinationsboolean
no
If set to true, Mule fails when a topic or queue cannot be retrieved from JNDI. If set to false, Mule will create a topic or queue from the JMS session if the JNDI lookup fails.
disableTemporaryReplyToDestinations boolean
no
If this is set to false (the default), when Mule performs request/response calls a temporary destination will automatically be set up to receive a response from the remote JMS call.
Custom Connector The custom-connector element configures a custom connector for sending and receiving messages over JMS queues.
Attributes of <custom-connector...>
Name
Type
Required
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 110
redeliveryHandlerFactoryname (no spaces) ref
no
acknowledgementMode AUTO_ACKNOWLEDGE/ no CLIENT_ACKNOWLEDGE/ DUPS_OK_ACKNOWLEDGE
Reference to the redelivery handler. AUTO_ACKNOWLEDGE The acknowledgement mode to use: AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE, or DUPS_OK_ACKNOWLEDGE.
clientId
string
no
The ID of the JMS client.
durable
boolean
no
Whether to make all topic subscribers durable.
noLocal
boolean
no
If set to true, a subscriber will not receive messages that were published by its own connection.
persistentDelivery
boolean
no
If set to true, the JMS provider logs the message to stable storage as it is sent so that it can be recovered if delivery is unsuccessful.
honorQosHeaders
boolean
no
If set to true, the message's QoS headers are honored. If false (the default), the connector settings override the message headers.
maxRedelivery
integer
no
The maximum number of times to try to redeliver a message.
cacheJmsSessions
boolean
no
Whether to cache and re-use the JMS session object instead of recreating the connection each time.
eagerConsumer
boolean
no
Whether to create a consumer right when the connection is created instead
Document generated by Confluence on Mar 11, 2009 14:57
Page 111
of using lazy instantiation in the poll loop. specification
1.0.2b/1.1
no
username
string
no
The user name for the connection
password
string
no
The password for the connection
numberOfConsumersinteger
no
The number of concurrent consumers that will be used to receive JMS messages. (Note: If you use this attribute, you should not configure the 'numberOfConcurrentTransacted which has the same effect.)
jndiInitialFactory
string
no
The initial factory class to use when connecting to JNDI.
jndiProviderUrl
string
no
The URL to use when connecting to JNDI.
jndiProviderPropertiesstring ref
no
Reference to a Map that contains additional provider properties.
connectionFactoryJndiName string
no
The name to use when looking up the connection factory from JNDI.
jndiDestinations
boolean
no
Set this attribute to true if you want to look up queues or topics from JNDI instead of creating them from the session.
forceJndiDestinationsboolean
no
If set to true, Mule fails when a topic or queue cannot be retrieved from JNDI. If set to false, Mule will create a topic or queue from the
Document generated by Confluence on Mar 11, 2009 14:57
1.0.2b
The JMS specification to use: 1.0.2b (the default) or 1.1
Page 112
JMS session if the JNDI lookup fails. disableTemporaryReplyToDestinations boolean
no
If this is set to false (the default), when Mule performs request/response calls a temporary destination will automatically be set up to receive a response from the remote JMS call.
Activemq Connector The activemq-connector element configures an ActiveMQ version of the JMS connector.
Attributes of
Name
Type
Required
connectionFactoryref
name (no spaces)
no
Optional reference to the connection factory. A default connection factory is provided for vendorspecific JMS configurations.
redeliveryHandlerFactoryname (no spaces) ref
no
Reference to the redelivery handler.
acknowledgementMode AUTO_ACKNOWLEDGE/ no CLIENT_ACKNOWLEDGE/ DUPS_OK_ACKNOWLEDGE
Default
Description
AUTO_ACKNOWLEDGE The acknowledgement mode to use: AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE, or DUPS_OK_ACKNOWLEDGE.
clientId
string
no
The ID of the JMS client.
durable
boolean
no
Whether to make all topic subscribers durable.
noLocal
boolean
no
If set to true, a subscriber will not receive messages that were published by its own connection.
persistentDelivery
boolean
no
If set to true, the JMS provider logs
Document generated by Confluence on Mar 11, 2009 14:57
Page 113
the message to stable storage as it is sent so that it can be recovered if delivery is unsuccessful. honorQosHeaders
boolean
no
If set to true, the message's QoS headers are honored. If false (the default), the connector settings override the message headers.
maxRedelivery
integer
no
The maximum number of times to try to redeliver a message.
cacheJmsSessions
boolean
no
Whether to cache and re-use the JMS session object instead of recreating the connection each time.
eagerConsumer
boolean
no
Whether to create a consumer right when the connection is created instead of using lazy instantiation in the poll loop.
specification
1.0.2b/1.1
no
username
string
no
The user name for the connection
password
string
no
The password for the connection
no
The number of concurrent consumers that will be used to receive JMS messages. (Note: If you use this attribute, you should not configure the 'numberOfConcurrentTransacted which has the same effect.)
numberOfConsumersinteger
Document generated by Confluence on Mar 11, 2009 14:57
1.0.2b
The JMS specification to use: 1.0.2b (the default) or 1.1
Page 114
jndiInitialFactory
string
no
The initial factory class to use when connecting to JNDI.
jndiProviderUrl
string
no
The URL to use when connecting to JNDI.
jndiProviderPropertiesstring ref
no
Reference to a Map that contains additional provider properties.
connectionFactoryJndiName string
no
The name to use when looking up the connection factory from JNDI.
jndiDestinations
boolean
no
Set this attribute to true if you want to look up queues or topics from JNDI instead of creating them from the session.
forceJndiDestinationsboolean
no
If set to true, Mule fails when a topic or queue cannot be retrieved from JNDI. If set to false, Mule will create a topic or queue from the JMS session if the JNDI lookup fails.
disableTemporaryReplyToDestinations boolean
no
If this is set to false (the default), when Mule performs request/response calls a temporary destination will automatically be set up to receive a response from the remote JMS call.
brokerURL
no
The URL used to connect to the JMS server. If not set, the default is vm://localhost? broker.persistent=false&broker.
string
Activemq Xa Connector The activemq-xa-connector element configures an ActiveMQ version of the JMS connector with XA transaction support.
Document generated by Confluence on Mar 11, 2009 14:57
Page 115
Attributes of
Name
Type
Required
connectionFactoryref
name (no spaces)
no
Optional reference to the connection factory. A default connection factory is provided for vendorspecific JMS configurations.
redeliveryHandlerFactoryname (no spaces) ref
no
Reference to the redelivery handler.
acknowledgementMode AUTO_ACKNOWLEDGE/ no CLIENT_ACKNOWLEDGE/ DUPS_OK_ACKNOWLEDGE
Default
Description
AUTO_ACKNOWLEDGE The acknowledgement mode to use: AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE, or DUPS_OK_ACKNOWLEDGE.
clientId
string
no
The ID of the JMS client.
durable
boolean
no
Whether to make all topic subscribers durable.
noLocal
boolean
no
If set to true, a subscriber will not receive messages that were published by its own connection.
persistentDelivery
boolean
no
If set to true, the JMS provider logs the message to stable storage as it is sent so that it can be recovered if delivery is unsuccessful.
honorQosHeaders
boolean
no
If set to true, the message's QoS headers are honored. If false (the default), the connector settings override the message headers.
maxRedelivery
integer
no
The maximum number of times to try to redeliver a message.
Document generated by Confluence on Mar 11, 2009 14:57
Page 116
cacheJmsSessions
boolean
no
Whether to cache and re-use the JMS session object instead of recreating the connection each time.
eagerConsumer
boolean
no
Whether to create a consumer right when the connection is created instead of using lazy instantiation in the poll loop.
specification
1.0.2b/1.1
no
username
string
no
The user name for the connection
password
string
no
The password for the connection
numberOfConsumersinteger
no
The number of concurrent consumers that will be used to receive JMS messages. (Note: If you use this attribute, you should not configure the 'numberOfConcurrentTransacted which has the same effect.)
jndiInitialFactory
string
no
The initial factory class to use when connecting to JNDI.
jndiProviderUrl
string
no
The URL to use when connecting to JNDI.
jndiProviderPropertiesstring ref
no
Reference to a Map that contains additional provider properties.
connectionFactoryJndiName string
no
The name to use when looking up the connection factory from JNDI.
jndiDestinations
no
Set this attribute to true if you want
boolean
Document generated by Confluence on Mar 11, 2009 14:57
1.0.2b
The JMS specification to use: 1.0.2b (the default) or 1.1
Page 117
to look up queues or topics from JNDI instead of creating them from the session. forceJndiDestinationsboolean
no
If set to true, Mule fails when a topic or queue cannot be retrieved from JNDI. If set to false, Mule will create a topic or queue from the JMS session if the JNDI lookup fails.
disableTemporaryReplyToDestinations boolean
no
If this is set to false (the default), when Mule performs request/response calls a temporary destination will automatically be set up to receive a response from the remote JMS call.
brokerURL
no
The URL used to connect to the JMS server. If not set, the default is vm://localhost? broker.persistent=false&broker.
string
Weblogic Connector The weblogic-connector element configures a WebLogic version of the JMS connector.
Attributes of <weblogic-connector...>
Name
Type
Required
connectionFactoryref
name (no spaces)
no
Optional reference to the connection factory. A default connection factory is provided for vendorspecific JMS configurations.
redeliveryHandlerFactoryname (no spaces) ref
no
Reference to the redelivery handler.
acknowledgementMode AUTO_ACKNOWLEDGE/ no CLIENT_ACKNOWLEDGE/ DUPS_OK_ACKNOWLEDGE
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
AUTO_ACKNOWLEDGE The acknowledgement mode to use: AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE,
Page 118
or DUPS_OK_ACKNOWLEDGE. clientId
string
no
The ID of the JMS client.
durable
boolean
no
Whether to make all topic subscribers durable.
noLocal
boolean
no
If set to true, a subscriber will not receive messages that were published by its own connection.
persistentDelivery
boolean
no
If set to true, the JMS provider logs the message to stable storage as it is sent so that it can be recovered if delivery is unsuccessful.
honorQosHeaders
boolean
no
If set to true, the message's QoS headers are honored. If false (the default), the connector settings override the message headers.
maxRedelivery
integer
no
The maximum number of times to try to redeliver a message.
cacheJmsSessions
boolean
no
Whether to cache and re-use the JMS session object instead of recreating the connection each time.
eagerConsumer
boolean
no
Whether to create a consumer right when the connection is created instead of using lazy instantiation in the poll loop.
specification
1.0.2b/1.1
no
Document generated by Confluence on Mar 11, 2009 14:57
1.0.2b
The JMS specification to use: 1.0.2b (the default) or 1.1
Page 119
username
string
no
The user name for the connection
password
string
no
The password for the connection
numberOfConsumersinteger
no
The number of concurrent consumers that will be used to receive JMS messages. (Note: If you use this attribute, you should not configure the 'numberOfConcurrentTransacted which has the same effect.)
jndiInitialFactory
string
no
The initial factory class to use when connecting to JNDI.
jndiProviderUrl
string
no
The URL to use when connecting to JNDI.
jndiProviderPropertiesstring ref
no
Reference to a Map that contains additional provider properties.
connectionFactoryJndiName string
no
The name to use when looking up the connection factory from JNDI.
jndiDestinations
boolean
no
Set this attribute to true if you want to look up queues or topics from JNDI instead of creating them from the session.
forceJndiDestinationsboolean
no
If set to true, Mule fails when a topic or queue cannot be retrieved from JNDI. If set to false, Mule will create a topic or queue from the JMS session if the JNDI lookup fails.
disableTemporaryReplyToDestinations boolean
no
If this is set to false (the default), when Mule performs request/response
Document generated by Confluence on Mar 11, 2009 14:57
Page 120
calls a temporary destination will automatically be set up to receive a response from the remote JMS call.
Websphere Connector The websphere-connector element configures a WebSphere version of the JMS connector.
Attributes of <websphere-connector...>
Name
Type
Required
connectionFactoryref
name (no spaces)
no
Optional reference to the connection factory. A default connection factory is provided for vendorspecific JMS configurations.
redeliveryHandlerFactoryname (no spaces) ref
no
Reference to the redelivery handler.
acknowledgementMode AUTO_ACKNOWLEDGE/ no CLIENT_ACKNOWLEDGE/ DUPS_OK_ACKNOWLEDGE
Default
Description
AUTO_ACKNOWLEDGE The acknowledgement mode to use: AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE, or DUPS_OK_ACKNOWLEDGE.
clientId
string
no
The ID of the JMS client.
durable
boolean
no
Whether to make all topic subscribers durable.
noLocal
boolean
no
If set to true, a subscriber will not receive messages that were published by its own connection.
persistentDelivery
boolean
no
If set to true, the JMS provider logs the message to stable storage as it is sent so that it can be recovered if delivery is unsuccessful.
Document generated by Confluence on Mar 11, 2009 14:57
Page 121
honorQosHeaders
boolean
no
If set to true, the message's QoS headers are honored. If false (the default), the connector settings override the message headers.
maxRedelivery
integer
no
The maximum number of times to try to redeliver a message.
cacheJmsSessions
boolean
no
Whether to cache and re-use the JMS session object instead of recreating the connection each time.
eagerConsumer
boolean
no
Whether to create a consumer right when the connection is created instead of using lazy instantiation in the poll loop.
specification
1.0.2b/1.1
no
username
string
no
The user name for the connection
password
string
no
The password for the connection
numberOfConsumersinteger
no
The number of concurrent consumers that will be used to receive JMS messages. (Note: If you use this attribute, you should not configure the 'numberOfConcurrentTransacted which has the same effect.)
jndiInitialFactory
no
The initial factory class to use when connecting to JNDI.
string
Document generated by Confluence on Mar 11, 2009 14:57
1.0.2b
The JMS specification to use: 1.0.2b (the default) or 1.1
Page 122
jndiProviderUrl
string
no
The URL to use when connecting to JNDI.
jndiProviderPropertiesstring ref
no
Reference to a Map that contains additional provider properties.
connectionFactoryJndiName string
no
The name to use when looking up the connection factory from JNDI.
jndiDestinations
boolean
no
Set this attribute to true if you want to look up queues or topics from JNDI instead of creating them from the session.
forceJndiDestinationsboolean
no
If set to true, Mule fails when a topic or queue cannot be retrieved from JNDI. If set to false, Mule will create a topic or queue from the JMS session if the JNDI lookup fails.
disableTemporaryReplyToDestinations boolean
no
If this is set to false (the default), when Mule performs request/response calls a temporary destination will automatically be set up to receive a response from the remote JMS call.
Transaction The transaction element configures a transaction. Transactions allow a series of operations to be grouped together so that they can be rolled back if a failure occurs. Set the action (such as ALWAYS_BEGIN or JOIN_IF_POSSIBLE) and the timeout setting for the transaction.
Client Ack Transaction The client-ack-transaction element configures a client acknowledgment transaction, which is identical to a transaction but with message acknowledgements. There is no notion of rollback with client acknowledgement, but this transaction can be useful for controlling how messages are consumed from a destination.
Document generated by Confluence on Mar 11, 2009 14:57
Page 123
Jmsmessage To Object Transformer The jmsmessage-to-object-transformer element configures a transformer that converts a JMS message into an object by extracting the message payload.
Object To Jmsmessage Transformer The object-to-jmsmessage-transformer element configures a transformer that converts an object into one of five types of JMS messages, depending on the object passed in: java.lang.String -> javax.jms.TextMessage, byte[] -> javax.jms.BytesMessage, java.util.Map -> javax.jms.MapMessage, java.io.InputStream -> javax.jms.StreamMessage, and java.lang.Object -> javax.jms.ObjectMessage.
Inbound Endpoint The inbound-endpoint element configures an endpoint on which JMS messages are received.
Attributes of
Name
Type
Required
queue
string
no
The queue name. This attribute cannot be used with the topic attribute (the two are exclusive).
topic
string
no
The topic name. The "topic:" prefix will be added automatically. This attribute cannot be used with the queue attribute (the two are exclusive).
no
If this is set to false (the default), when Mule performs request/response calls a temporary destination will automatically be set up to receive a response from the remote JMS call.
disableTemporaryReplyToDestinations boolean
Default
Description
Outbound Endpoint The inbound-endpoint element configures an endpoint to which JMS messages are sent.
Attributes of
Name
Type
Required
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 124
queue
string
no
The queue name. This attribute cannot be used with the topic attribute (the two are exclusive).
topic
string
no
The topic name. The "topic:" prefix will be added automatically. This attribute cannot be used with the queue attribute (the two are exclusive).
no
If this is set to false (the default), when Mule performs request/response calls a temporary destination will automatically be set up to receive a response from the remote JMS call.
disableTemporaryReplyToDestinations boolean
Endpoint The endpoint element configures a global JMS endpoint definition.
Attributes of <endpoint...>
Name
Type
Required
queue
string
no
The queue name. This attribute cannot be used with the topic attribute (the two are exclusive).
topic
string
no
The topic name. The "topic:" prefix will be added automatically. This attribute cannot be used with the queue attribute (the two are exclusive).
no
If this is set to false (the default), when Mule performs request/response calls a temporary
disableTemporaryReplyToDestinations boolean
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 125
destination will automatically be set up to receive a response from the remote JMS call.
Property Filter The property-filter element configures a filter that allows you to filter messages based on a JMS property.
Attributes of <property-filter...>
Name
Type
Required
propertyName
string
no
The name of the JMS property.
propertyClass
string
no
The class type of the JMS property.
expression
string
no
The expression to search for in the property.
pattern
string
no
The regular expression pattern to search for in the property. In most cases, if you set both the expression and pattern attributes, only the pattern is used.
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 126
Mule WMQ Transport This page last changed on Mar 06, 2009 by jackie.wheeler.
Mule WMQ Transport [ Setting Up the Mule WMQ Transport ] [ Messaging Use Cases ] [ Sending Messages on a Local Queue ] [ Sending Messages on a Remote Queue ] [ Inbound Message Handling ] [ Outbound Message Handling ] [ Retrieving the Connection Factory from JNDI ] [ Known Limitations ] The Mule Enterprise transport for IBM® WebSphere® MQ (Mule WMQ transport) provides the following functionality: • Bi-directional request-response messaging between Websphere MQ and Mule JMS using native MQ point-to-point. • Synchronous and asynchronous request-response communications using JMSReplyTo. This page describes how to configure and use this transport and its connector. It assumes that you already understand how to configure and use WebSphere MQ. For complete information on MQ, refer to the MQ Information Center.
Setting Up the Mule WMQ Transport The Mule WMQ transport is available only with Mule Enterprise Edition version 1.6 or later. For information on connecting to WebSphere MQ using the JMS transport, which does not support native MQ but is available with the community edition of Mule, see WebSphere MQ Integration. In Mule 2.x, before you can use the Mule WMQ transport, you must copy the JAR files from the java/lib directory under your WebSphere MQ home directory into the lib/user directory under your Mule home directory. For example, on UNIX you would type the following at the command prompt: cp $WMQ_HOME/java/lib/*.jar $MULE_HOME/lib/user
Messaging Use Cases This section describes the typical use cases for using the Mule WMQ transport.
Sending Messages on a Local Queue The configuration describes a flow where a service mqSender takes input interactively from the command line and sends it to a native WebSphere MQ endpoint (mqs://REQUEST.QUEUE). Another service, mqReceiver, picks up the message from this endpoint and echoes it back to another native WebSphere MQ endpoint, mqs://RESPONSE.QUEUE. Configuring request-response behavior requires the following settings: • The JMSReplyTo property must be set on the outbound side of the mqSender. • The message type (JMS_IBM_MsgType) property must be set to com.ibm.mq.MQC.MQMT_REQUEST on the outbound side of the mqSender service. • The message type (JMS_IBM_MsgType) property must be set to com.ibm.mq.MQC.MQMT_REPLY on the inbound side of the mqReceiverservice. • To support local queues, the transportType property in the MQJMSConnector declaration must be set to JMSC.MQJMS_TP_BINDINGS_MQ. By default, messages sent from Mule to MQ are sent in native format, and JMS (RFH2) headers are suppressed. This configuration is applied transparently to the configuration below by the connector appending a parameter to the MQ destination URI (?targetClient=1). To force JMS behaviour
Document generated by Confluence on Mar 11, 2009 14:57
Page 127
on the receiving MQ (that is, to use non-native format), use the following attribute setting in the MQJMSConnector declaration:
<mqs:connector name="..." ... targetClient="JMS_COMPLIANT" ... />
Note the following additional points about the configuration: • The mqs URI scheme for endpoints indicates that the MQ transport should be used. • The queueManager property in the MQJMSConnector declaration matches the MQ QueueManager set up previously. • The local queues REQUEST.QUEUE and RESPONSE.QUEUE were set up previously using the runmqsc utility.
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:spring="http://www.springframework.org/schema/beans" xmlns:stdio="http://www.mulesource.org/schema/mule/stdio/2.1" xmlns:vm="http://www.mulesource.org/schema/mule/vm/2.1" xmlns:mqs="http://www.mulesource.com/schema/mule/mqseries/2.1" xsi:schemaLocation=" http://www.mulesource.com/schema/mule/mqseries/2.1 http://www.mulesource.com/schema/mule/ mqseries/2.1/mule-mqseries-ee.xsd http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/springbeans-2.0.xsd http://www.mulesource.org/schema/mule/core/2.1 http://www.mulesource.org/schema/mule/core/2.1/ mule.xsd http://www.mulesource.org/schema/mule/stdio/2.1 http://www.mulesource.org/schema/mule/stdio/2.1/ mule-stdio.xsd http://www.mulesource.org/schema/mule/vm/2.1 http://www.mulesource.org/schema/mule/vm/2.1/mulevm.xsd"> <spring:bean name="connectionFactory" class="com.ibm.mq.jms.MQConnectionFactory"/> <mqs:connector name="wmqConnector" hostName="winter" port="1414" queueManager="HELLO.QMGR" transportType="BINDINGS_MQ" targetClient="NONJMS_MQ" specification="1.1" username="" password="" disableReplyToHandler="true" connectionFactory-ref="connectionFactory"> <stdio:connector name="stdioConnector" messageDelayTime="1000" promptMessage="Please enter something: "/> <model name="WMQ_Example"> <service name="mqSender"> <stdio:inbound-endpoint system="IN"/> <echo-component/>
Document generated by Confluence on Mar 11, 2009 14:57
Page 128
<pass-through-router> <property key="JMSReplyTo" value="RESPONSE.QUEUE"/> <property key="JMS_IBM_MsgType" value="1"/> <service name="mqReceiver"> <property key="JMS_IBM_MsgType" value="2"/> <echo-component/>
The following log output demonstrates the message flow:
INFO 2008-04-10 13:59:21,472 [WrapperListener_start_runner] org.mule.MuleServer: Mule Server initialized. Please enter something: Hello INFO 2008-04-10 13:59:56,450 [mqSender.2] org.mule.components.simple.LogComponent: ******************************************************************************** * Message received in component: mqSender. Content is: 'Hello' * ******************************************************************************** INFO 2008-04-10 13:59:56,464 [MQJMSConnector.dispatcher.1] org.mule.providers.mqseries.MQSeriesMessageDispatcher: Connected: MQSeriesMessageDispatcher{this=504ec1, endpoint=mqs://REQUEST.QUEUE} INFO 2008-04-10 13:59:56,486 [mqReceiver.2] org.mule.components.simple.LogComponent: ******************************************************************************** * Message received in component: mqReceiver. Content is: 'Hello' * ******************************************************************************** INFO 2008-04-10 13:59:56,487 [mqReceiver.2] org.mule.providers.DefaultReplyToHandler: Reply Message sent to: queue://HELLO.QMGR/RESPONSE.QUEUE? targetClient=1 Please enter something:
The following environment variable needs to be set for Mule to run successfully when the WMQ connector functionality has been configured.
export LD_LIBRARY_PATH=/opt/mqm/java/lib
You must set this variable to the location of the Java library directory shipped with the MQ server installation.
Sending Messages on a Remote Queue This use case describes sending a Mule message to a WebSphere MQ QueueManager on a different machine. After configuring WebSphere MQ with the appropriate queue and channel definitions, you configure Mule as follows:
Document generated by Confluence on Mar 11, 2009 14:57
Page 129
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:spring="http://www.springframework.org/schema/beans" xmlns:stdio="http://www.mulesource.org/schema/mule/stdio/2.1" xmlns:vm="http://www.mulesource.org/schema/mule/vm/2.1" xmlns:mqs="http://www.mulesource.com/schema/mule/mqseries/2.1" xsi:schemaLocation=" http://www.mulesource.com/schema/mule/mqseries/2.1 http://www.mulesource.com/schema/mule/ mqseries/2.1/mule-mqseries-ee.xsd http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/springbeans-2.0.xsd http://www.mulesource.org/schema/mule/core/2.1 http://www.mulesource.org/schema/mule/core/2.1/ mule.xsd http://www.mulesource.org/schema/mule/stdio/2.1 http://www.mulesource.org/schema/mule/stdio/2.1/ mule-stdio.xsd http://www.mulesource.org/schema/mule/vm/2.1 http://www.mulesource.org/schema/mule/vm/2.1/mulevm.xsd"> <spring:bean name="connectionFactory" class="com.ibm.mq.jms.MQConnectionFactory"/> <mqs:connector name="wmqConnector" hostName="winter" port="1414" queueManager="HELLO.QMGR" channel="HELLO.CHANNEL" transportType="CLIENT_MQ_TCPIP" targetClient="NONJMS_MQ" specification="1.1" username="" password="" disableReplyToHandler="true" connectionFactory-ref="connectionFactory"> <stdio:connector name="stdioConnector" messageDelayTime="1000" promptMessage="Please enter something: "/> <model name="MQ_Example"> <service name="mqSender"> <stdio:inbound-endpoint system="IN"/> <echo-component/> <pass-through-router> <property key="JMSReplyTo" value="RESPONSE.QUEUE"/> <property key="JMS_IBM_MsgType" value="1"/>
Note the channel configuration. This is how WebSphere MQ knows to send it to the remotely hosted queue. Mule sends the message as follows:
Document generated by Confluence on Mar 11, 2009 14:57
Page 130
INFO 2008-04-14 15:29:27,572 [WrapperListener_start_runner] org.mule.MuleServer: Mule Server initialized. Please enter something: Hello INFO 2008-04-14 15:29:30,389 [mqSender.2] org.mule.components.simple.LogComponent: ******************************************************************************** * Message received in component: mqSender. Content is: 'Hello' * ******************************************************************************** INFO 2008-04-14 15:29:30,403 [MQJMSConnector.dispatcher.1] org.mule.providers.mqseries.MQSeriesMessageDispatcher: Connected: MQSeriesMessageDispatcher{this=1672bbb, endpoint=mqs://LOCAL.DEF.OF.REMOTE.QUEUE} Please enter something:
On the receiving side:
[mqm@spring ~]$ /opt/mqm/samp/bin/amqsget ORANGE.QUEUE Sample AMQSGET0 start message no more messages Sample AMQSGET0 end
You can use a the WebSphere MQ utility amqsget to verify the message was received on the remote queue.
Inbound Message Handling The inbound messages are received by the connector and delivered to the component. If the disableReplyToHandler property of the connector is not set to true and the inbound message type is MQMT_REQUEST, the message returned by the component will be sent to the queue specified in the JMSReplyTo property of the original message. However, if the outbound MQ endpoint exists in the component, it will override the replyToHandler functionality. By default, disableReplyToHandler is set to false.
Document generated by Confluence on Mar 11, 2009 14:57
Page 131
Outbound Message Handling The outbound endpoint behavior depends on the MQ message type specified in the JMS_IBM_MsgType endpoint property. If the value of the property is set to MQMT_REPLY or MQMT_DATAGRAM, other properties will be copied over from the original message and the message will be dispatched to the queue. If the message type is MQMT_REQUEST, the connector will check the existence of JMSReplyTo property on the endpoint. If the property is not set, the temporary queue will be created. If the endpoint is synchronous, the connector will wait for a response. The timeout can be set using the responseTimeout setting. If a response is received by the connector, it will be returned by the component.
Document generated by Confluence on Mar 11, 2009 14:57
Page 132
Retrieving the Connection Factory from JNDI The connection factory can be loaded explicitly by the connector or from a JNDI registry. To support the explicit case, the following configuration must be included in the connector declaration:
<spring:bean name="connectionFactory" class="com.ibm.mq.jms.MQConnectionFactory"/> <mqs:connector ... connectionFactory-ref="connectionFactory"/>
To support the case where a JNDI registry has been configured to store the connection factory, the connector declaration should include the following parameters. This is the same as the regular JMS transport documented here .
<mqs:connector ... jndiInitialFactory="com.sun.jndi.ldap.LdapCtxFactory" jndiProviderUrl="ldap://localhost:10389/" connectionFactoryJndiName="cn=ConnectionFactory,dc=example,dc=com"
Document generated by Confluence on Mar 11, 2009 14:57
Page 133
Known Limitations The Mule WMQ transport has been implemented as an extension to the JMS transport and has limited functionality and support for native WebSphere MQ. Following are the features that the Mule WMQ transport does not currently support: • • • • • • • • •
Durable topic subscription support Local and XA transactions Exit handler support MQMT_REPORT message type support Native WMQ connection pool support SSL connection support Data compression over channels (for performance throughput gain) JMS persistent delivery JMS 1.1 feature set certification
Document generated by Confluence on Mar 11, 2009 14:57
Page 134
Multicast Transport This page last changed on Mar 04, 2009 by jackie.wheeler.
Multicast Transport The Multicast transport sends and receives Mule events using IP multicasting. The Javadoc for this transport can be found here .
Connector The Multicast element extends the UDP connector with additional optional attributes:
Attribute
Description
timeToLive
Set the time-to-live value for Multicast packets to control their scope. It must be in the range 0 to 255 (inclusive).
loopback
Whether to enable local loopback of Multicast datagrams. The option is used by the platform networking code as a hint for setting whether Multicast data will be looped back to the local socket.
Endpoints You configure Multicast endpoints just as you would with any other transport, with the following additional attributes: • host: the IP address of the server, such as www.mulesource.com, localhost, or 127.0.0.1 • port: the port number of the server. For example, you could configure a global endpoint as follows: <multicast:endpoint host="224.0.0.1" port="60131" name="serverEndpoint" />
Transformers The following transformers are used by default for this connector unless a transformer is explicitly set on the provider.
Transformer
Description
ByteArrayToString
Converts a byte array to a String
StringToByteArray
Converts a String to a byte array
Document generated by Confluence on Mar 11, 2009 14:57
Page 135
POP3S Transport This page last changed on Sep 19, 2008 by jackie.wheeler.
POP3S Transport TLS/SSL connections are made on behalf of an entity, which can be anonymous or identified by a certificate. The key store provides the certificates and associated private keys necessary for identifying the entity making the connection. Additionally, connections are made to trusted systems. The public certificates of trusted systems are stored in a trust store, which is used to verify that the connection made to a remote system matches the expected identity. The POP3s connector enables POP3 over SSL using the javax.mail APIs. It supports all the elements and attributes of the POP3 connector plus some required properties for setting up the client key store and the trust store for the SSL connection.
Property
Description
tls-client
Configures the client key store with the following attributes: • path: The location (which will be resolved relative to the current classpath and file system, if possible) of the keystore that contains public certificates and private keys for identification • storePassword: The password used to protect the keystore • class: The type of keystore used (a Java class name)
tls-trust-store
Configures the trust store. The attributes are: • path: The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store that contains public certificates of trusted servers • storePassword: The password used to protect the trust store
For example:
<pop3s:connector name="pop3sConnector"> <pop3s:tls-client path="clientKeystore" storePassword="mulepassword" /> <pop3s:tls-trust-store path="greenmail-truststore" storePassword="password" /> <model name="test"> <service name="relay"> <pop3s:inbound-endpoint user="bob" password="password" host="localhost" port="65436" /> ...
For information on configuring endpoints using the POP3S connector, see POP3 Transport. The POP3S transport supports the same filters and transformers as the Email Transport.
Document generated by Confluence on Mar 11, 2009 14:57
Page 136
POP3 Transport This page last changed on Nov 26, 2008 by jackie.wheeler.
POP3 Transport The POP3 transport can be used for receiving messages from POP3 inboxes. The POP3S Transport connects to POP3 mailboxes using SSL (POP3s) using the javax.mail API. The POP3 transport uses the same filters and transformers as the Email Transport. The Javadoc for this provider can be found here .
POP3 Connector The POP3 connector supports all the common connector attributes and properties and the following additional attributes:
Attribute
Description
Default
Required
backupEnabled
Whether to save copies to the backup folder.
False
No
backupFolder
The folder where messages are moved for audit purposes after they have been read.
checkFrequency
Determines how often (in milliseconds) the POP3 mailbox is polled for new messages.
60000
Yes
mailboxFolder
The remote folder to check for email.
INBOX
No
deleteReadMessages
Whether to delete messages after they have been downloaded. If set to false, the messages are set to SEEN.
true
No
No
Endpoints POP3 and POP3S endpoints include details about connecting to a POP3 mailbox. You configure the endpoints just as you would with any other transport, with the following additional attributes: • • • •
user: the user name of the mailbox owner password: the password of the user host: the IP address of the POP3 server, such as www.mulesource.com, localhost, or 127.0.0.1 port: the port number of the POP3 server. If not set for the POP3S connector, the default port is 995.
For example: <pop3:inbound-endpoint user="bob" password="foo" host="pop.gmail.com" checkFrequency="3000" />
or: <pop3s:inbound-endpoint user="bob" password="foo" host="pop.gmail.com" checkFrequency="3000" />
Document generated by Confluence on Mar 11, 2009 14:57
Page 137
This will log into the bob mailbox on pop.gmail.com using password foo (using the default port 995 for the POP3S endpoint) and will check the mailbox for new messages every 30 seconds. You can also specify the endpoint settings using a URI, but the above syntax is easier to read. Escape Your Credentials If you use a URI-style endpoint and you include the user name and password, escape any characters that are illegal for URIs, such as the @ character. For example, if the user name is [email protected], you should enter it as user%40myco.com.
Document generated by Confluence on Mar 11, 2009 14:57
Page 138
Quartz Transport This page last changed on Mar 02, 2009 by jackie.wheeler.
Quartz Transport [ About Cron Expressions ] [ About Jobs ] [ Connector ] [ Outbound Endpoint ] [ Inbound Endpoint ] [ Endpoint ] [ Abstract Job ] [ Abstract Inbound Job ] [ Event Generator Job ] [ Endpoint Polling Job ] [ Scheduled Dispatch Job ] [ Custom Job ] [ Custom Job From Message ] The Quartz transport provides support for scheduling events and for triggering new events. An inbound quartz endpoint can be used to trigger inbound events that can be repeated, such as every second. Outbound quartz endpoints can be used to schedule an existing event to fire at a later date. Users can create schedules using cron expressions, and events can be persisted in a database. This transport makes use of the Quartz Project at Open Symphony. The Quartz site has more generic information about how to work with Quartz.
About Cron Expressions A cron expression is a string comprised by six or seven fields separated by white space. Fields can contain any of the allowed values, along with various combinations of the allowed special characters for that field. The fields are as follows:
Field Name
Mandatory
Allowed Values
Allowed Special Chars
Seconds
YES
0-59
,-*/
Minutes
YES
0-59
,-*/
Hours
YES
0-23
,-*/
Day of Month
YES
1-31
,-*?/LWC
Month
YES
1-12 or JAN-DEC
,-*/
Day of Week
YES
1-7 or SUN-SAT
,-*?/LC#
Year
NO
empty, 1970-2099
,-*/
Cron expressions can be as simple as this: * * * * ? * or more complex, like this: 0 0/5 14,18,3-39,52 ? JAN,MAR,SEP MON-FRI 2002-2010. Following are some examples:
Expression
Behavior
0 0 12 * * ?
Fire at 12pm (noon) every day
0 15 10 ? * *
Fire at 10:15am every day
0 15 10 * * ?
Fire at 10:15am every day
0 15 10 * * ? *
Fire at 10:15am every day
Document generated by Confluence on Mar 11, 2009 14:57
Page 139
0 15 10 * * ? 2005
Fire at 10:15am every day during the year 2005
0 * 14 * * ?
Fire every minute starting at 2pm and ending at 2:59pm, every day
0 0/5 14 * * ?
Fire every 5 minutes starting at 2pm and ending at 2:55pm, every day
If you are not familiar with cron syntax, here is a good tutorial.
About Jobs Jobs are used to perform an action when a time trigger occurs from the Quartz transport. Mule provides a number of jobs for generating and scheduling events. These are detailed below. Users can also write their own jobs and hook them in using the custom-job type included with Mule.
Connector The Quartz connector is used to configure the default behavior for Quartz endpoints that reference the connector. Note if there is only one Quartz connector configured, all Quartz endpoints will use that connector.
Attributes of
Name
Type
Required
scheduler-ref
name (no spaces)
no
Default
Description Provides an implementation of the Quartz Scheduler interface. If no value is provided, a scheduler is retrieved from the StdSchedulerFactory. If no properties are provided, the getDefaultScheduler method is called. Otherwise, a new factory instance is created using the given properties, and a scheduler is retrieved using the getScheduler method.
Child Elements of
Name
Cardinality
Description
factory-property
0..*
Set a property on the factory (see scheduler-ref).
Document generated by Confluence on Mar 11, 2009 14:57
Page 140
Outbound Endpoint An outbound Quartz endpoint allows existing events to be stored and fired at a later time/date. If you are using a persistent event store, the payload of the event must implement java.io.Serializable. You configure an org.quartz.Job implementation on the endpoint to tell it what action to take. Mule has some default jobs, but you can also write your own.
Attributes of
Name
Type
Required
Default
Description
jobName
string
no
The name to associate with the job on the endpoint. This is only really used internally when storing events.
cronExpression
string
no
The cron expression to schedule events at specified dates/times. This attribute or repeatInterval is required.
repeatInterval
long
no
The number of milliseconds between two events. This attribute or cronExpression is required.
repeatCount
integer
no
The number of events to be scheduled. This value defaults to -1, which means that the events will be scheduled indefinitely.
startDelay
long
no
The number of milliseconds that will elapse before the first event is fired.
Child Elements of
Name
Cardinality
Description
abstract-job
1..1
A placeholder for Quartz jobs that can be set on the endpoint.
Document generated by Confluence on Mar 11, 2009 14:57
Page 141
Inbound Endpoint A Quartz inbound endpoint can be used to generate events. It is most useful when you want to trigger a service at a given interval (or cron expression) rather than have an external event trigger the service.
Attributes of
Name
Type
Required
Default
Description
jobName
string
no
The name to associate with the job on the endpoint. This is only really used internally when storing events.
cronExpression
string
no
The cron expression to schedule events at specified dates/times. This attribute or repeatInterval is required.
repeatInterval
long
no
The number of milliseconds between two events. This attribute or cronExpression is required.
repeatCount
integer
no
The number of events to be scheduled. This value defaults to -1, which means that the events will be scheduled indefinitely.
startDelay
long
no
The number of milliseconds that will elapse before the first event is fired.
Child Elements of
Name
Cardinality
Description
abstract-job
1..1
A placeholder for Quartz jobs that can be set on the endpoint.
Document generated by Confluence on Mar 11, 2009 14:57
Page 142
Endpoint A global endpoint that can be used as a template to create inbound and outbound Quartz endpoints. Common configuration can be set on a global endpoint and then referenced using the @ref attribute on the local endpoint. Note that because jobs sometimes only work on inbound or outbound endpoints, they have to be set on the local endpoint.
Attributes of <endpoint...>
Name
Type
Required
Default
Description
jobName
string
no
The name to associate with the job on the endpoint. This is only really used internally when storing events.
cronExpression
string
no
The cron expression to schedule events at specified dates/times. This attribute or repeatInterval is required.
repeatInterval
long
no
The number of milliseconds between two events. This attribute or cronExpression is required.
repeatCount
integer
no
The number of events to be scheduled. This value defaults to -1, which means that the events will be scheduled indefinitely.
startDelay
long
no
The number of milliseconds that will elapse before the first event is fired.
Child Elements of <endpoint...>
Name
Cardinality
Description
abstract-job
0..1
A placeholder for Quartz jobs that can be set on the endpoint.
Document generated by Confluence on Mar 11, 2009 14:57
Page 143
Abstract Job A placeholder for Quartz jobs that can be set on the endpoint.
Attributes of
Name
Type
Required
Default
Description
groupName
string
no
The group name of the scheduled job
jobGroupName
string
no
The job group name of the scheduled job.
Abstract Inbound Job A placeholder for Quartz jobs that can be set on inbound endpoints only.
Attributes of
Name
Type
Required
Default
Description
groupName
string
no
The group name of the scheduled job
jobGroupName
string
no
The job group name of the scheduled job.
Event Generator Job An inbound endpoint job that will trigger a new event for the service according to the schedule on the endpoint. This is useful for periodically triggering a service without the need for an external event to occur.
Child Elements of <event-generator-job...>
Name
Cardinality
Description
payload
0..1
The payload of the newly created event. The payload can be a reference to a file, fixed string, or object configured as a Spring bean. If this value is not set, an event will be generated with an org.mule.transport.NullPayload instance.
Following is an example:
Document generated by Confluence on Mar 11, 2009 14:57
Page 144
Click here to expand...
<service name="testService1"> <description> This configuration will create an inbound event for testService1 at 12 noon every day. The event payload will always have the same value 'foo'. foo <service name="testService2"> <description> This configuration will create an inbound event for testService2 every 1 second indefinitely. The event payload will always have the same value, which the contents of the file 'payload-data.txt'. The file can be on the classpath of on the local file system.
Endpoint Polling Job An inbound endpoint job that can be used to periodically read from an external source (via another endpoint). This can be useful for triggering time-based events from sources that do not support polling or for simply controlling the rate in which events are received from the source.
Child Elements of <endpoint-polling-job...>
Name
Cardinality
Description
job-endpoint
0..1
A reference to another configured endpoint from which events will be received.
For example: Click here to expand...
<service name="testService5"> <description> The endpoint polling Job will try and perform a 'request' on any Mule endpoint. If a result is received it will be handed off to this 'testService5' service for processing. The trigger will fire every 5 minutes starting at 2pm
Document generated by Confluence on Mar 11, 2009 14:57
Page 145
and ending at 2:55pm, every day. during this period the job will check the file directory /N/drop-data/in every 5 minutes to see if any event data is available. The request will timeout after 4 seconds if there are no files in the directory.
Scheduled Dispatch Job An outbound job that will schedule a job for dispatch at a later time/date. The event will get dispatched using the configured endpoint reference.
Child Elements of <scheduled-dispatch-job...>
Name
Cardinality
Description
job-endpoint
0..1
The endpoint used to dispatch the scheduled event. The preferred approach is to create a global endpoint and reference it using the ref attribute. However, you can also use the address attribute to define a URI endpoint. You can use the timeout attribute to specify an arbitrary time-out value associated with the endpoint that can be used by jobs that block waiting to receive events.
For example: Click here to expand...
<service name="testService6"> <description> This outbound Quartz endpoint will receive an event after the component has processed it and store it in the event store. When the trigger kicks in at 10:15am everyday it will dispatch the event on the endpoint referenced as 'scheduledDispatchEndpoint'. Since the 'repeatCount' is set to 0, the event will only be sent out once. <pass-through-router>
Document generated by Confluence on Mar 11, 2009 14:57
Page 146
Custom Job A custom job can be configured on inbound or outbound endpoints. You can create and configure your own job implementation and use it on a Quartz endpoint. A custom job can be configured as a bean in the XML configuration and referenced using this job.
Attributes of <custom-job...>
Name
Type
Required
Default
Description
groupName
string
no
The group name of the scheduled job
jobGroupName
string
no
The job group name of the scheduled job.
job-ref
string
no
The bean name or ID of the custom job to use when this job gets executed.
For example: Click here to expand...
<service name="testService5"> <description> The endpoint polling Job will try and perform a 'request' on any Mule endpoint. If a result is received it will be handed off to this 'testService5' service for processing. The trigger will fire every 5 minutes starting at 2pm and ending at 2:55pm, every day. during this period the job will check the file directory /N/drop-data/in every 5 minutes to see if any event data is available. The request will timeout after 4 seconds if there are no files in the directory.
Document generated by Confluence on Mar 11, 2009 14:57
Page 147
Custom Job From Message Allows a job to be stored on the current message. This can only be used on outbound endpoints. When the message is received, the job is read and the job is added to the scheduler with the current message. This allows for custom scheduling behavior determined by the message itself. Usually the service or a transformer would create the job on the message based on application-specific logic. Any Mule-supported expressions can be used to read the job from the message. Typically, you add the job as a header, but an attachment could also be used.
Attributes of <custom-job-from-message...>
Name
Type
Required
Default
Description
groupName
string
no
The group name of the scheduled job
jobGroupName
string
no
The job group name of the scheduled job.
For example: Click here to expand...
<service name="testService3"> <description> This configuration will process a message and find a Job configured as a header called 'jobConfig' on the current message. We're using the test component here, but a real implementation will need to set a custom {{org.quartz.Job}} implementation as a header on the current message. Note that other expressions could be used to extract the job from an attachment or even a property within the payload itself. <pass-through-router>
Document generated by Confluence on Mar 11, 2009 14:57
Page 148
RMI Transport This page last changed on Feb 20, 2009 by jackie.wheeler.
RMI Transport The RMI transport can be used to send and receive Mule events over JRMP. This transport has a dispatcher that invokes an RMI method and a polling receiver that repeatedly does the same. You configure the RMI transport as follows:
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:spring="http://www.springframework.org/schema/beans" xmlns:rmi="http://www.mulesource.org/schema/mule/rmi/2.2" xmlns:vm="http://www.mulesource.org/schema/mule/vm/2.2" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/ spring-beans-2.5.xsd http://www.mulesource.org/schema/mule/core/2.2 http://www.mulesource.org/schema/mule/ core/2.2/mule.xsd http://www.mulesource.org/schema/mule/vm/2.2 http://www.mulesource.org/schema/mule/ vm/2.2/mule-vm.xsd http://www.mulesource.org/schema/mule/rmi/2.2 http://www.mulesource.org/schema/mule/ rmi/2.2/mule-rmi.xsd"> <spring:bean name="jndiFactory" class="org.mule.transport.rmi.MuleRMIFactory"/> <spring:bean name="jndiContext" factory-bean="jndiFactory" factory-method="create"/>
The connector looks for the method and methodArgumentTypes. It uses the payload as the argument.
JNP Connector If you want to use the Java naming protocol to bind to remote objects, you can use the JNP connector instead simply by using the jnp namespace.
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:spring="http://www.springframework.org/schema/beans" xmlns:jnp="http://www.mulesource.org/schema/mule/jnp/2.2" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/ spring-beans-2.5.xsd http://www.mulesource.org/schema/mule/core/2.2 http://www.mulesource.org/schema/mule/ core/2.2/mule.xsd http://www.mulesource.org/schema/mule/jnp/2.2 http://www.mulesource.org/schema/mule/ jnp/2.2/mule-jnp.xsd"> <spring:bean name="jndiFactory" class="org.mule.transport.rmi.MuleRMIFactory"/> <spring:bean name="jndiContext" factory-bean="jndiFactory" factory-method="create"/> <jnp:connector name="jnp" jndiContext-ref="jndiContext" securityPolicy="rmi.policy"/>
Document generated by Confluence on Mar 11, 2009 14:57
Page 149
<jnp:endpoint name="Sender2" host="localhost" port="1099" object="MatchingUMO" method="reverseString"/> ...
Configuration Reference Connector Attributes of
Name
Type
Required
Default
Description
pollingFrequency
long
no
Period (ms) between polling connections.
securityManagerref
name (no spaces)
no
Bean reference to the security manager that should be used.
securityPolicy
string
no
The security policy (file name) used to enable connections.
serverClassName
name (no spaces)
no
The target class name.
serverCodebase
string
no
The target method.
Endpoint Attributes of <endpoint...>
Name
Type
Required
host
string
no
The endpoint host name.
port
port number
no
The port number to use when a connection is made.
object
string
no
The class name of the object that is being invoked over RMI.
method
string
no
The name of the method to invoke.
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 150
methodArgumentTypes string
no
Document generated by Confluence on Mar 11, 2009 14:57
Comma separated argument types of the method to invoke. For example, "java.lang.String".
Page 151
Servlet Transport This page last changed on Mar 04, 2009 by jackie.wheeler.
Servlet Transport The Servlet transport provides integration with a servlet implementation. The implementing servlet does the work of receiving a request, and the Servlet transport then hands off the request to any receivers registered with it. There is no notion of a dispatcher for this connector, as it is triggered by a request and may or may not return a response. You specify the servlet URL as part of the connector configuration and then specify the endpoints just like any other HTTP endpoints. The Javadoc for this transport can be found here . For more information about using Mule with servlet containers, see Embedding Mule in a Java Application or Webapp. For information on using the RESTlet connector, click here.
Connector Servlet connector is a channel adapter between Mule and a servlet engine. It allows the MuleReceiverServlet to look up components interested in requests it receives via the servlet container.
Attributes of
Name
Type
servletUrl
Required
Default
no
Description The real URL on which the servlet container is bound. If this is not set, the WSDL may not be generated correctly.
For example: <servlet:connector name="servletConnector" servletUrl="http://localhost:8180/path/" />
You can also specify the servlet URL as part of the endpoint: <servlet:inbound-endpoint path="foo" />
or:
Servlet endpoints are identical to HTTP endpoints with the exception that they use the servlet: prefix instead of http:. For more information, see HTTP Transport.
Document generated by Confluence on Mar 11, 2009 14:57
Page 152
SMTPS Transport This page last changed on Sep 19, 2008 by jackie.wheeler.
SMTPS Transport TLS/SSL connections are made on behalf of an entity, which can be anonymous or identified by a certificate. The key store provides the certificates and associated private keys necessary for identifying the entity making the connection. Additionally, connections are made to trusted systems. The public certificates of trusted systems are stored in a trust store, which is used to verify that the connection made to a remote system matches the expected identity. The SMTPS connector enables SMTP over SSL using the javax.mail APIs. It supports all the elements and attributes of the SMTP connector plus some required properties for setting up the client key store and the trust store for the SSL connection.
Property
Description
tls-client
Configures the client key store with the following attributes: • path: The location (which will be resolved relative to the current classpath and file system, if possible) of the keystore that contains public certificates and private keys for identification • storePassword: The password used to protect the keystore • class: The type of keystore used (a Java class name)
tls-trust-store
Configures the trust store. The attributes are: • path: The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store that contains public certificates of trusted servers • storePassword: The password used to protect the trust store
For example:
<smtps:connector name="smtpsConnector"> <smtps:tls-client path="clientKeystore" storePassword="mulepassword" /> <smtps:tls-trust-store path="greenmail-truststore" storePassword="password" /> <model name="test"> <service name="relay"> <smtps:outbound-endpoint host="localhost" port="65439" to="[email protected]" /> ...
For information on configuring endpoints using the SMTPS connector, see SMTP Transport.
Document generated by Confluence on Mar 11, 2009 14:57
Page 153
The SMTPS transport supports the same filters and transformers as the Email Transport.
Document generated by Confluence on Mar 11, 2009 14:57
Page 154
SMTP Transport This page last changed on Feb 20, 2009 by jackie.wheeler.
SMTP Transport The SMTP transport can be used for sending messages over SMTP using the javax.mail API. See the SMTPS Transport for a secure version. The implementation supports CC/BCC/ReplyTo addresses, attachments, custom Header properties, and customizable authentication. It also provides support for javax.mail.Message transformation. The Javadoc for this transport can be found here .
SMTP Connector The SMTP connector supports all the common connector attributes and properties and the following optional element and attributes:
Attributes
Name
Type
Required
Default
Description
bccAddresses
string
no
Comma separated list of addresses for blind copies.
ccAddresses
string
no
Comma separated list of addresses for copies.
contentType
string
no
Mime type for the outgoing message.
fromAddress
string
no
The from address for the outgoing message.
replyToAddresses
string
no
The reply-to address for the outgoing message.
subject
string
no
The default subject for the outgoing message if none is set in the message.
Document generated by Confluence on Mar 11, 2009 14:57
Page 155
Child Elements
Name
Cardinality
Description
header
1..1
Additional header name and value, added to the message.
For example:
<smtp:connector name="smtpConnector" bccAddresses="[email protected]" ccAddresses="[email protected]" contentType="foo/bar" fromAddress="[email protected]" replyToAddresses="[email protected]" subject="subject"> <smtp:header key="foo" value="bar" /> <smtp:header key="baz" value="boz" />
Endpoints SMTP endpoints describe details about the SMTP server and the recipients of messages sent from the SMTP endpoint. You configure the endpoints just as you would with any other transport, with the following additional attributes:
Attribute
Description
user
The user name of the mailbox owner
password
The password of the user
host
The IP address of the SMTP server, such as www.mulesource.com, localhost, or 127.0.0.1
port
The port number of the SMTP server
to
The destination for the email
from
The address of the sender of the email
subject
The email subject
cc
A comma-separated list of email addresses to copy on this email
bcc
A comma-separated list of email addresses to blind-copy on this email
replyTo
The address used by default if someone replies to the email
For example:
<smtp:outbound-endpoint host="localhost" port="65437" from="[email protected]" to="[email protected]" subject="Please verify your account details"/>
Document generated by Confluence on Mar 11, 2009 14:57
Page 156
If you only need a few attributes, you can specify the endpoint as a URI. However, the above syntax is recommended for easier readability. The URI syntax is as follows: smtp://[user:password@]<smtp server>[MULE::port]?address=
The format is the same for SMTPS: smtps://[user:password@]<smtp server>[MULE::port]?address=
For example: smtp://muletestbox:[email protected][email protected]
This will send mail using smtp.mail.yahoo.co.uk (using the default SMTP port) to the address [email protected]. The SMTP request is authenticated using the username muletestbox and the password 123456. Escape Your Credentials If you use a URI-style endpoint and you include the user name and password, escape any characters that are illegal for URIs, such as the @ character. For example, if the user name is [email protected], you should enter it as user%40myco.com. So far, all configuration has been static, in that you define all the information in the configuration of the endpoint. However, you can set the connector properties to control the settings of the outgoing message. These properties will override the endpoint properties. If you always want to set the email address dynamically, you can leave out the to attribute (or the address parameter if you're using URIs} on the SMTP endpoint.
Document generated by Confluence on Mar 11, 2009 14:57
Page 157
SOAP Transport This page last changed on Dec 18, 2008 by jackie.wheeler.
SOAP Transport The SOAP transport is deprecated and will be desupported in a future release. We recommend that you either use the CXF Transport or the Axis Transport to build web services from now on. The SOAP transport enables your components to be exposed as web services and to act as SOAP clients. The SOAP transport provides support for the CFX and Axis transports. The Javadoc for the SOAP transport can be found here .
Endpoints You configure a SOAP endpoint as follows:
soap:http://localhost:1234/MyService
The actual SOAP stack used to execute this service will be discovered based on the first SOAP stack available on the class path. Alternatively, an implementation can be specified directly.
Transformer The SOAP transport provides a single transformer, http-to-soap-request-transformer, which converts an HTTP GET request into a SOAP request. It does so according to the following template:
<soap:Envelope xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"> <soap:Body> VALUE1 VALUE1 ...
...where namespace is a property on the endpoint, the method is the "method" property set on the message, and the properties are from the HTTP GET request. For example, given the following transformer configuration:
<custom-transformer class="org.mule.transport.soap.transformers.HttpRequestToSoapRequest"> <spring:property name="namespace" value="http://acme.com/hello">
Document generated by Confluence on Mar 11, 2009 14:57
Page 158
...and a GET request of "http://foo.com/hello?method=sayHello&name=Dan&salutation=Bonjour", the following SOAP message would be generated:
<soap:Envelope xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"> <soap:Body> <sayHello xmlns="http://acme.com/hello"> Dan <salutation>Bonjour
Document generated by Confluence on Mar 11, 2009 14:57
Page 159
SSL Transport This page last changed on Feb 20, 2009 by jackie.wheeler.
SSL Transport The SSL transport can be used for secure socket communication using SSL or TLS. The Javadoc for this transport can be found here .
Connector Connects Mule to an SSL socket to send or receive data via the network.
Child Elements of
Name
Cardinality
Description
client
0..1
The client key store. SSL and TLS connections are made on behalf of an entity, which can be anonymous or identified by a certificate. This interface specifies how a keystore can be used to provide the certificates (and associated private keys) necessary for identification.
key-store
0..1
The key store information, including location, key store type, and algorithm.
server
0..1
The server trust store. TLS connections are made to trusted systems - the public certificates of trusted systems are stored in a keystore (called a trust store) and used to verify that the connection made to a remote system really is the expected identity.
protocol-handler
0..1
Configures the global Java protocol handler by setting the java.protocol.handler.pkgs system property.
Endpoint Attributes of <endpoint...>
Name
Type
Required
host
string
no
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 160
port
port number
no
Inbound Endpoint Attributes of
Name
Type
Required
host
string
no
port
port number
no
Default
Description
Default
Description
Outbound Endpoint Attributes of
Name
Type
Required
host
string
no
port
port number
no
To configure the SSL connector:
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ssl="http://www.mulesource.org/schema/mule/ssl/2.2" xsi:schemaLocation="http://www.mulesource.org/schema/mule/core/2.2 http://www.mulesource.org/schema/mule/core/2.2/mule.xsd http://www.mulesource.org/schema/mule/ssl/2.2 http://www.mulesource.org/schema/mule/ssl/2.2/mule-ssl.xsd"> <ssl:connector name="SslConnector" keepSendSocketOpen="true"> <ssl:client path="clientKeyStore" storePassword="mulepassword" /> <ssl:key-store path="serverKeystore" storePassword="mulepassword" keyPassword="mulepassword" /> <ssl:server path="trustStore" storePassword="mulepassword" /> <endpoint name="sendEndpoint" address="ssl://localhost:60198" synchronous="true" /> ...
To configure the TLS connector instead of the SSL connector, specify the tls namespace and schema, configure the connector, and then use the tls prefix for endpoints:
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tls="http://www.mulesource.org/schema/mule/tls/2.2" xsi:schemaLocation="http://www.mulesource.org/schema/mule/core/2.2 http://www.mulesource.org/schema/mule/core/2.2/mule.xsd http://www.mulesource.org/schema/mule/tls/2.2 http://www.mulesource.org/schema/mule/tls/2.2/mule-tls.xsd">
Document generated by Confluence on Mar 11, 2009 14:57
Page 161
...
Document generated by Confluence on Mar 11, 2009 14:57
Page 162
STDIO Transport This page last changed on Feb 20, 2009 by jackie.wheeler.
STDIO Transport The STDIO Transport allows the reading and writing of streaming data to Java's System.out and System.in objects for debugging.
Connector Attributes of
Name
Type
Required
messageDelayTime
long
no
Delay in milliseconds before printing the prompt to stdout.
outputMessage
string
no
Text printed to stdout when a message is sent.
promptMessage
string
no
Text printed to stdout when waiting for input.
promptMessageCode string
no
Code used to retrieve prompt message from resource bundle.
outputMessageCode string
no
Code used to retrieve output message from resource bundle.
resourceBundle
no
Resource bundle to provide prompt with promptMessageCode.
string
Default
Description
To configure the STDIO connector:
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:spring="http://www.springframework.org/schema/beans" xmlns:stdio="http://www.mulesource.org/schema/mule/stdio/2.2" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd http://www.mulesource.org/schema/mule/core/2.2 http://www.mulesource.org/schema/mule/core/2.2/mule.xsd http://www.mulesource.org/schema/mule/stdio/2.2 http://www.mulesource.org/schema/mule/stdio/2.2/mule-stdio.xsd"> <stdio:connector name="stdioConnector" messageDelayTime="1234" outputMessage="abc" promptMessage="bcd" promptMessageCode="456" resourceBundle="dummy-messages" />
Document generated by Confluence on Mar 11, 2009 14:57
Page 163
<model name="model"> <service name="service"> <stdio:inbound-endpoint name="in" system="IN" connector-ref="stdioConnector" /> <multicasting-router> <stdio:outbound-endpoint name="out" system="OUT" connector-ref="stdioConnector" /> <stdio:outbound-endpoint name="err" system="ERR" connector-ref="stdioConnector" />
Transformers There are no built-in transformers for the STDIO transport.
Internationalizing Messages If you are internationalizing your application, you can also internationalize the promptMessages and outputMessages for the STDIO connector. (This assumes that you have already created a resource bundle that contains your messages as described on that page.) To internationalize, you must specify both the resourceBundle parameter and the promptMessageCode and/or outputMessageCode parameters. The resourceBundle parameter will contain the key to the resource bundle itself. The promptMessageCode provides the key to the message in the bundle for the prompt message. In the snippet above, the "dummy-messages" resource bundle means that the prompt message "456" will be expected in the bundle META-INF/services/org/mule/i18n/dummymessages.properties.
Document generated by Confluence on Mar 11, 2009 14:57
Page 164
TCP Transport This page last changed on Mar 04, 2009 by jackie.wheeler.
TCP Transport [ Connector ] [ Streaming Protocol ] [ Xml Protocol ] [ Xml Eof Protocol ] [ Eof Protocol ] [ Direct Protocol ] [ Safe Protocol ] [ Length Protocol ] [ Custom Protocol ] [ Inbound Endpoint ] [ Outbound Endpoint ] [ Endpoint ] [ Transformers ] The TCP transport enables events to be sent and received over TCP sockets.
Connector Connects Mule to a TCP socket to send or receive data via the network.
Child Elements of
Name
Cardinality
Description
abstract-protocol
0..1
The class name for the protocol handler. This controls how the raw data stream is converted into messages. By default, messages are constructed as dara is received, with no correction for multiple packets or fragmentation. Typically, change this value, or use a transport that includes a protocol like HTTP.
Streaming Protocol TCP does not guarantee that data written to a socket is transmitted in a single packet, so if you want to transmit entire Mule messages reliably, you must specify an additional protocol. However, this is not an issue with streaming, so the streaming-protocol element is an alias for the "direct" (null) protocol.
Xml Protocol TCP does not guarantee that data written to a socket is transmitted in a single packet, so if you want to transmit entire Mule messages reliably, you must specify an additional protocol. The xml-protocol element configures the XML protocol, which uses XML syntax to isolate messages from the stream of bytes received, so it will only work with well-formed XML.
Xml Eof Protocol Similar to xml-protocol, the xml-eof-protocol element configures the XML protocol, but it will also use socket closure to terminate a message (even if the XML is not well-formed).
Eof Protocol TCP does not guarantee that data written to a socket is transmitted in a single packet, so if you want to transmit entire Mule messages reliably, you must specify an additional protocol. The eof-protocol element
Document generated by Confluence on Mar 11, 2009 14:57
Page 165
configures a protocol that simply accumulates all data until the socket closes and places it in a single message.
Attributes of <eof-protocol...>
Name
Type
Required
payloadOnly
boolean
no
Default
Description Sends only the payload, not the entire Mule message object or its properties. This defaults to true when the protocol is not specified explicitly (when the safe protocol is used).
Direct Protocol TCP does not guarantee that data written to a socket is transmitted in a single packet. Using the directprotocol element to configure the "null" protocol does not change the normal TCP behavior, so message fragmentation may occur. For example, a single sent message may be received in several pieces, each as a separate received message. Typically, it is not a good choice for messaging within Mule, but it may be necessary to interface with external TCP-based protocols.
Attributes of
Name
Type
Required
payloadOnly
boolean
no
Default
Description Sends only the payload, not the entire Mule message object or its properties. This defaults to true when the protocol is not specified explicitly (when the safe protocol is used).
Safe Protocol Similar to length-protocol, safe-protocol also includes a prefix. Verification of the prefix allows mismatched protocols to be detected and avoids interpreting "random" data as a message length (which may give out-of-memory errors). This is the default protocol in Mule 2.x.
Attributes of <safe-protocol...>
Name
Type
Required
payloadOnly
boolean
no
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description Sends only the payload, not
Page 166
the entire Mule message object or its properties. This defaults to true when the protocol is not specified explicitly (when the safe protocol is used). maxMessageLength integer
no
An optional maximum length for the number of bytes in a single message. Messages larger than this will trigger an error in the receiver, but it give an assurance that no out-ofmemory error will occur.
Length Protocol The length-protocol element configures the length protocol, which precedes each message with the number of bytes sent so that an entire message can be constructed on the received.
Attributes of
Name
Type
Required
payloadOnly
boolean
no
Sends only the payload, not the entire Mule message object or its properties. This defaults to true when the protocol is not specified explicitly (when the safe protocol is used).
no
An optional maximum length for the number of bytes in a single message. Messages larger than this will trigger an error in the receiver, but it give an assurance that no out-ofmemory error will occur.
maxMessageLength integer
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 167
Custom Protocol The custom-protocol element allows you to configure your own protocol implementation.
Attributes of <custom-protocol...>
Name
Type
Required
class
class name
no
Default
Description A class that implements the TcpProtocol interface.
Inbound Endpoint The inbound-endpoint element configures the endpoint on which the messages are received.
Attributes of
Name
Type
Required
Default
Description
host
string
no
The host of the TCP socket.
port
port number
no
The port of the TCP socket.
Outbound Endpoint The outbound-endpoint element configures the endpoint where the messages are sent.
Attributes of
Name
Type
Required
Default
Description
host
string
no
The host of the TCP socket.
port
port number
no
The port of the TCP socket.
Endpoint The endpoint element configures a global TCP endpoint definition.
Attributes of <endpoint...>
Name
Type
Required
host
string
no
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description The host of the TCP socket.
Page 168
port
port number
no
The port of the TCP socket.
Transformers The following transformers are used by default for the TCP transport unless a transformer is explicitly set on the connector or service.
Transformer
Description
ByteArrayToString
Converts a byte array to a String
StringToByteArray
Converts a String to a byte array
Document generated by Confluence on Mar 11, 2009 14:57
Page 169
UDP Transport This page last changed on Feb 20, 2009 by jackie.wheeler.
UDP Transport The UDP transport enables events to be sent and received as Datagram packets. The Javadoc for this transport can be found here .
Connector Attributes of
Name
Type
Required
Default
Description
receiveBufferSize
integer
no
The size of the receiving buffer for the socket.
receiveTimeout
long
no
The amount of time after which a Receive call will time out.
sendBufferSize
integer
no
The size of the sending buffer for the socket.
sendTimeout
long
no
The amount of time after which a Send call will time out.
socketLinger
long
no
The amount of time the socket will remain open after a closesocket call.
broadcast
boolean
no
Whether to enable the socket to send broadcast data.
keepSendSocketOpenboolean
no
Whether to keep the Sending socket open.
Endpoints You configure UDP endpoints just as you would with any other transport, with the following additional attributes: • host: the IP address of the server, such as www.mulesource.com, localhost, or 127.0.0.1 • port: the port number of the server. For example:
Document generated by Confluence on Mar 11, 2009 14:57
Page 170
Message Payload The default message payload of the UDP transport for incoming messages is a byte[] array.
Document generated by Confluence on Mar 11, 2009 14:57
Page 171
VM Transport This page last changed on Feb 24, 2009 by jackie.wheeler.
VM Transport The VM transport is used for intra-VM communication between components managed by Mule. The connector provides options for configuring VM transient or persistent queues. The Javadoc for this transport can be found here .
Using VM Queues When using a synchronous VM endpoint, messages are delivered in memory from one component to another (asynchronous endpoints introduce a queue that threads can consume from). However, when the queueEvents property is set, messages can be stored in arbitrary memory queues and consumed later by clients or components. Furthermore, these queues can be persistent and XA transactional (see below). To use VM queues, the queueEvents property must be set on the connector, and all VM endpoints that should queue messages must use a VM connector that has queueEvents enabled. You cannot set the queueEvents property on the endpoint. For example:
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:spring="http://www.springframework.org/schema/beans" xmlns:vm="http://www.mulesource.org/schema/mule/vm/2.2" xmlns:test="http://www.mulesource.org/schema/mule/test/2.2" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/springbeans-2.5.xsd http://www.mulesource.org/schema/mule/core/2.2 http://www.mulesource.org/schema/mule/core/2.2/ mule.xsd http://www.mulesource.org/schema/mule/test/2.2 http://www.mulesource.org/schema/mule/test/2.2/ mule-test.xsd http://www.mulesource.org/schema/mule/vm/2.2 http://www.mulesource.org/schema/mule/vm/2.2/ mule-vm.xsd"> <model> <service name="myAsynchService"> Polo
Notice that the inbound endpoint explicitly tells Mule to use the asynchVm connector. Otherwise, Mule will look for the first connector that matches the protocol for the endpoint.
Document generated by Confluence on Mar 11, 2009 14:57
Page 172
For more information on queues, see Configuring Queues.
Using Persistent Queues A VM queue can be made persistent so that its state can be maintained between server shutdowns. To make VM queues persistent, you enable the persistent property in the queue profile on the model or service.
Using Transactions VM queues can take part in distributed XA transactions. To make a VM endpoint transactional, use the following configuration:
You must add a transaction manager to your configuration. For more information, see Transaction Management.
Using VM with CXF You can use the VM transport with CXF to take advantage of its support for web service integration. To create a VM/CXF endpoint, declare the CXF schema and namespace, and then create the connector and endpoints as follows:
<model name="test"> <service name="mycomponent"> <singleton-object class="org.mule.tck.testmodels.services.TestServiceComponent"/> <service name="httpBridge">
Transformers There are no specific transformers for the VM transport.
Document generated by Confluence on Mar 11, 2009 14:57
Page 173
Configuration Reference Following are the elements and attributes you can set for the VM transport.
Connector Attributes of
Name
Type
Required
Default
Description
queueEvents
boolean
no
Determines whether queues should be set up for listeners on the connector. If set to false, the connector simply forwards messsages to components via the Mule server. If it is set to true, the queues are configured using the queuing profile.
queueTimeout
positiveInteger
no
The timeout setting for the queue.
Child Elements of
Name
Cardinality
Description
queueProfile
0..1
DEPRECATED. USE "" instead.
queue-profile
0..1
Configures the properties of this connector's queue (see Configuring Queues).
Inbound Endpoint The endpoint on which this connector receives messages from the transport.
Attributes of
Name
Type
Required
path
string
no
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description The queue path, such as dispatchInQueue to create the
Page 174
address vm:// dispatchInQueue.
Outbound Endpoint The endpoint to which this connector sends messages.
Attributes of
Name
Type
Required
path
string
no
Default
Description The queue path, such as dispatchInQueue to create the address vm:// dispatchInQueue.
Endpoint An endpoint "template" that can be used to construct an inbound or outbound endpoint elsewhere in the configuration by referencing the endpoint name.
Attributes of <endpoint...>
Name
Type
Required
path
string
no
Default
Description The queue path, such as dispatchInQueue to create the address vm:// dispatchInQueue.
Transaction The transaction element configures a transaction. Transactions allow a series of operations to be grouped together so that they can be rolled back if a failure occurs. For more information, see Transaction Management.
Document generated by Confluence on Mar 11, 2009 14:57
Page 175
WSDL Transport This page last changed on Feb 20, 2009 by jackie.wheeler.
WSDL Transport [ Generic WSDL Endpoints ] [ Transformers ] [ Specifying an Alternate WSDL Location ] [ Example of the CXF WSDL Endpoint ] The WSDL transport can be used to for invoking remote web services by obtaining the service WSDL. Mule will create a dynamic proxy for the service and then invoke it. The Javadoc for this transport can be found here for the Axis version and here for the CXF version.
Generic WSDL Endpoints A WSDL endpoint enables you to easily invoke web services without generating a client. At startup, it reads the WSDL to determine how to invoke the remote web service during runtime. When a message is sent through the WSDL endpoint, it is able to construct a SOAP message using the message payload and its knowledge of the expected payload format from the WSDL. You must provide the full URL to the WSDL of the service to invoke, and you must supply a 'method' parameter that tells Mule which operation to invoke on the service:
wsdl:http://www.webservicex.net/stockquote.asmx?WSDL&method=GetQuote
The WSDL URL is prepended with the wsdl: prefix. Mule checks your class path to see if there is a WSDL provider that it can use to create a client proxy from the WSDL. Mule supports both Axis and CXF as WSDL providers. If you want to use a specific one, you can specify it on the URL as follows:
wsdl-cxf:http://www.webservicex.net/stockquote.asmx?WSDL&method=GetQuote
or
wsdl-axis:http://www.webservicex.net/stockquote.asmx?WSDL&method=GetQuote
In general, you should use the CXF WSDL endpoint. The one limitation of the CXF WSDL provider is that it does not allow you to use non-Java primitives (objects that are not a String, int, double, and so on). Sometimes the Axis WSDL generation will not work (incorrect namespaces are used), so you can experiment with each one to see which works best.
Transformers There are no specific transformers to set on WSDL endpoints.
Specifying an Alternate WSDL Location By default, the WSDL provider will look for your WSDL by taking the endpoint address and appending ?wsdl to it. With the CXF transport, you have the option of specifying a location for the WSDL that is different from that specified with the ?wsdl parameter. This may be useful in cases where the WSDL isn't available the normal way, either because the SOAP engine doesn't provide it or the provider does not want to expose the WSDL publicly.
Document generated by Confluence on Mar 11, 2009 14:57
Page 176
In these cases, you can specify the wsdlLocation property of the CXF endpoint as follows:
<endpoint address="wsdl-cxf:http://localhost:8080/book/services/BookService?method=getBooks"> <properties> <property name="wsdlLocation" value="file:///c:/BookService.wsdl"/>
In this case, the WSDL CXF endpoint works as it normally does, except that it reads the WSDL from the local drive.
Example of the CXF WSDL Endpoint This example demonstrates how to take multiple arguments from the console, invoke a web service, and print the output to the screen. It uses the Currency Convertor web service on www.webservicex.net. This service requires two arguments: the "from" currency code and the "to" currency code. When the CXF dispatcher prepares arguments for the invocation of the service, it expects to find a message payload of Object[] - that is, an Object array. In the case of the Currency Convertor, this should be an array of two Objects - the "from" currency and the "to" currency. There are several ways to construct this object array, but the easiest way is to use the custom transformer StringToObjectArrayTransformer , which translates a delimited String into an Object array. In the example below, you simply type in a String in the format of ,.
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:spring="http://www.springframework.org/schema/beans" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/springbeans-2.5.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/ spring-context-2.5.xsd http://www.mulesource.org/schema/mule/core/2.2 http://www.mulesource.org/schema/mule/core/2.2/ mule.xsd"> <model name="sample"> <service name="inputService"> <custom-transformer class="org.mule.transformer.simple.StringToObjectArray"> <spring:property name="delimiter" value=","/>
Document generated by Confluence on Mar 11, 2009 14:57
Page 177
For example, type "EUR,USD" to get the conversion rate for Euros to US Dollars, and you'll get something like this:
Enter from and to currency symbols, separated by a comma: EUR,USD 1.3606
Document generated by Confluence on Mar 11, 2009 14:57
Page 178
XMPP Transport This page last changed on Feb 20, 2009 by jackie.wheeler.
XMPP Transport [ Inbound Endpoint ] [ Outbound Endpoint ] [ Endpoint ] [ Transformers ] [ Filters ] The XMPP transport enables the XMPP (Jabber) instant messaging protocol. The XMPPS connector provides a secure implementation. The Javadoc for the XMPP transport can be found here .
Inbound Endpoint The endpoint on which this connector receives messages from the transport.
Attributes of
Name
Type
Required
user
string
no
The user name to use to connect to the XMPP server.
password
string
no
The password to use with the user name.
host
string
no
The host of the XMPP server, such as www.mulesource.com, localhost, or 127.0.0.1.
port
port number
no
The port number of the XMPP server, such as 5222.
recipient
string
no
The ID of the intended recipient of the messages, such as [email protected].
groupChat
boolean
no
Whether to start a group chat.
nickname
string
no
The user's nickname.
resource
string
no
The resource portion of the address, such as user@host/ resource or domain/resource.
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 179
thread
string
no
The thread to which the message belongs.
to
string
no
The user to whom the message was sent.
from
string
no
The user who sent the message.
Outbound Endpoint The endpoint to which this connector sends messages.
Attributes of
Name
Type
Required
user
string
no
The user name to use to connect to the XMPP server.
password
string
no
The password to use with the user name.
host
string
no
The host of the XMPP server, such as www.mulesource.com, localhost, or 127.0.0.1.
port
port number
no
The port number of the XMPP server, such as 5222.
recipient
string
no
The ID of the intended recipient of the messages, such as [email protected].
groupChat
boolean
no
Whether to start a group chat.
nickname
string
no
The user's nickname.
resource
string
no
The resource portion of the address, such as user@host/ resource or domain/resource.
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 180
thread
string
no
The thread to which the message belongs.
to
string
no
The user to whom the message was sent.
from
string
no
The user who sent the message.
Endpoint An endpoint "template" that can be used to construct an inbound or outbound endpoint elsewhere in the configuration by referencing the endpoint name.
Attributes of <endpoint...>
Name
Type
Required
user
string
no
The user name to use to connect to the XMPP server.
password
string
no
The password to use with the user name.
host
string
no
The host of the XMPP server, such as www.mulesource.com, localhost, or 127.0.0.1.
port
port number
no
The port number of the XMPP server, such as 5222.
recipient
string
no
The ID of the intended recipient of the messages, such as [email protected].
groupChat
boolean
no
Whether to start a group chat.
nickname
string
no
The user's nickname.
resource
string
no
The resource portion of the address, such as user@host/ resource or domain/resource.
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 181
thread
string
no
The thread to which the message belongs.
to
string
no
The user to whom the message was sent.
from
string
no
The user who sent the message.
You configure the XMPP connector as follows:
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:spring="http://www.springframework.org/schema/beans" xmlns:xmpp="http://www.mulesource.org/schema/mule/xmpp/2.2" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/springbeans-2.5.xsd http://www.mulesource.org/schema/mule/core/2.2 http://www.mulesource.org/schema/mule/core/2.2/ mule.xsd http://www.mulesource.org/schema/mule/xmpp/2.2 http://www.mulesource.org/schema/mule/xmpp/2.2/ mule-xmpp.xsd"> <xmpp:endpoint name="noNicknameEndpoint" host="localhost" port="1234" user="mule" password="secret" recipient="recipient" groupChat="true"/>
If you want to use secure XMPP, specify the xmpps namespace instead, specifying the schema as follows, and then use the xmpps prefix on the endpoints:
http://www.mulesource.org/schema/mule/xmpps/2.2 http://www.mulesource.org/schema/mule/xmpps/2.2/ mule-xmpps.xsd
Transformers There are two transformers provided with the XMPP transport:
Transformer
Description
org.mule.transport.xmpp.transformers.XmppPacketToString Converts an XMPP Packet to a String, returning a java.lang.String object. org.mule.transport.xmpp.transformers.ObjectToXmppPacket Accepts a String or an XMPP Packet and returns an XMPP Packet. This transformer doesn't accept all objects, only Strings and XMPP Packets.
Filters There are several filters in the org.mule.transport.xmpp.filters package that filter XMPP messages. AbstractXmppFilter is an abstract filter adapter that allows Smack filters to be configured as Mule filters. The following filter classes extend the abstract filter:
Document generated by Confluence on Mar 11, 2009 14:57
Page 182
• • • • • • • • •
XmppAndFilter XmppFromContainsFilter XmppMessageTypeFilter XmppNotFilter XmppOrFilter XmppPacketIDFilter XmppPacketTypeFilter XmppThreadFilter XmppToContainsFilter
Document generated by Confluence on Mar 11, 2009 14:57
Page 183
Bootstrapping the Registry This page last changed on Feb 09, 2009 by jackie.wheeler.
Bootstrapping the Registry Mule provides a mechanism for adding objects to the Mule registry as soon as a module or transport is loaded. This is useful for registering shared transformers or expression evaluators. All objects you add to the registry using this mechanism must have a default constructor. They can implement injection interfaces such as org.mule.MuleContextAware and lifecycle interfaces such as org.mule.api.lifecycle.Initialisable .
Specifying the Objects to Bootstrap To load an object into the Mule registry using the bootstrap mechanism, you specify the object in the properties file registry-bootstrap.properties, which you then store in the META-INF directory for the transport or module. For example:
src/main/resources/META-INF/services/org/mule/config/registry-bootstrap.properties
Each entry in the registry-bootstrap.properties file is a simple key/value pair that defines the object:
myobject=org.foo.MyObject
If this file is in a module or transport's META-INF directory, Mule will register an instance of org.foo.MyObject with a key of 'myobject' into the local registry when that module or transport is loaded. If you want to ensure that the object gets a unique ID in the local registry, you can use object.n for the key, where n is a sequential number:
object.1=org.foo.MyObject object.2=org.bar.MyObject
Adding Transformers When adding transformers, you can also define the returnClass and name of the transformer as parameters:
transformer.1=org.mule.transport.jms.transformers.JMSMessageToObject,returnClass=byte[] transformer.2=org.mule.transport.jms.transformers.JMSMessageToObject,returnClass=java.lang.String, name=JMSMessageToString transformer.3=org.mule.transport.jms.transformers.JMSMessageToObject,returnClass=java.util.Hashtable)
Note that the key used for transformers must be transformer.n where n is a sequential number.
Document generated by Confluence on Mar 11, 2009 14:57
Page 184
If the transformer name is not specified, Mule will automatically generate the name as JMSMessageToXXX where XXX is the return class name, such as JMSMessageToString. If no returnClass is specified, the default value in the transformer will be used.
Document generated by Confluence on Mar 11, 2009 14:57
Page 185
Choosing the Right Topology This page last changed on Nov 25, 2008 by jackie.wheeler.
Choosing the Right Topology [ About Clustering ] [ JMS Queues ] [ Load Balancers ] [ Maintaining State in a Database ] [ Handling Stateful Components ] [ Example Architectures ] [ Related Topics ] As you build your Mule application, it is important to think critically about how best to architect your application to achieve the desired availability, fault tolerance, and performance characteristics. This page outlines some of the solutions for achieving the right blend of these characteristics through clustering and other techniques. There is no one correct approach for everyone, and designing your system is both an art and a science. If you need more assistance, MuleSource Professional Services can help you by reviewing your architecture plan or designing it for you. For more information, contact us.
About Clustering Clustering an application is useful for achieving the following: • High availability (HA): Making your system continually available in the event that one or more servers or a data center fails. • Fault tolerance (FT): The ability to recover from failure of an underlying component. Typically, the recovery is achieved through transaction rollback or compensating actions. This page describes several possible clustering solutions. Please note that as of the current release, MuleSource does not support any specific clustering solution, although many users have successfully set up Mule in a clustered environment.
JMS Queues JMS can be used to achieve HA & FT by routing messages through JMS queues. In this case, each message is routed through a JMS queue whenever it moves from component to component.
Pros: • Easy to do • Well understood by developers Cons: • Requires lots of transactions, and transactions can be complicated • Performance hit if you're using XA
Load Balancers Load balancers simply route requests to different servers based on the the current load of each server and which servers are currently up. Load balancers can be software or hardware based. This approach is commonly used with clustered databases (see below).
Document generated by Confluence on Mar 11, 2009 14:57
Page 186
Pros: • Straightforward to do • Well understood by developers Cons: • Not a complete solution on its own, doesn't provide fault tolerance.
Maintaining State in a Database If you have a clustered database, one option for your application is to simply store all state in the database and rely on it to replicate the data consistently across servers. Pros: • Straightforward to do • Well understood by developers Cons: • Not all state is amenable to being stored in the database
Handling Stateful Components While most applications can be supported by the above techniques, some require sharing state between JVMs more deeply. One common example of this is an aggregator component. For example, assume you have an aggregator that is aggregating messages from two different producers. Producer #1 sends a message to the aggregator, which receives it and holds it in memory until Producer #2 sends a message.
Producer #1 ---> |----------| |Aggregator| --> Some other component Producer #2 ---> |----------|
If the server with the aggregator goes down between Producer #1 sending a message and Producer #2 sending a message, Producer #2 can't just send its message to a different server because that server will not have the message from Producer #1. The solution to this is to share the state of the aggregator component across different machines through clustering software such as Terracotta, Tangosol Coherence, JGroups, etc. By using one of these tools, Producer #2 can simply fail over to a different server. Note that MuleSource has not tested Mule with these tools and does not officially support them. Pros: • Works for all clustering cases • Can work as a cache as well Cons: • Not officially supported by MuleSource • Requires performance tuning to get things working efficiently
Document generated by Confluence on Mar 11, 2009 14:57
Page 187
Example Architectures HTTP + JMS Queues In this example architecture, HTTP requests come in through a load balancer and are immediately put on a JMS queue. The JMS queue is clustered between the different servers. A server will start processing a message off the JMS queue and wrap everything in a transaction.
If the server goes down, the transaction will roll back and another server will pick up the message and start processing it. Note: If the HTTP connection is open for the duration of this process, this approach will not work, as the load balancer will not transparently switch connections between servers. In this case, the HTTP client will need to retry the request.
Terracotta Terracotta is an open source JVM clustering technology. It is able to replicate the state of your components across JVMs. In this example architecture, there is a load balancer that is proxying requests between multiple servers.
If one of the servers goes down, the load balancer automatically routes requests to a server that is up. Because all the state of your components is shared between the different servers, your internal process can continue on another server.
Document generated by Confluence on Mar 11, 2009 14:57
Page 188
Note: If the HTTP connection is open for the duration of this process, this approach will not work, as the load balancer will not transparently switch connections between servers. In this case, the HTTP client will need to retry the request.
Related Topics As you design your topology, there are several other topics to keep in mind that are beyond the scope of this documentation: • • • •
Maintaining geo-distributed clusters Data partitioning ACID vs. BASE transactions Compensation and transactions
Document generated by Confluence on Mar 11, 2009 14:57
Page 189
Configuration Overview This page last changed on Feb 24, 2009 by jackie.wheeler.
Configuration Overview [ Configuration Files ] [ Configuration Builders ] [ Accessing the Configuration Programmatically ] [ Configuring System Properties ] By default, Mule starts up with a simple configuration in which only some system-level services are configured. You must configure services, transports, and the rest of the elements required for your application. Following is an overview of configuration in Mule.
Configuration Files In most cases, you will configure Mule using XML files. These files are based on Spring and make it very easy to set up your Mule instance in a short time. For complete information on setting the options in the configuration file, see XML Configuration. When you start Mule from the command line, you simply specify the configuration file(s) with the config parameter:
mule -config foo-config.xml
mule -config foo-config.xml,bar-config.xml
If you want to start Mule by calling it from your code, you specify the configuration file as a parameter to the ConfigurationBuilder:
MuleContext context = new DefaultMuleContextFactory().createMuleContext(new SpringXmlConfigurationBuilder("foo-config.xml")); context.start();
If you have multiple configuration files, you can also import them into one configuration file so that you only have to specify one configuration file at the command line or from your code. For example:
<mule xmlns=http://www.mulesource.org/schema/mule/core/2.2 ....> <spring:beans> <spring:import resource="mule-sub-config1.xml" /> <spring:import resource="mule-sub-config2.xml" /> ...
Configuration Builders The configuration builder is responsible for creating the configuration that's used at run time from the configuration files you provide. Mule provides two standard configuration builders, or you can create your own.
Document generated by Confluence on Mar 11, 2009 14:57
Page 190
SpringXmlConfigurationBuilder The default configuration builder used to configure Mule is the SpringXmlConfigurationBuilder. This configuration builder uses Spring 2.0 to configure Mule based on one or more XML files leveraging custom Mule namespaces. For more information, see XML Configuration.
ScriptConfigurationBuilder This configuration builder allows a JSR-223 compliant script engine (e.g., Groovy, Jython) to configure Mule. For more information, see Scripting Module.
Custom Configuration Builders You can easily create your own custom configuration builder by implementing the ConfigurationBuilder interface, which has a method configure. Typically, you call configure(MuleContext muleContext.getRegistry()) to get access to Mule's internal registry, which contains the configuration information, and to register services and other elements. In most cases, you will want to inherit from the class AbstractResourceConfigurationBuilder , which will make any configuration files specified on the command line available in an instance variable called configResources.
Specifying the Configuration Builder SpringXmlConfigurationBuilder is the default configuration builder. If you want to use another configuration builder, you can specify it on the command line at startup with the -builder parameter:
mule -builder org.mule.module.scripting.builders.ScriptConfigurationBuilder -config mule-config.groovy
You can also specify the configuration builder as a parameter to the MuleContextFactory when starting Mule programatically:
MuleContext context = new DefaultMuleContextFactory().createMuleContext(new ScriptConfigurationBuilder("mule-config.groovy")); context.start();
Accessing the Configuration Programmatically All Mule configuration is accessible from a single object: org.mule.api.config.MuleConfiguration . Configurations in a MuleConfiguration are set when a MuleContext is created. The object becomes immutable after it is started and can be accessed using the following:
MuleContext context = MuleServer.getMuleContext(); MuleConfiguration configuration = context.getConfiguration();
Configuring System Properties There are several system properties that are immutable after startup, such as the server ID. To specify these properties, you can use the -M-Dmule.<propertyName> command (such as -MDmule.serverId=YOUR_MULE_SERVER_ID) or by setting -Dmule.<propertyName> in wrapper.conf if you are running Mule from the command line. To set these properties programmatically, you customize the
Document generated by Confluence on Mar 11, 2009 14:57
Page 191
MuleConfiguration using the set method for the property (such as setId for the system ID), create a MuleContextBuilder, load the configuration to the builder, and then create the context from the builder. For example:
SpringXmlConfigurationBuilder configBuilder = new SpringXmlConfigurationBuilder("my-config.xml"); DefaultMuleConfiguration muleConfig = new DefaultMuleConfiguration(); muleConfig.setId("MY_SERVER_ID"); MuleContextBuilder contextBuilder = new DefaultMuleContextBuilder(); contextBuilder.setMuleConfiguration(muleConfig); MuleContextFactory contextFactory = new DefaultMuleContextFactory(); MuleContext muleContext = contextFactory.createMuleContext(configBuilder, contextBuilder); muleContext.start();
For more information on the system properties you can set programmatically, see DefaultMuleConfiguration .
Document generated by Confluence on Mar 11, 2009 14:57
Page 192
Configuration Reference This page last changed on Nov 24, 2008 by jackie.wheeler.
Configuration Reference • • • • •
• • • • • • • • •
Global Settings Configuration Reference Model Configuration Reference Service Configuration Reference Endpoint Configuration Reference Routers ° Inbound Router Configuration Reference ° Outbound Router Configuration Reference ° Asynchronous Reply Router Configuration Reference ° Catch All Strategy Configuration Reference Filters Configuration Reference Transformers Configuration Reference Component Configuration Reference Entry Point Resolver Configuration Reference Exception Strategy Configuration Reference Properties Configuration Reference Notifications Configuration Reference Transactions Configuration Reference Expressions Configuration Reference
For configuration reference on transports, see Available Transports. For modules, see Using Mule Modules. For transports and modules contributed by the community, see MuleForge Active Projects.
Document generated by Confluence on Mar 11, 2009 14:57
Page 193
Asynchronous Reply Router Configuration Reference This page last changed on Feb 20, 2009 by jackie.wheeler.
Asynchronous Reply Router Configuration Reference This page provides details on the elements you configure for asynchronous reply routers. This information is pulled directly from mule.xsd and is cached. If the information appears to be out of date, refresh the page. For more information on routers, see Using Message Routers.
<single-async-reply-router ...> Configures a Single Response Router. This will return the first message it receives on a reply endpoint and will discard the rest.
Attributes Child Elements
Name
Type
Required
Name
Cardinality
Description
abstract-inboundendpoint
0..*
The endpoint used to receive the response(s) on.
Default
Description
A placeholder for inbound endpoint elements. Inbound endpoints receive messages from the underlying transport. The message payload is then delivered to the component for processing. abstract-messageinfo-mapping
0..1
The message info mapper used to extract key bits of the message information, such as Message ID or Correlation ID. these properties are used by some routers and this mapping information tells Mule where to get the information from in the current message.
Document generated by Confluence on Mar 11, 2009 14:57
Page 194
Maps the attributes of the current message to known message elements in Mule, namely Message ID and CorrrelationID.
Configures a Collection Response Router. This will return a MuleMessageCollection message type that will contain all messages received for the current correlation.
Attributes Child Elements
Name
Type
Required
Name
Cardinality
Description
abstract-inboundendpoint
0..*
The endpoint used to receive the response(s) on.
Default
Description
A placeholder for inbound endpoint elements. Inbound endpoints receive messages from the underlying transport. The message payload is then delivered to the component for processing. abstract-messageinfo-mapping
0..1
The message info mapper used to extract key bits of the message information, such as Message ID or Correlation ID. these properties are used by some routers and this mapping information tells Mule where to get the information from in the current message. Maps the attributes of the current message to known message elements in
Document generated by Confluence on Mar 11, 2009 14:57
Page 195
Mule, namely Message ID and CorrrelationID.
<custom-async-reply-router ...> Attributes
Name class
Type
Required
class name
Default
no
Description
A fully qualified Java class name of the router to use. The router should either extend {{org.mule.routing.response.Ab or {{org.mule.routing.response.Ab
Child Elements
Name
Cardinality
Description
abstract-inbound-endpoint
0..*
The endpoint used to receive the response(s) on. A placeholder for inbound endpoint elements. Inbound endpoints receive messages from the underlying transport. The message payload is then delivered to the component for processing.
abstract-message-info-mapping
0..1
The message info mapper used to extract key bits of the message information, such as Message ID or Correlation ID. these properties are used by some routers and this mapping information tells Mule where to get the information from in the current message. Maps the attributes of the current message to known message elements in Mule, namely Message ID and CorrrelationID.
spring:property
0..*
Document generated by Confluence on Mar 11, 2009 14:57
Spring-style property elements so that custom configuration can be configured on the custom router.
Page 196
Catch All Strategy Configuration Reference This page last changed on Feb 20, 2009 by jackie.wheeler.
Catch All Strategy Configuration Reference This page provides details on the elements you configure for catch-all strategies. This information is pulled directly from mule.xsd and is cached. If the information appears to be out of date, refresh the page.
Does nothing with the message but simply logs (using the WARN log level) the fact that the message was not dispatched because no routing path was defined.
Attributes Child Elements
Name
Type
Required
Name
Cardinality
Description
Default
Description
Default
Description
<custom-catch-all-strategy ...> Attributes
Name class
Type
Required
class name
no
Fully qualified class name of the custom catchall strategy to be used.
Child Elements
Name
Cardinality
spring:property
0..*
Description
Forwards the message to the specified endpoint if no outbound routers match.
Document generated by Confluence on Mar 11, 2009 14:57
Page 197
Attributes Child Elements
Name
Type
Required
Name
Cardinality
Description
abstractoutboundendpoint
0..*
A placeholder for outbound endpoint elements. Outbound endpoints dispatch messages to the underlying transport.
Default
Description
<custom-forwarding-catch-all-strategy ...> Attributes
Name class
Type
Required
class name
Default
no
Description Fully qualified class name of the custom forwarding catch-all strategy to be used.
Child Elements
Name
Cardinality
Description
abstract-outbound-endpoint
0..*
A placeholder for outbound endpoint elements. Outbound endpoints dispatch messages to the underlying transport.
spring:property
0..*
Document generated by Confluence on Mar 11, 2009 14:57
Page 198
Component Configuration Reference This page last changed on Feb 20, 2009 by jackie.wheeler.
Component Configuration Reference This page provides details on the elements you configure for components. This information is pulled directly from mule.xsd and is cached. If the information appears to be out of date, refresh the page. For more information on components, see Configuring Components.
A simple POJO (Plain Old Java Object) component that will be invoked by Mule when a message is received. The class or object instance to be used can be specified using a child object factory element, or via the 'class' attribute. If the 'class' attribute is used, an object factory cannot be configured as well. Using the 'class' attribute is equivilant to using the propotype object factory ('prototype-object' child element).
Attributes
Name
Type
class
Required
class name
Default
no
Description Specifies a component class. This is a shortcut that is equivalent to providing a 'prototype-object' element.
Child Elements
Name
Cardinality
Description
abstract-interceptor
1..1
A placeholder for an interceptor element.
interceptor-stack
1..1
A reference to a stack of intereceptors defined globally.
abstract-object-factory
0..1
Object factory used to obtain the object instance that will be used for the component implementation. The object factory is responsible for object creation and may implement different patterns, such as singleton or prototype, or look up an instance from other object containers.
abstract-lifecycle-adapterfactory
0..1
binding
0..*
Document generated by Confluence on Mar 11, 2009 14:57
A binding associates a Mule endpoint with an injected Java
Page 199
interface. This is like using Spring to inject a bean, but instead of calling a method on the bean, a message is sent to an endpoint. abstract-entry-point-resolver-set
0..1
A placeholder for entry point resolver set elements. These combine a group of entry point resolvers, trying them in turn until one succeeds.
abstract-entry-point-resolver
0..1
A placeholder for an entry point resolver element. Entry point resolvers define how payloads are delivered to Java code by choosing the method to call.
<pooled-component ...> A pooled POJO (Plain Old Java Object) component that will be invoked by Mule when a message is received. The instance can be specified via a factory or a class.
Attributes
Name
Type
class
Required
class name
Default
no
Description Specifies a component class. This is a shortcut that is equivalent to providing a 'prototype-object' element.
Child Elements
Name
Cardinality
Description
abstract-interceptor
1..1
A placeholder for an interceptor element.
interceptor-stack
1..1
A reference to a stack of intereceptors defined globally.
abstract-object-factory
0..1
Object factory used to obtain the object instance that will be used for the component implementation. The object factory is responsible for object creation and may implement different patterns, such as singleton or prototype, or look up an instance from other object containers.
abstract-lifecycle-adapterfactory
0..1
Document generated by Confluence on Mar 11, 2009 14:57
Page 200
binding
0..*
A binding associates a Mule endpoint with an injected Java interface. This is like using Spring to inject a bean, but instead of calling a method on the bean, a message is sent to an endpoint.
abstract-entry-point-resolver-set
0..1
A placeholder for entry point resolver set elements. These combine a group of entry point resolvers, trying them in turn until one succeeds.
abstract-entry-point-resolver
0..1
A placeholder for an entry point resolver element. Entry point resolvers define how payloads are delivered to Java code by choosing the method to call.
abstract-pooling-profile
0..1
Characteristics of the object pool.
<pooling-profile ...> A pooling profile is used to configure the pooling behaviour of Mule components. Each component can have its own pooling profile.
Attributes
Name
Type
Required
Default
Description
maxActive
string
no
Controls the maximum number of Mule components that can be borrowed from a session at one time. When set to a negative value, there is no limit to the number of components that may be active at one time. When maxActive is exceeded, the pool is said to be exhausted.
maxIdle
string
no
Controls the maximum number of Mule components that can sit idle in the pool at any time. When set to a negative value, there is no limit
Document generated by Confluence on Mar 11, 2009 14:57
Page 201
to the number of Mule components that may be idle at one time. initialisationPolicy
INITIALISE_NONE / INITIALISE_ONE / INITIALISE_ALL
exhaustedActionWHEN_EXHAUSTED_GROW / WHEN_EXHAUSTED_WAIT / WHEN_EXHAUSTED_FAIL
Document generated by Confluence on Mar 11, 2009 14:57
no
no
INITIALISE_ONE
Determines how components in a pool should be initialized. The possible values are: INITIALISE_NONE (will not load any components into the pool on startup), INITIALISE_ONE (will load one initial component into the pool on startup), or INITIALISE_ALL (will load all components in the pool on startup)
WHEN_EXHAUSTED_GROW Specifies the behavior of the Mule component pool when the pool is exhausted. Possible values are: "WHEN_EXHAUSTED_FAIL", which will throw a NoSuchElementException, "WHEN_EXHAUSTED_WAIT", which will block by invoking Object.wait(long) until a new or idle object is available, or WHEN_EXHAUSTED_GROW, which will create a new Mule instance and return it, essentially making maxActive meaningless. If a positive maxWait value is supplied, it will block for at most that many milliseconds, after which a NoSuchElementException will be thrown. If maxThreadWait is a negative value, it will block indefinitely.
Page 202
maxWait
string
no
Specifies the number of milliseconds to wait for a pooled component to become available when the pool is exhausted and the exhaustedAction is set to WHEN_EXHAUSTED_BLOCK.
Child Elements
Name
Cardinality
Description
Transfers a message from inbound to outbound endpoints. This element is provided for backward compatibility - it is equivalent to not specifying any component.
Attributes Child Elements
Name
Type
Required
Name
Cardinality
Description
abstractinterceptor
1..1
A placeholder for an interceptor element.
interceptor-stack
1..1
A reference to a stack of intereceptors defined globally.
Default
Description
Default
Description
<echo-component ...> Logs the message and returns the payload as the result.
Attributes Child Elements
Name
Type
Required
Name
Cardinality
Description
abstractinterceptor
1..1
A placeholder for an interceptor element.
Document generated by Confluence on Mar 11, 2009 14:57
Page 203
interceptor-stack
1..1
A reference to a stack of intereceptors defined globally.
Logs the message content (or content length if it is a large message).
Attributes Child Elements
Name
Type
Required
Name
Cardinality
Description
abstractinterceptor
1..1
A placeholder for an interceptor element.
interceptor-stack
1..1
A reference to a stack of intereceptors defined globally.
Default
Description
Default
Description
Throws an exception if it receives a message.
Attributes Child Elements
Name
Type
Required
Name
Cardinality
Description
abstractinterceptor
1..1
A placeholder for an interceptor element.
interceptor-stack
1..1
A reference to a stack of intereceptors defined globally.
<spring-object ...> Object factory used to obtain Spring bean instances. This object factory does not create any instances but rather looks them up from Spring.
Document generated by Confluence on Mar 11, 2009 14:57
Page 204
Attributes
Name
Type
Required
bean
name (no spaces)
Default
no
Description Name of Spring bean to look up.
Child Elements
Name
Cardinality
Description
property
0..*
Sets a Mule property. This is a name/value pair that can be set on components, services, etc., and which provide a generic way of configuring the system. Typically, you shouldn't need to use a generic property like this, since almost all functionality is exposed via dedicated elements. However, it can be useful in configuring obscure or overlooked options and in configuring transports from the generic endpoint elements.
properties
0..1
A map of Mule properties.
<singleton-object ...> Object factory that creates and always returns a singleton object instance.
Attributes
Name class
Type
Required
class name
Default
no
Description Class name
Child Elements
Name
Cardinality
Description
property
0..*
Sets a Mule property. This is a name/value pair that can be set on components, services, etc., and which provide a generic way of configuring the system. Typically, you shouldn't need to use a generic property like this, since almost all functionality is exposed via dedicated elements. However, it can be useful in configuring obscure or overlooked options and in
Document generated by Confluence on Mar 11, 2009 14:57
Page 205
configuring transports from the generic endpoint elements. properties
0..1
A map of Mule properties.
<prototype-object ...> Object factory that creates and returns a new 'prototype' object instance every time it is called.
Attributes
Name class
Type
Required
class name
Default
no
Description Class name
Child Elements
Name
Cardinality
Description
property
0..*
Sets a Mule property. This is a name/value pair that can be set on components, services, etc., and which provide a generic way of configuring the system. Typically, you shouldn't need to use a generic property like this, since almost all functionality is exposed via dedicated elements. However, it can be useful in configuring obscure or overlooked options and in configuring transports from the generic endpoint elements.
properties
0..1
A map of Mule properties.
<custom-lifecycle-adapter-factory ...> Attributes
Name class
Type
Required
class name
Document generated by Confluence on Mar 11, 2009 14:57
no
Default
Description An implementation of the LifecycleAdapter interface.
Page 206
Child Elements
Name
Cardinality
Description
A binding associates a Mule endpoint with an injected Java interface. This is like using Spring to inject a bean, but instead of calling a method on the bean, a message is sent to an endpoint.
Attributes
Name interface
Type
Required
class name
method
Default
Description
no
The interface to be injected. A proxy will be created that implements this interface by calling out to the endpoint.
no
The method on the interface that should be used. This can be omitted if the interface has a single method.
Child Elements
Name
Cardinality
Description
abstract-outbound-endpoint
1..*
A placeholder for outbound endpoint elements. Outbound endpoints dispatch messages to the underlying transport.
Interceptors See Using Interceptors.
Entry Point Resolvers See Entry Point Resolver Configuration Reference.
Document generated by Confluence on Mar 11, 2009 14:57
Page 207
Endpoint Configuration Reference This page last changed on Feb 20, 2009 by jackie.wheeler.
Endpoint Configuration Reference This page provides details on the elements you configure for endpoints. This information is pulled directly from mule.xsd and is cached. If the information appears to be out of date, refresh the page. For more information on endpoints, see Configuring Endpoints.
An inbound endpoint receives messages via the associated transport. As with global endpoints, each transport implements its own inbound endpoint element.
Attributes
Name
Type
name
name (no spaces)
no
Identifies the endpoint in the registry. There is no need to set the 'name' attribute on inbound or outbound endpoints, only on global endpoints.
ref
name (no spaces)
no
A reference to a global endpoint, which is used as a template to construct this endpoint. A template fixes the address (protocol, path, host, etc.), and may specify initial values for various properties, but further properties can be defined locally (as long as they do not change the address in any way).
string
no
The generic address for this endpoint. If this attribute is used, the protocol must be specified as part of the URI. Alternatively, most transports provide their own
address
Required
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 208
attributes for specifying the address (path, host, etc.). Note that the address attribute cannot be combined with 'ref' or with the transport-provided alternative attributes. synchronous
boolean
no
If true, the result from the component processing the incoming message will be returned as a response.
responseTimeout
integer
no
The timeout for a response if making a synchronous endpoint call
string
no
String encoding used for messages.
name (no spaces)
no
The name of the connector associated with this endpoint. This must be specified if more than one connector is defined for this transport.
transformer-refs
list of names
no
A list of the transformers that will be applied (in order) to the message before it is delivered to the component.
responseTransformerrefs
list of names
no
A list of the transformers that will be applied (in order) to the synchronous response before it is returned via the transport.
encoding
connector-ref
Document generated by Confluence on Mar 11, 2009 14:57
Page 209
Child Elements
Name
Cardinality
Description
abstract-transaction
0..1
A placeholder for transaction elements. Transactions allow a series of operations to be grouped together.
abstract-filter
0..1
A placeholder for filter elements, which control which messages are handled.
abstract-security-filter
0..1
A placeholder for security filter elements, which control access to the system.
abstract-retry-policy
0..1
A placeholder for a retry policy element. Retry policies define how Mule should retry a failed message send/dispatch/request.
abstract-multi-transaction
0..1
A placeholder for multitransaction elements. Multitransactions allow a series of operations to be grouped together spanning different transports, e.g. JMS and JDBC, but without the overhead of XA. The trade-off is that XA reliability guarantees aren't available, and services must be ready to handle duplicates. This is very similar to a 1.5 PC concept. EE-only feature.
abstract-transformer
0..*
A placeholder for transformer elements. Transformers convert message payloads.
transformers
0..1
A list of transformer elements that will be applied to the message before it is delivered to the component. Note that a list of transformers can also be specified directly (without the 'transformers' element), but then it is not possible to also specify response transformers (using the 'response-transformers' element).
response-transformers
0..1
A list of transformer elements that will be applied to the response message returned from the component.
property
0..*
Sets a Mule property. This is a name/value pair that can be set on components, services, etc., and which provide a generic
Document generated by Confluence on Mar 11, 2009 14:57
Page 210
way of configuring the system. Typically, you shouldn't need to use a generic property like this, since almost all functionality is exposed via dedicated elements. However, it can be useful in configuring obscure or overlooked options and in configuring transports from the generic endpoint elements. properties
0..1
A map of Mule properties.
An outbound endpoint sends messages via the associated transport. As with global endpoints, each transport implements its own outbound endpoint element.
Attributes
Name
Type
name
name (no spaces)
no
Identifies the endpoint in the registry. There is not need to set the 'name' attribute on inbound or outbound endpoints, only on global endpoints.
ref
name (no spaces)
no
A reference to a global endpoint, which is used as a template to construct this endpoint. A template fixes the address (protocol, path, host, etc.), and may specify initial values for various properties, but further properties can be defined locally (as long as they do not change the address in any way).
string
no
The generic address for this endpoint. If this attribute is used, the protocol must be specified as part of the URI. Alternatively,
address
Required
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 211
most transports provide their own attributes for specifying the address (path, host, etc.). Note that the address attribute cannot be combined with 'ref' or with the transport-provided alternative attributes. synchronous
boolean
no
If true, the result from the component processing the incoming message will be returned as a response.
responseTimeout
integer
no
The timeout for a response if making a synchronous endpoint call
string
no
String encoding used for messages.
name (no spaces)
no
The name of the connector associated with this endpoint. This must be specified if more than one connector is defined for this transport.
transformer-refs
list of names
no
A list of the transformers that will be applied (in order) to the message before it is delivered to the component.
responseTransformerrefs
list of names
no
A list of the transformers that will be applied (in order) to the synchronous response before it is returned via the transport.
encoding
connector-ref
Document generated by Confluence on Mar 11, 2009 14:57
Page 212
Child Elements
Name
Cardinality
Description
abstract-transaction
0..1
A placeholder for transaction elements. Transactions allow a series of operations to be grouped together.
abstract-filter
0..1
A placeholder for filter elements, which control which messages are handled.
abstract-security-filter
0..1
A placeholder for security filter elements, which control access to the system.
abstract-retry-policy
0..1
A placeholder for a retry policy element. Retry policies define how Mule should retry a failed message send/dispatch/request.
abstract-multi-transaction
0..1
A placeholder for multitransaction elements. Multitransactions allow a series of operations to be grouped together spanning different transports, e.g. JMS and JDBC, but without the overhead of XA. The trade-off is that XA reliability guarantees aren't available, and services must be ready to handle duplicates. This is very similar to a 1.5 PC concept. EE-only feature.
abstract-transformer
0..*
A placeholder for transformer elements. Transformers convert message payloads.
transformers
0..1
A list of transformer elements that will be applied to the message before it is delivered to the component. Note that a list of transformers can also be specified directly (without the 'transformers' element), but then it is not possible to also specify response transformers (using the 'response-transformers' element).
response-transformers
0..1
A list of transformer elements that will be applied to the response message returned from the component.
property
0..*
Sets a Mule property. This is a name/value pair that can be set on components, services, etc., and which provide a generic
Document generated by Confluence on Mar 11, 2009 14:57
Page 213
way of configuring the system. Typically, you shouldn't need to use a generic property like this, since almost all functionality is exposed via dedicated elements. However, it can be useful in configuring obscure or overlooked options and in configuring transports from the generic endpoint elements. properties
0..1
A map of Mule properties.
<endpoint ...> A global endpoint, which acts as a template that can be used to construct an inbound or outbound endpoint elsewhere in the configuration by referencing the global endpoint name. Each transport implements its own endpoint element, with a more friendly syntax, but this generic element can be used with any transport by supplying the correct address URI. For example, "vm://foo" describes a VM transport endpoint.
Attributes
Name
Type
name
name (no spaces)
no
Identifies the endpoint so that other elements can reference it. This name can also be referenced in the MuleClient.
ref
name (no spaces)
no
A reference to a global endpoint, which is used as a template to construct this endpoint. A template fixes the address (protocol, path, host, etc.), and may specify initial values for various properties, but further properties can be defined locally (as long as they do not change the address in any way).
string
no
The generic address for this endpoint. If this attribute is used, the protocol must be specified as part of the URI. Alternatively,
address
Required
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 214
most transports provide their own attributes for specifying the address (path, host, etc.). Note that the address attribute cannot be combined with 'ref' or with the transport-provided alternative attributes. synchronous
boolean
no
If true, the result from the component processing the incoming message will be returned as a response.
responseTimeout
integer
no
The timeout for a response if making a synchronous endpoint call
string
no
String encoding used for messages.
name (no spaces)
no
The name of the connector associated with this endpoint. This must be specified if more than one connector is defined for this transport.
transformer-refs
list of names
no
A list of the transformers that will be applied (in order) to the message before it is delivered to the component.
responseTransformerrefs
list of names
no
A list of the transformers that will be applied (in order) to the synchronous response before it is returned via the transport.
encoding
connector-ref
Document generated by Confluence on Mar 11, 2009 14:57
Page 215
Child Elements
Name
Cardinality
Description
abstract-transaction
0..1
A placeholder for transaction elements. Transactions allow a series of operations to be grouped together.
abstract-filter
0..1
A placeholder for filter elements, which control which messages are handled.
abstract-security-filter
0..1
A placeholder for security filter elements, which control access to the system.
abstract-retry-policy
0..1
A placeholder for a retry policy element. Retry policies define how Mule should retry a failed message send/dispatch/request.
abstract-multi-transaction
0..1
A placeholder for multitransaction elements. Multitransactions allow a series of operations to be grouped together spanning different transports, e.g. JMS and JDBC, but without the overhead of XA. The trade-off is that XA reliability guarantees aren't available, and services must be ready to handle duplicates. This is very similar to a 1.5 PC concept. EE-only feature.
abstract-transformer
0..*
A placeholder for transformer elements. Transformers convert message payloads.
transformers
0..1
A list of transformer elements that will be applied to the message before it is delivered to the component. Note that a list of transformers can also be specified directly (without the 'transformers' element), but then it is not possible to also specify response transformers (using the 'response-transformers' element).
response-transformers
0..1
A list of transformer elements that will be applied to the response message returned from the component.
property
0..*
Sets a Mule property. This is a name/value pair that can be set on components, services, etc., and which provide a generic
Document generated by Confluence on Mar 11, 2009 14:57
Page 216
way of configuring the system. Typically, you shouldn't need to use a generic property like this, since almost all functionality is exposed via dedicated elements. However, it can be useful in configuring obscure or overlooked options and in configuring transports from the generic endpoint elements. properties
0..1
Document generated by Confluence on Mar 11, 2009 14:57
A map of Mule properties.
Page 217
Exception Strategy Configuration Reference This page last changed on Feb 20, 2009 by jackie.wheeler.
Exception Strategy Configuration Reference This page provides details on the elements you configure for exception strategies. This information is pulled directly from mule.xsd and is cached. If the information appears to be out of date, refresh the page. For more information on exception strategies, see Error Handling.
<default-service-exception-strategy ...> Provide default exception handling for a service via an endpoint.
Attributes
Name enableNotifications
Type
Required boolean
Default
no
Description Determines whether ExceptionNotifications will be fired from this strategy when an exception occurs.
Child Elements
Name
Cardinality
Description
commit-transaction
0..1
Defines when a current transaction gets committed based on the name of the exception caught. You can set a comma-separated list of wildcard patterns that will be matched against the fully qualified classname of the current exception. Patterns defined for this element will leave the current transaction (if any) untouched and allow it to be committed.
rollback-transaction
0..1
Defines when a current transaction gets rolled back based on the name of the exception caught. You can set a comma-separated list of wildcard patterns that will be matched against the fully qualified classname of the current exception. Patterns defined for this element will roll back the current transaction (if any).
Document generated by Confluence on Mar 11, 2009 14:57
Page 218
abstract-outbound-endpoint
0..*
A placeholder for outbound endpoint elements. Outbound endpoints dispatch messages to the underlying transport.
<default-connector-exception-strategy ...> Provide default exception handling for a connector via an endpoint.
Attributes
Name enableNotifications
Type
Required boolean
Default
no
Description Determines whether ExceptionNotifications will be fired from this strategy when an exception occurs.
Child Elements
Name
Cardinality
Description
commit-transaction
0..1
Defines when a current transaction gets committed based on the name of the exception caught. You can set a comma-separated list of wildcard patterns that will be matched against the fully qualified classname of the current exception. Patterns defined for this element will leave the current transaction (if any) untouched and allow it to be committed.
rollback-transaction
0..1
Defines when a current transaction gets rolled back based on the name of the exception caught. You can set a comma-separated list of wildcard patterns that will be matched against the fully qualified classname of the current exception. Patterns defined for this element will roll back the current transaction (if any).
abstract-outbound-endpoint
0..*
A placeholder for outbound endpoint elements. Outbound endpoints dispatch messages to the underlying transport.
Document generated by Confluence on Mar 11, 2009 14:57
Page 219
<custom-exception-strategy ...> A user-defined exception strategy.
Attributes
Name enableNotifications
class
Type
Required
Default
Description
boolean
no
Determines whether ExceptionNotifications will be fired from this strategy when an exception occurs.
class name
no
A class that implements the ExceptionListener interface. In addition, if an 'outboundendpoint' element is specified, it is set as an "endpoint" bean property.
Child Elements
Name
Cardinality
Description
commit-transaction
0..1
Defines when a current transaction gets committed based on the name of the exception caught. You can set a comma-separated list of wildcard patterns that will be matched against the fully qualified classname of the current exception. Patterns defined for this element will leave the current transaction (if any) untouched and allow it to be committed.
rollback-transaction
0..1
Defines when a current transaction gets rolled back based on the name of the exception caught. You can set a comma-separated list of wildcard patterns that will be matched against the fully qualified classname of the current exception. Patterns defined for this element will roll back the current transaction (if any).
Document generated by Confluence on Mar 11, 2009 14:57
Page 220
abstract-outbound-endpoint
0..*
spring:property
0..*
Document generated by Confluence on Mar 11, 2009 14:57
A placeholder for outbound endpoint elements. Outbound endpoints dispatch messages to the underlying transport.
Page 221
Filters Configuration Reference This page last changed on Feb 20, 2009 by jackie.wheeler.
Filters Configuration Reference [ Filter ] [ Not Filter ] [ And Filter ] [ Or Filter ] [ Wildcard Filter ] [ Expression Filter ] [ Regex Filter ] [ Message Property Filter ] [ Exception Type Filter ] [ Payload Type Filter ] [ Custom Filter ] [ Encryption Security Filter ] [ Is Xml Filter ] [ Jxpath Filter ] [ Jaxen Filter ] [ Xpath Filter ] [ Schema Validation Filter ] For more information on filters, see Using Filters.
Filter A filter that is defined elsewhere (at the global level, or as a Spring bean).
Attributes of
Name
Type
Required
Default
Description
name
name (no spaces)
no
Identifies the filter so that other elements can reference it. Required if the filter is defined at the global level.
not
boolean
no
Inverts the filter condition.
ref
name (no spaces)
no
The name of the filter to use.
Not Filter Inverts the enclosed filter. For example, if the filter would normally return true for a specific message, it will now return false, and vice versa.
Child Elements of <not-filter...>
Name
Cardinality
Description
abstract-filter
0..1
A placeholder for filter elements, which control which messages are handled.
And Filter Returns true only if all the enclosed filters return true.
Document generated by Confluence on Mar 11, 2009 14:57
Page 222
Child Elements of
Name
Cardinality
Description
abstract-filter
2..*
A placeholder for filter elements, which control which messages are handled.
Or Filter Returns true if any of the enclosed filters returns true.
Child Elements of
Name
Cardinality
Description
abstract-filter
2..*
A placeholder for filter elements, which control which messages are handled.
Wildcard Filter A filter that matches string messages against wildcards. It performs matches with "", for example, "jms.events." would catch "jms.events.customer" and "jms.events.receipts". This filter accepts a comma-separated list of patterns, so more than one filter pattern can be matched for a given argument: "jms.events., jms.actions." will match "jms.events.system" and "jms.actions" but not "jms.queue".
Expression Filter A filter that can evaluate a range of expressions. It supports some base expression types such as header, payload (payload type), regex, and wildcard.
Attributes of <expression-filter...>
Name
Type
Required
name
name (no spaces)
no
Identifies the filter so that other elements can reference it. Required if the filter is defined at the global level.
not
boolean
no
Inverts the filter condition.
evaluator
header/payloadtype/exceptiontype/wildcard/ regex/ognl/xpath/ jxpath/groovy/ bean/custom
no
The expression evaluator to use. The expression filter supports some types such as header, payload,
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 223
exception, wildcard, and regex, that are built-in filters not registered with the ExpressionEvaluatorManager. All others are registered with the ExpressionEvaluatorManager. Where XPath, bean, and ONGL are used, the expression should be a boolean expression. expression
string
no
The expression that will be evaluated. This should always be a boolean expression. The syntax of the expression will be determined by the expression language being used.
customEvaluator
name (no spaces)
no
Must be set if the evaluator is set to custom. The custom evaluator must be registered with the ExpressionEvaluatorManager if it is to be used here.
nullReturnsTrue
boolean
no
Whether the filter should return true if the specified expression returns null.
Regex Filter A filter that matches string messages against a regular expression. The Java regular expression engine (java.util.regex.Pattern) is used.
Attributes of
Name
Type
Required
name
name (no spaces)
no
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description Identifies the filter so that other elements can reference it.
Page 224
Required if the filter is defined at the global level. not
boolean
no
Inverts the filter condition.
pattern
string
no
The property name and optionally a value to use when matching. If the expression is just a property name, the filter will check that the property exists. Users can also use '=' and '! =' to determine a specific value for a property.
Message Property Filter A filter that matches properties on a message. This can be very useful, as the message properties represent all the meta information about the message from the underlying transport, so for a message received over HTTP, you can check for HTTP headers and so forth. The pattern should be expressed as a key/value pair, such as "propertyName=value". If you want to compare more than one property, you can use the logic filters for And, Or, and Not expressions. By default, the comparison is case sensitive, which you can override with the 'caseSensitive' property.
Attributes of <message-property-filter...>
Name
Type
Required
name
name (no spaces)
no
Identifies the filter so that other elements can reference it. Required if the filter is defined at the global level.
not
boolean
no
Inverts the filter condition.
pattern
string
no
The property name and optionally a value to use when matching. If the expression is just a property name, the filter will check that the property exists. Users can also use '=' and '! =' to determine a specific value for a property.
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 225
caseSensitive
boolean
no
true
If false, the comparison ignores case.
Default
Description
Exception Type Filter A filter that matches the type of an exception.
Attributes of <exception-type-filter...>
Name
Type
Required
name
name (no spaces)
no
Identifies the filter so that other elements can reference it. Required if the filter is defined at the global level.
not
boolean
no
Inverts the filter condition.
expectedType
class name
no
The expected class used in the comparison.
Payload Type Filter A filter that matches the type of the payload.
Attributes of <payload-type-filter...>
Name
Type
Required
Default
Description
name
name (no spaces)
no
Identifies the filter so that other elements can reference it. Required if the filter is defined at the global level.
not
boolean
no
Inverts the filter condition.
expectedType
class name
no
The expected class used in the comparison.
Custom Filter A user-implemented filter.
Document generated by Confluence on Mar 11, 2009 14:57
Page 226
Attributes of <custom-filter...>
Name
Type
Required
Default
Description
name
name (no spaces)
no
Identifies the filter so that other elements can reference it. Required if the filter is defined at the global level.
not
boolean
no
Inverts the filter condition.
class
class name
no
An implementation of the Filter interface.
Child Elements of <custom-filter...>
Name
Cardinality
spring:property
0..*
Description
Encryption Security Filter A filter that provides password-based encyption.
Attributes of <encryption-security-filter...>
Name
Type
Required
strategy-ref
name (no spaces)
no
Default
Description The name of the encryption strategy to use. This should be configured using the 'passwordencryptionstrategy' element, inside a 'securitymanager' element at the top level.
Is Xml Filter Accepts XML messages only. Alternatively, you can set the "not" attribute to filter out XML messages.
Jxpath Filter Filters messages based on XPath expressions using JXPath.
Document generated by Confluence on Mar 11, 2009 14:57
Page 227
Attributes of <jxpath-filter...>
Name
Type
Required
Default
Description
lenient
boolean
no
true
Whether or not errors are thrown if the XPath expression doesn't exist.
expectedValue
string
no
The expected value of the XPath expression evaluation. If the expected value matches the evaluation, the filter returns true.
Child Elements of <jxpath-filter...>
Name
Cardinality
Description
namespace
0..*
A namespace declaration, expressed as prefix and uri attributes. The prefix can then be used inside the expression.
context-property
0..*
A property that will be made available to the filter context. Expression Evaluators can be used to grab these properties from the message at runtime.
Jaxen Filter The Jaxen filter allows you to route messages based on XPath expressions. The Jaxen filter is generally faster than the JXPath filter and should be considered the first choice when using an XPath filter.
Attributes of <jaxen-filter...>
Name
Type
Required
expectedValue
string
no
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description The expected value of the XPath expression evaluation. If the expected value matches the evaluation, the filter returns true.
Page 228
Child Elements of <jaxen-filter...>
Name
Cardinality
Description
namespace
0..*
A namespace declaration, expressed as prefix and uri attributes. The prefix can then be used inside the expression.
context-property
0..*
A property that wil be made available to the filter context. Expression Evaluators can be used to grab these properties from the message at runtime.
Xpath Filter The XPath filter uses the JAXP libraries to filter XPath expressions. Available as of Mule 2.2.
Attributes of <xpath-filter...>
Name
Type
Required
expectedValue
string
no
Default
Description The expected value of the XPath expression evaluation. If the expected value matches the evaluation, the filter returns true.
Child Elements of <xpath-filter...>
Name
Cardinality
Description
namespace
0..*
A namespace declaration, expressed as prefix and uri attributes. The prefix can then be used inside the expression.
Schema Validation Filter The schema validation filter uses the JAXP libraries to validate your message against a schema. Available as of Mule 2.2.
Attributes of <schema-validation-filter...>
Name
Type
Required
schemaLocations
string
no
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description The path to the schema file. You can specify
Page 229
multiple schema locations for validation. schemaLanguage
string
no
returnResult
boolean
no
Document generated by Confluence on Mar 11, 2009 14:57
The schema language to use. The default is "http:// www.w3.org/2001/ XMLSchema". true
Whether the filter should cache the result of the XML. If this is false, the filter will be more efficient, but it won't allow you to read the XML again.
Page 230
Global Settings Configuration Reference This page last changed on Feb 20, 2009 by jackie.wheeler.
Global Settings Configuration Reference This page provides details on the global settings you configure at the root level of a Mule configuration. Some of this information is pulled directly from mule.xsd and is cached. If the information appears to be out of date, refresh the page. For more information on configuration, see XML Configuration. For information on threading profiles, see Tuning Performance.
Specifies defaults and general settings for the Mule instance.
Attributes
Name
Type
Required
Default
Description
defaultSynchronousEndpoints boolean
no
false
If true, all requests to endpoints will wait for a response.
defaultResponseTimeout
string
no
10000
The default period (ms) to wait for a synchronous response.
defaultTransactionTimeout string
no
30000
The default timeout (ms) for transactions. This can also be configured on transactions, in which case the transaction configuration is used instead of this default.
Child Elements
Name
Cardinality
Description
default-threading-profile
0..1
The default threading profile, used by components and by endpoints for dispatching and receiving if no more specific configuration is given.
default-dispatcher-threadingprofile
0..1
The default dispatching threading profile, which modifies the default-threading-profile values and is used by endpoints for dispatching messages.
Document generated by Confluence on Mar 11, 2009 14:57
Page 231
This can also be configured on connectors, in which case the connector configuration is used instead of this default. default-receiver-threadingprofile
0..1
The default receiving threading profile, which modifies the default-threading-profile values and is used by endpoints for receiving messages. This can also be configured on connectors, in which case the connector configuration is used instead of this default.
default-service-threading-profile
0..1
The default service threading profile, which modifies the default-threading-profile and is used by services for processing messages. This can also be configured on models or services, in which case these configurations will be used instead of this default.
abstract-retry-policy
0..1
The default retry policy, used by connectors and endpoints. This can also be configured on connectors, in which case the connector configuration is used instead of this default. A placeholder for a retry policy element. Retry policies define how Mule should retry a failed message send/dispatch/request.
Document generated by Confluence on Mar 11, 2009 14:57
Page 232
Inbound Router Configuration Reference This page last changed on Feb 20, 2009 by jackie.wheeler.
Inbound Router Configuration Reference This page provides details on the elements you configure for inbound routers. This information is pulled directly from mule.xsd and is cached. If the information appears to be out of date, refresh the page. For more information on routers, see Using Message Routers.
Ensures that only unique messages are received by a service by checking the unique ID of the incoming message. Note that the ID used can be generated from the message using an expression defined in the 'idExpression' attribute. By default, the expression used is '#[message:id]', which means the underlying endpoint must support unique message IDs for this to work. Otherwise, a UniqueIdNotSupportedException is thrown.
Attributes
Name idExpression
Type
Required string
Default
no
Description Defines one or more expressions to use when extracting the ID from the message. For example, it would be possible to combine to headers as the ID of the message to provide idempotency: '#[headers:foo,bar]'. Or, you could combine the message ID with a header: '#[message:id]#[header:foo]'. If this property is not set, '#[message:id]' will be used by default.
Child Elements
Name
Cardinality
Description
abstract-filter
0..1
A placeholder for filter elements, which control which messages are handled.
Document generated by Confluence on Mar 11, 2009 14:57
Page 233
abstract-object-store
0..1
A placeholder for an object store that can be used by routers to maintain state.
Ensures that only unique messages are received by a service by calculating the hash of the message itself using a message digest algorithm. This provides a value with an infinitesimally small chance of a collision. This can be used to filter message duplicates. Keep in mind that the hash is calculated over the entire byte array representing the message, so any leading or trailing spaces or extraneous bytes (like padding) can produce different hash values for the same semantic message content. Care should be taken to ensure that messages do not contain extraneous bytes. This class is useful when the message does not support unique identifiers.
Attributes
Name
Type
messageDigestAlgorithm
Required string
Default
no
Description The secure hashing algorithm to use. If not set, the default is SHA-256.
Child Elements
Name
Cardinality
Description
abstract-filter
0..1
A placeholder for filter elements, which control which messages are handled.
abstract-object-store
0..1
A placeholder for an object store that can be used by routers to maintain state.
<wire-tap-router ...> The WireTap inbound router allows you to route certain messages to a different endpoint as well as to the component.
Attributes Child Elements
Name
Type
Required
Name
Cardinality
Description
abstract-filter
0..1
A placeholder for filter elements, which control which messages are handled.
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 234
abstractoutboundendpoint
1..1
A placeholder for outbound endpoint elements. Outbound endpoints dispatch messages to the underlying transport.
Allows messages to be forwarded to the outbound routers without first being processed by a component.
Attributes
Name
Type
transformFirst
Required boolean
Default
no
Description Specifies whether transformations are applied before filtering occurs. The default is true.
Child Elements
Name
Cardinality
Description
abstract-filter
0..1
A placeholder for filter elements, which control which messages are handled.
abstract-transformer
0..*
A placeholder for transformer elements. Transformers convert message payloads.
<selective-consumer-router ...> Applies one or more filters to the incoming message. If the filters match, the message is forwarded to the component. Otherwise, the message is forwarded to the catch-all strategy on the router. If no catch-all strategy is configured, the message is ignored and a warning is logged.
Attributes
Name transformFirst
Type
Required boolean
Document generated by Confluence on Mar 11, 2009 14:57
no
Default
Description Specifies whether transformations are applied before filtering occurs. The default is true.
Page 235
Child Elements
Name
Cardinality
Description
abstract-filter
0..1
A placeholder for filter elements, which control which messages are handled.
abstract-transformer
0..*
A placeholder for transformer elements. Transformers convert message payloads.
Holds back a group of messages and resequences them using each message's correlation sequence property.
Attributes
Name
Type
Required
Default
Description
timeout
integer
no
Defines a timeout in Milliseconds to wait for events to be aggregated. By default the router will throw an exeception if the router is waiting for a correlation group and times out before all group enties are received.
failOnTimeout
boolean
no
When false, incomplete aggregation groups will be forwarded to a component on timeout as a java.util.List. When true (default), a CorrelationTimeoutException is thrown and RoutingNotification.CORRELATIO is fired. The component doesn't receive any messages in this case.
Document generated by Confluence on Mar 11, 2009 14:57
Page 236
Child Elements
Name
Cardinality
Description
abstract-filter
0..1
A placeholder for filter elements, which control which messages are handled.
<message-chunking-aggregator-router ...> Combines two or more messages into a single message by matching messages with a given Correlation ID. Correlation IDs are set on messages when they are dispatched by certain outbound routers, such as the Recipient List and Message Splitter routers. These messages can be aggregated back together again using this router.
Attributes
Name
Type
Required
Default
Description
timeout
integer
no
Defines a timeout in Milliseconds to wait for events to be aggregated. By default the router will throw an exeception if the router is waiting for a correlation group and times out before all group enties are received.
failOnTimeout
boolean
no
When false, incomplete aggregation groups will be forwarded to a component on timeout as a java.util.List. When true (default), a CorrelationTimeoutException is thrown and RoutingNotification.CORRELATIO is fired. The component doesn't receive any messages in this case.
Document generated by Confluence on Mar 11, 2009 14:57
Page 237
Child Elements
Name
Cardinality
Description
abstract-filter
0..1
A placeholder for filter elements, which control which messages are handled.
abstract-message-info-mapping
0..1
Maps the attributes of the current message to known message elements in Mule, namely Message ID and CorrrelationID.
<custom-correlation-aggregator-router ...> Configures a custom message aggregator. Mule provides an abstract implementation that has a template method that performs the message aggregation. A common use of the aggregator router is to combine the results of multiple requests such as "ask this set of vendors for the best price of X".
Attributes
Name
Type
Required
Default
Description
timeout
integer
no
Defines a timeout in Milliseconds to wait for events to be aggregated. By default the router will throw an exeception if the router is waiting for a correlation group and times out before all group enties are received.
failOnTimeout
boolean
no
When false, incomplete aggregation groups will be forwarded to a component on timeout as a java.util.List. When true (default), a CorrelationTimeoutException is thrown and RoutingNotification.CORRELATIO is fired. The component doesn't receive any messages in this case.
Document generated by Confluence on Mar 11, 2009 14:57
Page 238
class
class name
no
Fully qualified class name of the custom correlation aggregator router to be used.
Child Elements
Name
Cardinality
Description
abstract-filter
0..1
A placeholder for filter elements, which control which messages are handled.
abstract-message-info-mapping
0..1
Maps the attributes of the current message to known message elements in Mule, namely Message ID and CorrrelationID.
Configures a Collection Response Router. This will return a MuleMessageCollection message type that will contain all messages received for a each correlation group.
Attributes
Name
Type
Required
Default
Description
timeout
integer
no
Defines a timeout in Milliseconds to wait for events to be aggregated. By default the router will throw an exeception if the router is waiting for a correlation group and times out before all group enties are received.
failOnTimeout
boolean
no
When false, incomplete aggregation groups will be forwarded to a component on timeout as a java.util.List. When true (default), a CorrelationTimeoutException is thrown and RoutingNotification.CORRELATIO is fired. The
Document generated by Confluence on Mar 11, 2009 14:57
Page 239
component doesn't receive any messages in this case.
Child Elements
Name
Cardinality
Description
abstract-filter
0..1
A placeholder for filter elements, which control which messages are handled.
<custom-inbound-router ...> Allows for custom inbound routers to be configured.
Attributes
Name class
Type
Required
class name
Default
no
Description An implementation of InboundRouter (fully qualified Java class name)
Child Elements
Name
Cardinality
Description
abstract-filter
0..1
A placeholder for filter elements, which control which messages are handled.
spring:property
0..*
Spring-style property elements so that custom configuration can be configured on the custom router.
Document generated by Confluence on Mar 11, 2009 14:57
Page 240
Model Configuration Reference This page last changed on Feb 20, 2009 by jackie.wheeler.
Model Configuration Reference This page provides details on the elements you configure for models. Some of this information is pulled directly from mule.xsd and is cached. If the information appears to be out of date, refresh the page. For more information on models, see Models.
<model ...> The container for a set of services, providing basic settings and processing for all the services it contains.
Attributes
Name
Type
Required
Default
Description
name
name
no
The name used to identify this model.
inherit
boolean
no
If true, this model element is an extension of a previous model element with the same name.
Child Elements
Name
Cardinality
Description
abstract-exception-strategy
0..1
A placeholder for an exception strategy element. Exception strategies define how Mule should react to errors.
abstract-service
0..*
A placeholder for a service element. Services combine message routing with a component (typically a POJO).
abstract-entry-point-resolver-set
0..1
A placeholder for entry point resolver set elements. These combine a group of entry point resolvers, trying them in turn until one succeeds.
abstract-entry-point-resolver
0..1
A placeholder for an entry point resolver element. Entry point resolvers define how payloads are delivered to Java code by choosing the method to call.
Document generated by Confluence on Mar 11, 2009 14:57
Page 241
abstract-queue-profile
0..1
A placeholder for a queue profile, which controls how messages are queued.
Queue Profile Specifies the properties of an internal Mule queue. Internal queues are used to queue messages for each component managed by Mule.
Attributes of
Name
Type
Required
maxOutstandingMessages integer
no
persistent
no
boolean
Default
Description Defines the maximum number of messages that can be queued.
false
Whether Mule messages are persisted to a store. Primarily, this is used for persisting queued messages to disk so that the internal state of the server is mirrored on disk in case the server fails and needs to be restarted. Default is false.
Exception Strategy See Exception Strategy Configuration Reference.
Service See Service Configuration Reference.
Entry Point Resolver See Entry Point Resolver Configuration Reference.
Document generated by Confluence on Mar 11, 2009 14:57
Page 242
Notifications Configuration Reference This page last changed on Feb 20, 2009 by jackie.wheeler.
Notifications Configuration Reference This page provides details on the elements you configure for notifications. Some of this information is pulled directly from mule.xsd and is cached. If the information appears to be out of date, refresh the page. For more information on notifications, see Mule Server Notifications.
Notifications Registers listeners for notifications and associates interfaces with particular events.
Attributes of <notifications...>
Name
Type
Required
dynamic
boolean
no
Default
Description If the notification manager is dynamic, listeners can be registered dynamically at runtime via the MuleContext, and the configured notification can be changed. Otherwise, some parts of Mule will cache notification configuration for efficiency and will not generate events for newly enabled notifications or listeners. The default value is false.
Child Elements of <notifications...>
Name
Cardinality
Description
notification
0..*
Associates an event with an interface. Listeners that implement the interface will receive instances of the event.
disable-notification
0..*
Blocks the association of an event with a particular interface. This filters events after the association with a particular interface (and so takes precedence).
Document generated by Confluence on Mar 11, 2009 14:57
Page 243
notification-listener
0..*
Registers a bean as a listener with the notification system. Events are dispatched by reflection - the listener will receive all events associated with any interfaces it implements. The relationship between interfaces and events is configured by the notification and disable-notification elements.
Notification Associates an event with an interface. Listeners that implement the interface will receive instances of the event.
Attributes of <notification...>
Name
Type
Required
Default
Description
event-class
class name
no
The class associated with a notification event that will be delivered to the interface. This can be used instead of the 'event' attribute to specify a custom class.
event
notificationTypes
no
The notification event to deliver.
interface-class
class name
no
The interface (class name) that will receive the notification event.
interface
notificationTypes
no
The interface that will receive the notification event.
Disable Notification Blocks the association of an event with a particular interface. This filters events after the association with a particular interface (and so takes precedence).
Attributes of
Name
Type
Required
event-class
class name
no
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description The class associated with
Page 244
an event that will no longer be delivered to any interface. This can be used instead of the 'event' attribute to specify a custom class. event
notificationTypes
no
The event you no longer want to deliver.
interface-class
class name
no
The interface (class name) that will no longer receive the event.
interface
notificationTypes
no
The interface that will no longer receive the event.
Notification Listener Registers a bean as a listener with the notification system. Events are dispatched by reflection - the listener will receive all events associated with any interfaces it implements. The relationship between interfaces and events is configured by the notification and disable-notification elements.
Attributes of <notification-listener...>
Name
Type
Required
Default
Description
ref
name (no spaces)
no
The bean that will receive notifications.
subscription
string
no
An optional string that is compared with the event resource identifier. Only events with matching identifiers will be sent. If no value is given, all events are sent.
Notification Types You can specify the following types of notifications using the event attribute of the <notification> and element: "CONTEXT" "MODEL" "SERVICE" "SECURITY" "ENDPOINT-MESSAGE" "COMPONENT-MESSAGE" "MANAGEMENT" "CONNECTION"
Document generated by Confluence on Mar 11, 2009 14:57
Page 245
"REGISTRY" "CUSTOM" "EXCEPTION" "TRANSACTION" "ROUTING"
Document generated by Confluence on Mar 11, 2009 14:57
Page 246
Outbound Router Configuration Reference This page last changed on Feb 20, 2009 by jackie.wheeler.
Outbound Router Configuration Reference This page provides details on the elements you configure for outbound routers. This information is pulled directly from the schema files and is cached. If the information appears to be out of date, refresh the page. For more information on routers, see Using Message Routers.
<pass-through-router ...> This router always matches and simply sends or dispatches message via the endpoint that is configured.
Attributes
Name enableCorrelation
Type
Required
ALWAYS / NEVER / IF_NOT_SET
no
Default IF_NOT_SET
Description Specifies whether Mule should give outgoing messages a correlation ID. The default behavior is to give messages a correlation ID only if they don't already have one, so that existing correlation IDs are maintained.
Child Elements
Name
Cardinality
Description
abstract-outbound-endpoint
1..1
A placeholder for outbound endpoint elements. Outbound endpoints dispatch messages to the underlying transport.
reply-to
0..1
Defines where the message should be routed after the recipient of the message to which this service dispatches has finished with it.
abstract-transaction
0..1
Defines an overall transaction that will be used for all endpoints on this router. This is only useful when you want to define an outbound only transaction that will commit all of the transactions defined on the outbound endpoints for this router. Note that you must still define a transaction on each of
Document generated by Confluence on Mar 11, 2009 14:57
Page 247
the endpoints that should take part in the transaction. These transactions should always be configured to JOIN the existing transaction. A placeholder for transaction elements. Transactions allow a series of operations to be grouped together. abstract-message-info-mapping
0..1
The message info mapper used to extract key bits of the message information, such as Message ID or Correlation ID. these properties are used by some routers and this mapping information tells Mule where to get the information from in the current message. Maps the attributes of the current message to known message elements in Mule, namely Message ID and CorrrelationID.
Uses filters to determine whether the message matches a particular criteria and if so will route the message to the endpoint configured on the router.
Attributes
Name
Type
Required
transformer-refs
list of names
no
enableCorrelation
ALWAYS / NEVER / IF_NOT_SET
no
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description A list of the transformers that will be applied to the message in order before it is delivered to the component.
IF_NOT_SET
Specifies whether Mule should give outgoing messages a correlation ID. The default behavior is to give messages a correlation ID only if they don't already have one, so that existing correlation IDs are maintained.
Page 248
Child Elements
Name
Cardinality
Description
abstract-outbound-endpoint
1..1
A placeholder for outbound endpoint elements. Outbound endpoints dispatch messages to the underlying transport.
abstract-filter
0..1
Filters the messages to be processed by this router. @Deprecated since 2.2. Configure the filter on the endpoint instead of the router. A placeholder for filter elements, which control which messages are handled.
abstract-transformer
0..*
Filters are applied before message transformations. A transformer can be configured here to transform messages before they are filtered. A placeholder for transformer elements. Transformers convert message payloads.
reply-to
0..1
Defines where the message should be routed after the recipient of the message to which this service dispatches has finished with it.
abstract-transaction
0..1
Defines an overall transaction that will be used for all endpoints on this router. This is only useful when you want to define an outbound only transaction that will commit all of the transactions defined on the outbound endpoints for this router. Note that you must still define a transaction on each of the endpoints that should take part in the transaction. These transactions should always be configured to JOIN the existing transaction. A placeholder for transaction elements. Transactions allow a series of operations to be grouped together.
abstract-message-info-mapping
0..1
Document generated by Confluence on Mar 11, 2009 14:57
The message info mapper used to extract key bits of the message information, such as Message ID or Correlation ID. these properties are used by some routers and this mapping
Page 249
information tells Mule where to get the information from in the current message. Maps the attributes of the current message to known message elements in Mule, namely Message ID and CorrrelationID.
Allows endpoints to be altered at runtime based on properties set on the current message or fallback values set on the endpoint properties. Templated values are expressed using square braces around a property name.
Attributes
Name
Type
Required
transformer-refs
list of names
no
enableCorrelation
ALWAYS / NEVER / IF_NOT_SET
no
Default
Description A list of the transformers that will be applied to the message in order before it is delivered to the component.
IF_NOT_SET
Specifies whether Mule should give outgoing messages a correlation ID. The default behavior is to give messages a correlation ID only if they don't already have one, so that existing correlation IDs are maintained.
Child Elements
Name
Cardinality
Description
abstract-outbound-endpoint
1..1
A placeholder for outbound endpoint elements. Outbound endpoints dispatch messages to the underlying transport.
abstract-filter
0..1
Filters the messages to be processed by this router. @Deprecated since 2.2. Configure the filter on the endpoint instead of the router.
Document generated by Confluence on Mar 11, 2009 14:57
Page 250
A placeholder for filter elements, which control which messages are handled. abstract-transformer
0..*
Filters are applied before message transformations. A transformer can be configured here to transform messages before they are filtered. A placeholder for transformer elements. Transformers convert message payloads.
reply-to
0..1
Defines where the message should be routed after the recipient of the message to which this service dispatches has finished with it.
abstract-transaction
0..1
Defines an overall transaction that will be used for all endpoints on this router. This is only useful when you want to define an outbound only transaction that will commit all of the transactions defined on the outbound endpoints for this router. Note that you must still define a transaction on each of the endpoints that should take part in the transaction. These transactions should always be configured to JOIN the existing transaction. A placeholder for transaction elements. Transactions allow a series of operations to be grouped together.
abstract-message-info-mapping
0..1
The message info mapper used to extract key bits of the message information, such as Message ID or Correlation ID. these properties are used by some routers and this mapping information tells Mule where to get the information from in the current message. Maps the attributes of the current message to known message elements in Mule, namely Message ID and CorrrelationID.
Sends the message through multiple endpoints using the result of the first invocation as the input for the next.
Document generated by Confluence on Mar 11, 2009 14:57
Page 251
Attributes
Name
Type
Required
transformer-refs
list of names
no
enableCorrelation
ALWAYS / NEVER / IF_NOT_SET
no
Default
Description A list of the transformers that will be applied to the message in order before it is delivered to the component.
IF_NOT_SET
Specifies whether Mule should give outgoing messages a correlation ID. The default behavior is to give messages a correlation ID only if they don't already have one, so that existing correlation IDs are maintained.
Child Elements
Name
Cardinality
Description
abstract-outbound-endpoint
1..*
A placeholder for outbound endpoint elements. Outbound endpoints dispatch messages to the underlying transport.
abstract-filter
0..1
Filters the messages to be processed by this router. @Deprecated since 2.2. Configure the filter on the endpoint instead of the router. A placeholder for filter elements, which control which messages are handled.
abstract-transformer
0..*
Filters are applied before message transformations. A transformer can be configured here to transform messages before they are filtered. A placeholder for transformer elements. Transformers convert message payloads.
reply-to
0..1
Document generated by Confluence on Mar 11, 2009 14:57
Defines where the message should be routed after the recipient of the message to which this service dispatches has finished with it.
Page 252
abstract-transaction
0..1
Defines an overall transaction that will be used for all endpoints on this router. This is only useful when you want to define an outbound only transaction that will commit all of the transactions defined on the outbound endpoints for this router. Note that you must still define a transaction on each of the endpoints that should take part in the transaction. These transactions should always be configured to JOIN the existing transaction. A placeholder for transaction elements. Transactions allow a series of operations to be grouped together.
abstract-message-info-mapping
0..1
The message info mapper used to extract key bits of the message information, such as Message ID or Correlation ID. these properties are used by some routers and this mapping information tells Mule where to get the information from in the current message. Maps the attributes of the current message to known message elements in Mule, namely Message ID and CorrrelationID.
<exception-based-router ...> Sends a message over an endpoint by selecting the first endpoint that can connect to the transport.
Attributes
Name
Type
Required
transformer-refs
list of names
no
enableCorrelation
ALWAYS / NEVER / IF_NOT_SET
no
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description A list of the transformers that will be applied to the message in order before it is delivered to the component.
IF_NOT_SET
Specifies whether Mule should give outgoing messages a correlation ID. The default behavior is to give messages
Page 253
a correlation ID only if they don't already have one, so that existing correlation IDs are maintained.
Child Elements
Name
Cardinality
Description
abstract-outbound-endpoint
1..*
A placeholder for outbound endpoint elements. Outbound endpoints dispatch messages to the underlying transport.
abstract-filter
0..1
Filters the messages to be processed by this router. @Deprecated since 2.2. Configure the filter on the endpoint instead of the router. A placeholder for filter elements, which control which messages are handled.
abstract-transformer
0..*
Filters are applied before message transformations. A transformer can be configured here to transform messages before they are filtered. A placeholder for transformer elements. Transformers convert message payloads.
reply-to
0..1
Defines where the message should be routed after the recipient of the message to which this service dispatches has finished with it.
abstract-transaction
0..1
Defines an overall transaction that will be used for all endpoints on this router. This is only useful when you want to define an outbound only transaction that will commit all of the transactions defined on the outbound endpoints for this router. Note that you must still define a transaction on each of the endpoints that should take part in the transaction. These transactions should always be configured to JOIN the existing transaction. A placeholder for transaction elements. Transactions allow a series of operations to be grouped together.
Document generated by Confluence on Mar 11, 2009 14:57
Page 254
abstract-message-info-mapping
0..1
The message info mapper used to extract key bits of the message information, such as Message ID or Correlation ID. these properties are used by some routers and this mapping information tells Mule where to get the information from in the current message. Maps the attributes of the current message to known message elements in Mule, namely Message ID and CorrrelationID.
<multicasting-router ...> Sends the same message over multiple endpoints.
Attributes
Name
Type
Required
transformer-refs
list of names
no
enableCorrelation
ALWAYS / NEVER / IF_NOT_SET
no
Default
Description A list of the transformers that will be applied to the message in order before it is delivered to the component.
IF_NOT_SET
Specifies whether Mule should give outgoing messages a correlation ID. The default behavior is to give messages a correlation ID only if they don't already have one, so that existing correlation IDs are maintained.
Child Elements
Name
Cardinality
Description
abstract-outbound-endpoint
1..*
A placeholder for outbound endpoint elements. Outbound endpoints dispatch messages to the underlying transport.
abstract-filter
0..1
Filters the messages to be processed by this router. @Deprecated since 2.2.
Document generated by Confluence on Mar 11, 2009 14:57
Page 255
Configure the filter on the endpoint instead of the router. A placeholder for filter elements, which control which messages are handled. abstract-transformer
0..*
Filters are applied before message transformations. A transformer can be configured here to transform messages before they are filtered. A placeholder for transformer elements. Transformers convert message payloads.
reply-to
0..1
Defines where the message should be routed after the recipient of the message to which this service dispatches has finished with it.
abstract-transaction
0..1
Defines an overall transaction that will be used for all endpoints on this router. This is only useful when you want to define an outbound only transaction that will commit all of the transactions defined on the outbound endpoints for this router. Note that you must still define a transaction on each of the endpoints that should take part in the transaction. These transactions should always be configured to JOIN the existing transaction. A placeholder for transaction elements. Transactions allow a series of operations to be grouped together.
abstract-message-info-mapping
0..1
The message info mapper used to extract key bits of the message information, such as Message ID or Correlation ID. these properties are used by some routers and this mapping information tells Mule where to get the information from in the current message. Maps the attributes of the current message to known message elements in Mule, namely Message ID and CorrrelationID.
Document generated by Confluence on Mar 11, 2009 14:57
Page 256
<endpoint-selector-router ...> Selects the outgoing endpoint based on an expression evaluator ("header:endpoint" by default). It will first try to match the endpoint by name and then by address. The endpoints to use can be set on the router itself or be global endpoint definitions.
Attributes
Name
Type
Required
Default
Description
transformer-refs
list of names
no
enableCorrelation
ALWAYS / NEVER / IF_NOT_SET
no
default
name (no spaces)
no
The name of the default endpoint to use if the expression returns null. This can be used as an 'else' condition to route messages that don't contain the expected routing information.
evaluator
groovy / header / headers / headers-list / attachment / attachments / attachmentslist / message / string / mappayload / payload / mule / xpath / jxpath / bean / ognl / function / custom
no
The expression evaluator to use. Expression evaluators must be registered with the ExpressionEvaluatorManager before they can be used. Using the custom evaluator allows you to define your own evaluator with the 'custom-evaluator' attribute. Note that some evaluators such as
Document generated by Confluence on Mar 11, 2009 14:57
A list of the transformers that will be applied to the message in order before it is delivered to the component. IF_NOT_SET
Specifies whether Mule should give outgoing messages a correlation ID. The default behavior is to give messages a correlation ID only if they don't already have one, so that existing correlation IDs are maintained.
Page 257
xpath, groovy, and bean are loaded from other Mule modules (XML and Scripting, respectively). These modules must be on your classpath before the evaluator can be used. expression
custom-evaluator
string
no
The expression to evaluate. The syntax of this attribute changes depending on the evaluator being used.
name (no spaces)
no
The name of the custom evaluator to use. This attribute is only used when the 'evaluator' attribute is set to "custom". You can plug in your own expression evaluators by registering them with the ExpressionEvaluatorManager.
Child Elements
Name
Cardinality
Description
abstract-outbound-endpoint
1..*
A placeholder for outbound endpoint elements. Outbound endpoints dispatch messages to the underlying transport.
abstract-filter
0..1
Filters the messages to be processed by this router. @Deprecated since 2.2. Configure the filter on the endpoint instead of the router. A placeholder for filter elements, which control which messages are handled.
abstract-transformer
0..*
Document generated by Confluence on Mar 11, 2009 14:57
Filters are applied before message transformations. A transformer can be configured here to transform messages before they are filtered.
Page 258
A placeholder for transformer elements. Transformers convert message payloads. reply-to
0..1
Defines where the message should be routed after the recipient of the message to which this service dispatches has finished with it.
abstract-transaction
0..1
Defines an overall transaction that will be used for all endpoints on this router. This is only useful when you want to define an outbound only transaction that will commit all of the transactions defined on the outbound endpoints for this router. Note that you must still define a transaction on each of the endpoints that should take part in the transaction. These transactions should always be configured to JOIN the existing transaction. A placeholder for transaction elements. Transactions allow a series of operations to be grouped together.
abstract-message-info-mapping
0..1
The message info mapper used to extract key bits of the message information, such as Message ID or Correlation ID. these properties are used by some routers and this mapping information tells Mule where to get the information from in the current message. Maps the attributes of the current message to known message elements in Mule, namely Message ID and CorrrelationID.
<list-message-splitter-router ...> The Filtering List Message Splitter accepts a list of objects that is split each object being routed to different endpoints.
Attributes
Name transformer-refs
Type
Required
list of names
Document generated by Confluence on Mar 11, 2009 14:57
no
Default
Description A list of the transformers that will be applied to the message in
Page 259
order before it is delivered to the component. enableCorrelation
ALWAYS / NEVER / IF_NOT_SET
no
deterministic
boolean
no
If 'disableRoundRobin' is false and this option is true (the default) then the first message part will be routed to the first endpoint, the second part to the second endpoint, etc, with the nth part going to the (n modulo number of endpoints) endpoint. If false then the messages will be distributed equally amongst all endpoints.
disableRoundRobin
boolean
no
If filters are being used on endpoints then round robin behaviour is probably not desirable. This flag switches round robin behaviour off, it is on by default.
failIfNoMatch
boolean
no
If 'disableRoundRobin' is true, there may be situations where the current split message does not match any endpoints. this flag controls whether an exception should be thrown when
Document generated by Confluence on Mar 11, 2009 14:57
IF_NOT_SET
Specifies whether Mule should give outgoing messages a correlation ID. The default behavior is to give messages a correlation ID only if they don't already have one, so that existing correlation IDs are maintained.
Page 260
a match is not found.
Child Elements
Name
Cardinality
Description
abstract-outbound-endpoint
1..*
A placeholder for outbound endpoint elements. Outbound endpoints dispatch messages to the underlying transport.
abstract-filter
0..1
Filters the messages to be processed by this router. @Deprecated since 2.2. Configure the filter on the endpoint instead of the router. A placeholder for filter elements, which control which messages are handled.
abstract-transformer
0..*
Filters are applied before message transformations. A transformer can be configured here to transform messages before they are filtered. A placeholder for transformer elements. Transformers convert message payloads.
reply-to
0..1
Defines where the message should be routed after the recipient of the message to which this service dispatches has finished with it.
abstract-transaction
0..1
Defines an overall transaction that will be used for all endpoints on this router. This is only useful when you want to define an outbound only transaction that will commit all of the transactions defined on the outbound endpoints for this router. Note that you must still define a transaction on each of the endpoints that should take part in the transaction. These transactions should always be configured to JOIN the existing transaction. A placeholder for transaction elements. Transactions allow a series of operations to be grouped together.
abstract-message-info-mapping
0..1
Document generated by Confluence on Mar 11, 2009 14:57
The message info mapper used to extract key bits of the message information, such as
Page 261
Message ID or Correlation ID. these properties are used by some routers and this mapping information tells Mule where to get the information from in the current message. Maps the attributes of the current message to known message elements in Mule, namely Message ID and CorrrelationID.
<expression-splitter-router ...> Splits the message based on an expression. The expression must return one or more message parts in order to be effective.
Attributes
Name
Type
Required
transformer-refs
list of names
no
enableCorrelation
ALWAYS / NEVER / IF_NOT_SET
no
boolean
no
deterministic
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description A list of the transformers that will be applied to the message in order before it is delivered to the component.
IF_NOT_SET
Specifies whether Mule should give outgoing messages a correlation ID. The default behavior is to give messages a correlation ID only if they don't already have one, so that existing correlation IDs are maintained. If 'disableRoundRobin' is false and this option is true (the default) then the first message part will be routed to the first endpoint, the second part to the second endpoint, etc, with the nth part going to the (n modulo number of endpoints) endpoint. If false then the
Page 262
messages will be distributed equally amongst all endpoints. disableRoundRobin
boolean
no
If filters are being used on endpoints then round robin behaviour is probably not desirable. This flag switches round robin behaviour off, it is on by default.
failIfNoMatch
boolean
no
If 'disableRoundRobin' is true, there may be situations where the current split message does not match any endpoints. this flag controls whether an exception should be thrown when a match is not found.
groovy / header / headers / headers-list / attachment / attachments / attachmentslist / message / string / mappayload / payload / mule / xpath / jxpath / bean / ognl / function / custom
no
The expression evaluator to use. Expression evaluators must be registered with the ExpressionEvaluatorManager before they can be used. Using the custom evaluator allows you to define your own evaluator with the 'custom-evaluator' attribute. Note that some evaluators such as xpath, groovy, and bean are loaded from other Mule modules (XML and Scripting, respectively). These modules must be on your classpath before the evaluator can be used.
string
no
The expression to evaluate. The syntax of this attribute changes
evaluator
expression
Document generated by Confluence on Mar 11, 2009 14:57
Page 263
depending on the evaluator being used. custom-evaluator
name (no spaces)
no
The name of the custom evaluator to use. This attribute is only used when the 'evaluator' attribute is set to "custom". You can plug in your own expression evaluators by registering them with the ExpressionEvaluatorManager.
Child Elements
Name
Cardinality
Description
abstract-outbound-endpoint
1..*
A placeholder for outbound endpoint elements. Outbound endpoints dispatch messages to the underlying transport.
abstract-filter
0..1
Filters the messages to be processed by this router. @Deprecated since 2.2. Configure the filter on the endpoint instead of the router. A placeholder for filter elements, which control which messages are handled.
abstract-transformer
0..*
Filters are applied before message transformations. A transformer can be configured here to transform messages before they are filtered. A placeholder for transformer elements. Transformers convert message payloads.
reply-to
0..1
Defines where the message should be routed after the recipient of the message to which this service dispatches has finished with it.
abstract-transaction
0..1
Defines an overall transaction that will be used for all endpoints on this router. This is only useful when you want to define an outbound only transaction that will commit all of the transactions defined on the outbound endpoints for this
Document generated by Confluence on Mar 11, 2009 14:57
Page 264
router. Note that you must still define a transaction on each of the endpoints that should take part in the transaction. These transactions should always be configured to JOIN the existing transaction. A placeholder for transaction elements. Transactions allow a series of operations to be grouped together. abstract-message-info-mapping
0..1
The message info mapper used to extract key bits of the message information, such as Message ID or Correlation ID. these properties are used by some routers and this mapping information tells Mule where to get the information from in the current message. Maps the attributes of the current message to known message elements in Mule, namely Message ID and CorrrelationID.
Filter Based Splitter The filter-based splitter router will select the endpoint where you want to send part of a message by filtering parts using the endpoint filters.
Attributes of
Name
Type
Required
splitExpression
string
no
The XPath expression used to split the message.
externalSchemaLocation string
no
The location of a schema that should be used to validate the current message. This is not required if the message contains the location of the schema.
validateSchema
no
Whether to enable schema validation when processing the XML message. Note that this can have a serious performance hit on high-
boolean
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 265
throughput systems. failIfNoMatch
boolean
no
Whether this router should fail if none of the endpoint filters match the payload. The default is true.
Round Robin Splitter The round robin message splitter will split a DOM4J document into nodes based on the splitExpression property. It will then send these document fragments to the list of specified endpoints in a roundrobin fashion. Optionally, you can specify a namespaces property map that contain prefix/namespace mappings.
Attributes of
Name
Type
Required
splitExpression
string
no
The XPath expression used to split the message.
externalSchemaLocation string
no
The location of a schema that should be used to validate the current message. This is not required if the message contains the location of the schema.
validateSchema
boolean
no
Whether to enable schema validation when processing the XML message. Note that this can have a serious performance hit on highthroughput systems.
deterministic
boolean
no
If there is no endpoint filtering and this attribute is true (the default), the first message part is routed to the first endpoint, the second part routes to the second endpoint, and so on with the nth part going to the
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 266
(n modulo number of endpoints) endpoint. If false, the messages will be distributed equally among all endpoints.
<message-chunking-router ...> Allows you to split a single message into a number of fixed-length messages that will all be routed to the same endpoint.
Attributes
Name
Type
Required
Default
Description
transformer-refs
list of names
no
enableCorrelation
ALWAYS / NEVER / IF_NOT_SET
no
messageSize
integer
no
The message chunk size (in bytes) that the current message will be split into. Note that this is mutually exclusive to the 'numberOfMessages' property.
numberOfMessages
integer
no
The number of message peices to break the current message into. This property is less useful than the 'message' size property since, usually messages are constricted by size. Note that
Document generated by Confluence on Mar 11, 2009 14:57
A list of the transformers that will be applied to the message in order before it is delivered to the component. IF_NOT_SET
Specifies whether Mule should give outgoing messages a correlation ID. The default behavior is to give messages a correlation ID only if they don't already have one, so that existing correlation IDs are maintained.
Page 267
this is mutually exclusive to the 'messageSize' property.
Child Elements
Name
Cardinality
Description
abstract-outbound-endpoint
1..*
A placeholder for outbound endpoint elements. Outbound endpoints dispatch messages to the underlying transport.
abstract-filter
0..1
Filters the messages to be processed by this router. @Deprecated since 2.2. Configure the filter on the endpoint instead of the router. A placeholder for filter elements, which control which messages are handled.
abstract-transformer
0..*
Filters are applied before message transformations. A transformer can be configured here to transform messages before they are filtered. A placeholder for transformer elements. Transformers convert message payloads.
reply-to
0..1
Defines where the message should be routed after the recipient of the message to which this service dispatches has finished with it.
abstract-transaction
0..1
Defines an overall transaction that will be used for all endpoints on this router. This is only useful when you want to define an outbound only transaction that will commit all of the transactions defined on the outbound endpoints for this router. Note that you must still define a transaction on each of the endpoints that should take part in the transaction. These transactions should always be configured to JOIN the existing transaction. A placeholder for transaction elements. Transactions allow a series of operations to be grouped together.
Document generated by Confluence on Mar 11, 2009 14:57
Page 268
abstract-message-info-mapping
0..1
The message info mapper used to extract key bits of the message information, such as Message ID or Correlation ID. these properties are used by some routers and this mapping information tells Mule where to get the information from in the current message. Maps the attributes of the current message to known message elements in Mule, namely Message ID and CorrrelationID.
<static-recipient-list-router ...> Sends the same message to multiple endpoints over the same endpoint, or implements routing-slip behavior where the next destination for the message is determined from message properties or the payload. It uses a static list of recipient endpoints.
Attributes
Name
Type
Required
Default
Description
recipientsProperty
string
no
Defines a property name on the current message where a list of endpoint names (or URIs) can be obtained. This property can return a {{java.util.List}} of values or a delimited {{java.lang.String}}. If the 'recipientsProperty' returns a string then the 'recipientsDelimiter' property is used to split the string. If the entries in the String or List define endpoint names, these will be looked up at runtime. If the entries define endpoint URIs these endpoints will be created at runtime.
recipientsDelimiter
string
no
The delimiter to use when splitting
Document generated by Confluence on Mar 11, 2009 14:57
Page 269
a String list of recipients. the default is ','. This property is only used with the 'recipientsProperty'. synchronous
boolean
no
This flag controls whether the message will be sent to the recipients synchronously. Unlike other routers th recipient list router doesn't have preconfigured endpoints so the synchronicity of the endpoint cannot be honoured.
transformer-refs
list of names
no
A list of the transformers that will be applied to the message in order before it is delivered to the component.
enableCorrelation
ALWAYS / NEVER / IF_NOT_SET
no
IF_NOT_SET
Specifies whether Mule should give outgoing messages a correlation ID. The default behavior is to give messages a correlation ID only if they don't already have one, so that existing correlation IDs are maintained.
Child Elements
Name
Cardinality
Description
recipients
0..1
Static list of recipients that the outgoing message is sent to. The default delimiter is ','.
abstract-filter
0..1
Filters the messages to be processed by this router. @Deprecated since 2.2. Configure the filter on the endpoint instead of the router.
Document generated by Confluence on Mar 11, 2009 14:57
Page 270
A placeholder for filter elements, which control which messages are handled. abstract-transformer
0..*
Filters are applied before message transformations. A transformer can be configured here to transform messages before they are filtered. A placeholder for transformer elements. Transformers convert message payloads.
reply-to
0..1
Defines where the message should be routed after the recipient of the message to which this service dispatches has finished with it.
abstract-transaction
0..1
Defines an overall transaction that will be used for all endpoints on this router. This is only useful when you want to define an outbound only transaction that will commit all of the transactions defined on the outbound endpoints for this router. Note that you must still define a transaction on each of the endpoints that should take part in the transaction. These transactions should always be configured to JOIN the existing transaction. A placeholder for transaction elements. Transactions allow a series of operations to be grouped together.
abstract-message-info-mapping
0..1
The message info mapper used to extract key bits of the message information, such as Message ID or Correlation ID. these properties are used by some routers and this mapping information tells Mule where to get the information from in the current message. Maps the attributes of the current message to known message elements in Mule, namely Message ID and CorrrelationID.
<expression-recipient-list-router ...> Sends the same message to multiple endpoints over the same endpoint, or implements routing-slip behavior where the next destination for the message is determined from message properties or the payload. The recipients can be extracted from the message using an expression, or you can specify a static list of recipient endpoints. (As of version 2.1)
Document generated by Confluence on Mar 11, 2009 14:57
Page 271
Attributes
Name synchronous
Type
Required
Default
Description
boolean
no
This flag controls whether the message will be sent to the recipients synchronously. Unlike other routers th recipient list router doesn't have preconfigured endpoints so the synchronicity of the endpoint cannot be honoured.
transformer-refs
list of names
no
A list of the transformers that will be applied to the message in order before it is delivered to the component.
enableCorrelation
ALWAYS / NEVER / IF_NOT_SET
no
groovy / header / headers / headers-list / attachment / attachments / attachmentslist / message / string / mappayload / payload / mule / xpath / jxpath / bean / ognl / function / custom
no
evaluator
Document generated by Confluence on Mar 11, 2009 14:57
IF_NOT_SET
Specifies whether Mule should give outgoing messages a correlation ID. The default behavior is to give messages a correlation ID only if they don't already have one, so that existing correlation IDs are maintained. The expression evaluator to use. Expression evaluators must be registered with the ExpressionEvaluatorManager before they can be used. Using the custom evaluator allows you to define your own evaluator with the 'custom-evaluator' attribute. Note that some evaluators such as xpath, groovy, and
Page 272
bean are loaded from other Mule modules (XML and Scripting, respectively). These modules must be on your classpath before the evaluator can be used. expression
custom-evaluator
string
no
The expression to evaluate. The syntax of this attribute changes depending on the evaluator being used.
name (no spaces)
no
The name of the custom evaluator to use. This attribute is only used when the 'evaluator' attribute is set to "custom". You can plug in your own expression evaluators by registering them with the ExpressionEvaluatorManager.
Child Elements
Name
Cardinality
Description
recipients
0..1
A static list of endpoint names or URIs that will be used as recipients of the current message. If the expression on this router returns a list of endpoint names, the endpoints here will be checked as well as any global endpoints.
abstract-filter
0..1
Filters the messages to be processed by this router. @Deprecated since 2.2. Configure the filter on the endpoint instead of the router. A placeholder for filter elements, which control which messages are handled.
abstract-transformer
0..*
Document generated by Confluence on Mar 11, 2009 14:57
Filters are applied before message transformations. A transformer can be configured here to transform messages before they are filtered.
Page 273
A placeholder for transformer elements. Transformers convert message payloads. reply-to
0..1
Defines where the message should be routed after the recipient of the message to which this service dispatches has finished with it.
abstract-transaction
0..1
Defines an overall transaction that will be used for all endpoints on this router. This is only useful when you want to define an outbound only transaction that will commit all of the transactions defined on the outbound endpoints for this router. Note that you must still define a transaction on each of the endpoints that should take part in the transaction. These transactions should always be configured to JOIN the existing transaction. A placeholder for transaction elements. Transactions allow a series of operations to be grouped together.
abstract-message-info-mapping
0..1
The message info mapper used to extract key bits of the message information, such as Message ID or Correlation ID. these properties are used by some routers and this mapping information tells Mule where to get the information from in the current message. Maps the attributes of the current message to known message elements in Mule, namely Message ID and CorrrelationID.
<custom-outbound-router ...> Allows you to configure a custom outbound router by specifying the custom router class and by using Spring properties.
Attributes
Name class
Type
Required
class name
Document generated by Confluence on Mar 11, 2009 14:57
no
Default
Description An implementation of OutboundRouter
Page 274
(fully qualified Java class name) transformer-refs
list of names
no
enableCorrelation
ALWAYS / NEVER / IF_NOT_SET
no
A list of the transformers that will be applied to the message in order before it is delivered to the component. IF_NOT_SET
Specifies whether Mule should give outgoing messages a correlation ID. The default behavior is to give messages a correlation ID only if they don't already have one, so that existing correlation IDs are maintained.
Child Elements
Name
Cardinality
Description
abstract-outbound-endpoint
0..*
A placeholder for outbound endpoint elements. Outbound endpoints dispatch messages to the underlying transport.
spring:property
0..*
Spring-style property elements so that custom configuration can be configured on the custom router.
abstract-filter
0..1
Filters the messages to be processed by this router. @Deprecated since 2.2. Configure the filter on the endpoint instead of the router. A placeholder for filter elements, which control which messages are handled.
abstract-transformer
0..*
Filters are applied before message transformations. A transformer can be configured here to transform messages before they are filtered. A placeholder for transformer elements. Transformers convert message payloads.
reply-to
0..1
Document generated by Confluence on Mar 11, 2009 14:57
Defines where the message should be routed after the recipient of the message to
Page 275
which this service dispatches has finished with it. abstract-transaction
0..1
Defines an overall transaction that will be used for all endpoints on this router. This is only useful when you want to define an outbound only transaction that will commit all of the transactions defined on the outbound endpoints for this router. Note that you must still define a transaction on each of the endpoints that should take part in the transaction. These transactions should always be configured to JOIN the existing transaction. A placeholder for transaction elements. Transactions allow a series of operations to be grouped together.
abstract-message-info-mapping
0..1
The message info mapper used to extract key bits of the message information, such as Message ID or Correlation ID. these properties are used by some routers and this mapping information tells Mule where to get the information from in the current message. Maps the attributes of the current message to known message elements in Mule, namely Message ID and CorrrelationID.
Document generated by Confluence on Mar 11, 2009 14:57
Page 276
Properties Configuration Reference This page last changed on Feb 20, 2009 by jackie.wheeler.
Properties Configuration Reference This page provides detailed reference information for property elements in Mule. The information below is pulled directly from the source code, so it reflects the latest data since you loaded the page. If something appears to be out of date, you can refresh the page to reload the information.
Global Property A global property is a named string. It can be inserted in most attribute values using standard (ant-style) Spring placeholders.
Attributes of
Name
Type
Required
Default
Description
name
name (no spaces)
no
The name of the property. This is used inside Spring placeholders.
value
string
no
The value of the property. This replaces each occurence of a Spring placeholder.
Property Sets a Mule property. This is a name/value pair that can be set on components, services, etc., and which provide a generic way of configuring the system. Typically, you shouldn't need to use a generic property like this, since almost all functionality is exposed via dedicated elements. However, it can be useful in configuring obscure or overlooked options and in configuring transports from the generic endpoint elements.
Attributes of <property...>
Name
Type
Required
key
string
no
value
string
no
value-ref
name (no spaces)
no
Default
Description
Properties A map of Mule properties.
Document generated by Confluence on Mar 11, 2009 14:57
Page 277
Jndi Provider Property Direct setting of a JNDI property.
Attributes of <jndi-provider-property...>
Name
Type
Required
key
string
no
value
string
no
value-ref
name (no spaces)
no
Default
Description
Jndi Provider Properties Direct setting of JNDI properties (allows access to the full Spring map entry).
Document generated by Confluence on Mar 11, 2009 14:57
Page 278
Service Configuration Reference This page last changed on Feb 20, 2009 by jackie.wheeler.
Service Configuration Reference This page provides details on the elements you configure for services. This information is pulled directly from mule.xsd and is cached. If the information appears to be out of date, refresh the page. For more information on services, see Configuring the Service.
<service ...> Describes how to receive messages, deliver them to a component, and handle the results (if any).
Attributes
Name name
initialState
queueTimeout
Type
Required name
no
started / stopped / paused
no
integer
no
Default
Description The name used to identify this service.
started
The initial state of the service. Usually a service is started automatically ("started"), but this attribute can be used to disable initial startup ("stopped") or start the service in a paused state ("paused"). The timeout used when taking messages from the service queue.
Child Elements
Name
Cardinality
Description
description
0..1
This can hold any kind of documentation related to the service. It is intended to be "human readable" only and is not used by the system.
inbound
0..1
The elements within 'inbound' describe how a service receives messages.
Document generated by Confluence on Mar 11, 2009 14:57
Page 279
abstract-component
0..1
The service component that is invoked when incoming messages are received. If this element is not present, the service simply bridges the inbound and outbound using a pass-through component. A placeholder for a component element. A component is invoked when inbound messages are received by the service.
outbound
0..1
The elements within 'outbound' describe how a service sends or dispatches messages.
async-reply
0..1
The elements within 'async-reply' describe how asynchronous replies are handled.
abstract-exception-strategy
0..1
A placeholder for an exception strategy element. Exception strategies define how Mule should react to errors.
abstract-service-threadingprofile
0..1
A placeholder for the service threading profile element. Threading profiles define how thread pools are used by a service.
abstract-queue-profile
0..1
A placeholder for a queue profile, which controls how messages are queued.
<custom-service ...> A user-implemented service (typically used only in testing).
Attributes
Name name
initialState
Type
Required name
no
started / stopped / paused
no
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description The name used to identify this service.
started
The initial state of the service. Usually a service is started automatically ("started"), but this attribute can be used to disable initial startup ("stopped") or start the service
Page 280
in a paused state ("paused"). class
class name
no
The class to use for the service.
Child Elements
Name
Cardinality
Description
description
0..1
This can hold any kind of documentation related to the service. It is intended to be "human readable" only and is not used by the system.
inbound
0..1
The elements within 'inbound' describe how a service receives messages.
abstract-component
0..1
The service component that is invoked when incoming messages are received. If this element is not present, the service simply bridges the inbound and outbound using a pass-through component. A placeholder for a component element. A component is invoked when inbound messages are received by the service.
outbound
0..1
The elements within 'outbound' describe how a service sends or dispatches messages.
async-reply
0..1
The elements within 'async-reply' describe how asynchronous replies are handled.
abstract-exception-strategy
0..1
A placeholder for an exception strategy element. Exception strategies define how Mule should react to errors.
<description ...> Holds any kind of documentation that accompanies this configuration file. It is intended to be "human readable" only and is not used by the system.
Document generated by Confluence on Mar 11, 2009 14:57
Page 281
Attributes Child Elements
Name
Type
Required
Name
Cardinality
Description
Default
Description
<description ...> This can hold any kind of documentation related to the service. It is intended to be "human readable" only and is not used by the system.
Attributes Child Elements
Name
Type
Required
Name
Cardinality
Description
Default
Description
The elements within 'inbound' describe how a service receives messages.
Attributes
Name
Type
matchAll
Required boolean
no
Default true
Description If true, the input message will be passed to all inbound routers. Otherwise, only the first matching router is used.
Child Elements
Name
Cardinality
Description
abstract-inbound-endpoint
0..*
A placeholder for inbound endpoint elements. Inbound endpoints receive messages from the underlying transport. The message payload is then delivered to the component for processing.
abstract-inbound-router
0..*
A placeholder for inbound router elements, which control how incoming messages are handled.
Document generated by Confluence on Mar 11, 2009 14:57
Page 282
abstract-catch-all-strategy
0..1
A placeholder for catch-all strategy elements.
The elements within 'outbound' describe how a service sends or dispatches messages.
Attributes
Name
Type
matchAll
Required boolean
no
Default false
Description If true, the output message will be sent to all routers. Otherwise, only the first matching router is used.
Child Elements
Name
Cardinality
Description
abstract-outbound-router
1..*
A placeholder for outbound router elements, which control how outgoing messages are delivered to the outbound endpoints.
abstract-catch-all-strategy
0..1
A placeholder for catch-all strategy elements.
The elements within 'async-reply' describe how asynchronous replies are handled.
Attributes
Name
Type
Required
Default
Description
timeout
integer
no
The timeout (ms) to wait for a reply.
failOnTimeout
boolean
no
If the router times out before all expected events have been received, specifies whether an exception should be thrown (true) or the current events should be returned for processing (false).
Document generated by Confluence on Mar 11, 2009 14:57
Page 283
The default is false.
Child Elements
Name
Cardinality
Description
abstract-inbound-endpoint
1..*
A placeholder for inbound endpoint elements. Inbound endpoints receive messages from the underlying transport. The message payload is then delivered to the component for processing.
abstract-async-reply-router
0..1
A placeholder for an async reply router element. Asynchronous replies are handled via this router.
Specifies the properties of an internal Mule queue. Internal queues are used to queue messages for each component managed by Mule.
Attributes
Name
Type
Required
maxOutstandingMessages integer
no
persistent
no
boolean
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description Defines the maximum number of messages that can be queued.
false
Whether Mule messages are persisted to a store. Primarily, this is used for persisting queued messages to disk so that the internal state of the server is mirrored on disk in case the server fails and needs to be restarted. Default is false.
Page 284
Child Elements
Name
Cardinality
Description
Exception Strategy See Exception Strategy Configuration Reference.
Catch All Strategy See Catch All Strategy Configuration Reference.
Component See Component Configuration Reference.
Document generated by Confluence on Mar 11, 2009 14:57
Page 285
Transactions Configuration Reference This page last changed on Feb 20, 2009 by jackie.wheeler.
Transactions Configuration Reference This page provides reference information on the elements you configure for transactions. For more information on transactions, see Transaction Management.
Abstract Transaction A placeholder for transaction elements. Transactions allow a series of operations to be grouped together.
Attributes of
Name
Type
Required
action
NONE/ no ALWAYS_BEGIN/ BEGIN_OR_JOIN/ ALWAYS_JOIN/ JOIN_IF_POSSIBLE
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description The type of action the transaction should take, one of the following: NONE - Never participate in a transaction. ALWAYS_BEGIN - Always start a new transaction when receiving a message. An exception will be thrown if a transaction already exists. BEGIN_OR_JOIN - If a transaction is already in progress when a message is received, join the transaction if possible. Otherwise, start a new transaction. ALWAYS_JOIN Always expects a transaction to be in progress when a message is received. If there is no transaction, an exception is thrown. JOIN_IF_POSSIBLE - Join the current transaction if one is available. Otherwise, no transaction is created.
Page 286
timeout
integer
no
Timeout for the transaction (ms).
Custom Transaction A user-defined or otherwise unsupported third-party transactions.
Attributes of <custom-transaction...>
Name
Type
Required
action
NONE/ no ALWAYS_BEGIN/ BEGIN_OR_JOIN/ ALWAYS_JOIN/ JOIN_IF_POSSIBLE
The type of action the transaction should take, one of the following: NONE - Never participate in a transaction. ALWAYS_BEGIN - Always start a new transaction when receiving a message. An exception will be thrown if a transaction already exists. BEGIN_OR_JOIN - If a transaction is already in progress when a message is received, join the transaction if possible. Otherwise, start a new transaction. ALWAYS_JOIN Always expects a transaction to be in progress when a message is received. If there is no transaction, an exception is thrown. JOIN_IF_POSSIBLE - Join the current transaction if one is available. Otherwise, no transaction is created.
timeout
integer
no
Timeout for the transaction (ms).
factory-class
class name
no
A class that implements the TransactionFactory
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 287
interface that will be instantiated and used to generate a transaction. This attribute and the 'factoryref' attribute are mutually exclusive; one of the two is required. factory-ref
name (no spaces)
no
A bean that implements the TransactionFactory interface that will be used to generate a transaction. This attribute and the 'factoryclass' attribute are mutually exclusive; one of the two is required.
Xa Transaction An XA transaction.
Websphere Transaction Manager The WebSphere transaction manager.
Attributes of <websphere-transaction-manager...>
Name
Type
Required
Default
Description
name
name (no spaces)
no
transactionManager An optional name for the transaction manager. The default value is "transactionManager".
Jboss Transaction Manager The JBoss transaction manager.
Attributes of <jboss-transaction-manager...>
Name
Type
Required
Default
name
name (no spaces)
no
transactionManager An optional name for the transaction manager. The
Document generated by Confluence on Mar 11, 2009 14:57
Description
Page 288
default value is "transactionManager".
Weblogic Transaction Manager The WebLogic transaction manager.
Child Elements of <weblogic-transaction-manager...>
Name
Cardinality
Description
environment
0..1
The JNDI environment.
Jrun Transaction Manager The JRun transaction manager.
Attributes of <jrun-transaction-manager...>
Name
Type
Required
Default
Description
name
name (no spaces)
no
transactionManager An optional name for the transaction manager. The default value is "transactionManager".
Resin Transaction Manager The Resin transaction manager.
Attributes of
Name
Type
Required
Default
Description
name
name (no spaces)
no
transactionManager An optional name for the transaction manager. The default value is "transactionManager".
Jndi Transaction Manager Retrieves a named transaction manager factory from JNDI.
Attributes of <jndi-transaction-manager...>
Name
Type
Required
jndiName
string
no
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description The name of the manager
Page 289
factory to retrieve (such as java:/ TransactionManager).
Custom Transaction Manager A user-implemented transaction manager.
Attributes of <custom-transaction-manager...>
Name
Type
Required
class
class name
no
Default
Description The class to instantiate to create a transaction manager.
Child Elements of <custom-transaction-manager...>
Name
Cardinality
Description
environment
0..1
The JNDI environment.
spring:property
0..*
Document generated by Confluence on Mar 11, 2009 14:57
Page 290
Configuring a Mule Instance This page last changed on Feb 24, 2009 by jackie.wheeler.
Configuring a Mule Instance A Mule configuration file can become an elaborate tree of elements, however, the basic things to configure at the top level are: • Connectors - Non-default configuration of any transports used • Endpoints - Global definition of endpoints is encouraged to clearly describe where your integration channels are • Transformers - Transformers may be defined globally and later referenced from your services • Filters - Filters may be defined globally and later referenced from your services • Models - One or more models that logically group together your services • Services - One or more services that wrap your components and configure routers, endpoints, transformers, and filters specifically for that service
Following is an example of a simple Mule configuration file:
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:vm="http://www.mulesource.org/schema/mule/vm/2.2" xsi:schemaLocation=" http://www.mulesource.org/schema/mule/core/2.2 http://www.mulesource.org/schema/mule/core/2.2/ mule.xsd http://www.mulesource.org/schema/mule/vm/2.2 http://www.mulesource.org/schema/mule/vm/2.2/ mule-vm.xsd"> <custom-transformer name="ThisToThat" class="com.acme.transformer.ThisToThat"/> <model name="main"> <service name="myBasicService">
Document generated by Confluence on Mar 11, 2009 14:57
Page 291
Advanced Configuration Other, more advanced things you may configure at this level: Agents - Agents are typically used for cross-cutting concerns such as logging or management Notifications - Be notified upon certain lifecycle events Security Manager - Authenticates requests based on one or more security providers Transaction Management - Mule transactions are configured on inbound endpoints, where an endpoint can be configured to start a new transaction or join an existing one. • Global Configuration Options - Miscellaneous global settings • Global Properties - Placeholder values • • • •
Document generated by Confluence on Mar 11, 2009 14:57
Page 292
Configuring Endpoints This page last changed on Feb 26, 2009 by jackie.wheeler.
Configuring Endpoints [ Basic Configuration ] [ Endpoint Usage ] [ Global Endpoints ] Endpoints are used to connect services. An endpoint is a specific channel on which a service can send messages and from which another service can receive messages. For example, a purchasing component may receive an order request over HTTP. Once the order has been processed by the component, a JMS message may be sent over a topic to notify an auditing system, and a response can be sent back over HTTP. This page describes how to configure an endpoint. For details on the various attributes and elements you can configure on an endpoint, see Endpoint Configuration Reference.
Basic Configuration In its most basic form, an endpoint consists of a transport and a transport-specific channel/destination/ resource used to identify the channel and location where two services can exchange information. For example:
<jetty:inbound-endpoint address="http://localhost:60211/mycomponent1" synchronous="true" />
Traditionally, endpoints in Mule have been specified as a URI such as the examples above. This form is still supported, and indeed may prove to be more practical depending on your application. However, as of Mule 2.0, the recommended way to specify endpoints is via transport-specific namespaces, as shown in the following examples.
<ssl:endpoint name="clientEndpoint" host="localhost" port="60198" synchronous="true"/> <jetty:endpoint name="serverEndpoint" host="localhost" port="60203" path="services/Foo" synchronous="false" /> <jms:inbound-endpoint queue="test.queue"/>
Properties Properties on endpoints can be used to customize behavior. Any properties set on the endpoint can be used to overload default properties on the associated transport's connector. For example, an SMTP outbound endpoint might set the fromAddress property to workflow1 to override a default connector value of sysadmin. Any standard properties for an endpoint will be available as attributes in the XML schema if transport-specific endpoints are used. It is also possible to specify a non-standard property. For example:
Document generated by Confluence on Mar 11, 2009 14:57
Page 293
<property key="actionOnTimeout" value="self-destruct"/> <property key="precision" value="2.5"/>
Connector In many cases, the connector associated with an endpoint can simply be assumed based on the transport and created implicitly. However, if more than one connector of the same transport exists, or if nondefault settings are used for the connector, you must refer to the connector from the endpoint using the connector-ref attribute.
Filter An endpoint can contain a filter to selectively ignore certain messages. The filter can be transport-specific such as a JMS selector or file filter or can be a general-purpose filter such as JXPath. Filtering is not supported by all transports, and setting a filter on an endpoint using some transports will result in an UnsupportedOperationException. For more information, see Using Filters.
<jms:endpoint queue="in.queue"> <jms:selector expression="JMSPriority > 5"/> <message-property-filter pattern="foo=bar"/>
Transaction A transaction can begin or commit when an event is received or sent via an endpoint. The endpoint must be synchronous, and transaction support depends largely on the particular transport being used. For more information see Transaction Management.
<jms:inbound-endpoint queue="in"> <jms:transaction action="BEGIN_OR_JOIN"/>
Endpoint Usage Endpoints can be used in the following places: • • • • •
Inbound Routers Outbound Routers Services Catch-all Strategies Exception Strategies
Document generated by Confluence on Mar 11, 2009 14:57
Page 294
Inbound Routers See Using Message Routers.
<service name="Receiver"> <wire-tap-router>
Outbound Routers See Using Message Routers.
<service name="MessageChunker"> <jms:inbound-endpoint queue="big.messages"/> <message-chunking-router messageSize="10"> <jms:outbound-endpoint queue="small.chunks"/> <service name="LenderGatewayService">
Services As a shortcut, endpoints can be configured directly on the service without a router in some cases.
<service name="Echo"> <stdio:inbound-endpoint system="IN"/> <echo-component/> <stdio:outbound-endpoint system="OUT"/>
Document generated by Confluence on Mar 11, 2009 14:57
Page 295
Catch-all Strategies A single "catch-all" endpoint can be configured for certain types of routers. See Using Message Routers.
<service name="dataService"> <payload-type-filter expectedType="java.lang.String"/> <jms:outbound-endpoint queue="error.queue"/> ...cut...
Exception Strategies A single error endpoint can be configured on an exception strategy. See Error Handling.
<service name="dataService"> ...cut... ...cut... <default-service-exception-strategy> <jms:outbound-endpoint queue="error.queue"/>
Global Endpoints Global endpoints, while not required, are a recommended best practice for having a nicely organized configuration file. A global endpoint can be thought of as a template for shared endpoint configuration. Global endpoints can be used as they are defined globally, or they can be extended by adding more configuration attributes or elements. To reference a global endpoint, use the usual and elements, and specify the global endpoint name using the ref attribute.
...cut... <model> <service name="Priority1"> ...cut...
Document generated by Confluence on Mar 11, 2009 14:57
Page 296
<service name="Priority2"> ...cut...
In the above example, the "fileReader" endpoint is used as a template for the inbound endpoints. The properties reverseOrder and comparator only need to be declared once, and the property path changes for each inbound endpoint.
Document generated by Confluence on Mar 11, 2009 14:57
Page 297
Mule Endpoint URIs This page last changed on Oct 09, 2008 by jackie.wheeler.
Mule Endpoint URIs Although URI-based endpoints are still supported in Mule 2.0, transport-specific endpoints are generally recommended instead. Mule Endpoint URIs are any valid URI and describe how to connect to the underlying transport. Most connectors in Mule can be created from an endpoint URI except where not enough connection information can be expressed clearly in a URI, such as JMS connection properties. Endpoint URIs are set on Mule Endpoints, which manage other connection instance information such as filters and transactions. Mule Endpoint URIs usually appear in one of the following forms, although other provider implementations can introduce their own schemes. scheme://host[:port]//[address][?params] The scheme must always be set. The host and port are set for endpoints that use unwrapped socket based communications such as the TCP, UDP, HTTP, or multicast. udp://localhost:65432
scheme://[username][:password]@host[:port][?params] The user name and password are used to log in to the remote server specified by the host and port parameters. The POP3 and SMTP connectors use this format or URI. pop3://ross:[email protected] smtp://ross:[email protected]
scheme://address[?params] Here we only define a protocol and an address. This tells Mule to get a connector that handles the specified scheme, or create one if needed, and to create a new endpoint using the specified address. vm://my.queue
URI Parameters There are two types of parameters you can set on the URI: 1. Known Mule parameters that control the way the endpoint is configured, such as transformers for the endpoint. 2. Properties to be set on the connector or to be associated with the transport. This allows you to set properties on a connector used by this endpoint. Additionally, all properties will be associated with the transport, so you can mix connector and transport properties. For more information, see Configuring Endpoints.
Known Parameters
Property
Description
connector
The name of an existing connector to use for this endpoint URI
Document generated by Confluence on Mar 11, 2009 14:57
Page 298
transformers
Defines a comma-separated list of transformers to configure on the endpoint
address
Explicitly sets the endpoint address to the specified value and ignores all other info in the URI.
For example: file:///C:/temp?transformers=FileToString,XmlToDom jms://jmsEndpoint/topic:my.topic?connector=WMQConnector
Other Parameters Any other parameters set on the URI will be set on the connector if a connector is created and also set on the endpoint itself as properties.
Endpoint Encoding When using XML configuration, certain character entities defined in the W3C SGML specification need to be escaped to their SGML code. The most relevant are listed here. Don't forget to remove the space before the ';'. For characters such as > < " % #, the notation will be resolved and cause the constructor for the URI to throw an exception. To use one of these characters, you can specify %HEXNUMBER
Text code
Numerical code
What it looks like
Description, extras
%22
#34
"
quotation mark = APL quote, U+0022 ISONEW
& ;
#38
&
ampersand, U+0026 ISOnum
%3C
#60
<
less-than sign, U+003C ISOnum
%3E
#62
>
greater-than sign, U +003E ISOnum
%25
#37
%
percentage sign, U +0023 ISOnum
%23
#35
#
hash sign, U+0025 ISOnum
Additionally, for connectors such as Axis, FTP, and the Email connectors, if your login credentials include @, you must escape it using %40. For example, instead of these URIs: axis:http://wsuser@username:password@localhost/services/services/Version?method=getVersion ftp://username:password@ftpserver smtp://'[email protected]':'123456'@mailserver?address=QA
You must use these: axis:http://wsuser%40username:password%40localhost/services/services/Version?method=getVersion ftp://username:password%40ftpserver smtp://'sender%40mydomain.com':'123456'%40mailserver?address=QA
Document generated by Confluence on Mar 11, 2009 14:57
Page 299
Using Filters This page last changed on Dec 15, 2008 by jackie.wheeler.
Using Filters [ Standard Filters ] [ Transport and Module Filters ] [ Creating Custom Filters ] Filters specify conditions that must be met for a message to be routed to a service. There are several standard filters that come with Mule that you can use, or you can create your own filters. You can create a global filter and then reference it from your services. Global filters require the "name" attribute, whereas filters configured on endpoints or routers do not.
<payload-type-filter name="payloadFilter" expectedType="java.lang.String"> <model> <service> <echo-component/> <service>
For reference to the configuration of each filter, see Filters Configuration Reference.
Standard Filters Mule includes the following standard filters that you can apply to your routers: • Payload Type Filter • Expression Filter ° Using JXPath Expressions • ° Using OGNL Expressions • RegEx Filter • Wildcard Filter • Exception Type Filter • Message Property Filter • Logic Filters ° And Filter • ° Or Filter ° Not Filter
Payload Type Filter Checks the class type of the payload object inside a message.
<payload-type-filter expectedType="java.lang.String">
Document generated by Confluence on Mar 11, 2009 14:57
Page 300
Expression Filter Evaluates a range of expressions. Use the evaluator attribute to specify the expression evaluator to use, one of the following: header, payload-type, exception-type, wildcard, regex, ognl, xpath, jxpath, bean, groovy, or custom. Use the expression attribute to set the actual expression. If the expression type is xpath, bean, or ognl, the expression should be a boolean. If the expression type is custom, set the customEvaluator attribute to the name of the custom evaluator, which must be registered with the ExpressionEvaluatorManager (see Creating Custom Filters). For more information on using expression evaluators, see Using Expression Evaluators. Optionally, set the nullReturnsTrue attribute to true if you want to return true whenever the expression is null. Using JXPath Expressions JXPath is an XPath interpreter that can apply XPath expressions to XML DOM objects or any other object graph. For more information about JXPath, see the JXpath user guide, JXPath tutorial, or XPath tutorial.
<expression-filter evaluator="jxpath" expression="(msg/header/resultcode)='success'">
You can also use the JXPath filter from the XML Module, which supports some additional properties.
Using OGNL Expressions OGNL is a simple yet very powerful expression language for plain Java objects. Similar to JXPath, it works on object graphs, and thus the corresponding filter enables simple and efficient content routing for payloads. For example:
<expression-filter evaluator="ognl" expression="[MULE:0].equals(42)"/>
or more simply:
This filter would block any messages whose payloads are not arrays or lists and do not contain the value 42 as the first element.
RegEx Filter Applies a regular expression pattern to the message payload. The filter applies toString() to the payload, so you might also want to apply a PayloadTypeFilter to the message using an AndFilter to make sure the payload is a String.
Wildcard Filter Applies a wildcard pattern to the message payload. The filter applies toString() to the payload, so you might also want to apply a PayloadTypeFilter to the message using an AndFilter to make sure the payload is a String.
Document generated by Confluence on Mar 11, 2009 14:57
Page 301
For the string "the quick brown fox jumped over the lazy dog", the following patterns would match: • *x jumped over the lazy dog • the quick* • *fox*
<wildcard-filter pattern="the quick brown *"/>
Exception Type Filter A filter that matches an exception type.
<exception-type-filter expectedType="java.lang.RuntimeException"/>
Message Property Filter This filter allows you add logic to your routers based on the value of one or more properties of a message. This filter can be very powerful because the message properties are exposed, allowing you to reference any transport-specific or user-defined property. For example, you can match one or more HTTP headers for an HTTP event, match properties in JMS and email messages, and more. By default, the comparison is case sensitive. You can set the caseSensitive attribute to override this behavior.
<message-property-filter pattern="Content-Type=text/xml" caseSensitive="false"/>
The expression is always a key value pair. If you want to use more complex expressions, you can use the logic filters. The following example shows two filters :
<message-property-filter pattern="JMSCorrelationID=1234567890"/> <message-property-filter pattern="JMSReplyTo=null"/>
Logic Filters There are three logic filters that can be used with other filters: And, Or, and Not. Logic filters can be nested so that more complex logic can be expressed.
And Filter An And filter combines two filters and only accepts the message if it matches the criteria of both filters.
<payload-type-filter expectedType="java.lang.String"/>
Document generated by Confluence on Mar 11, 2009 14:57
Page 302
Or Filter The Or filter considers two filters and accepts the message if it matches the criteria of either one of the filters.
<payload-type-filter expectedType="java.lang.String"/> <payload-type-filter expectedType="java.lang.StringBuffer"/>
Not Filter A Not filter accepts the message if it does not match the criteria in the filter.
<not-filter> <payload-type-filter expectedType="java.lang.String"/>
Transport and Module Filters Several Mule transports and modules provide their own filters. For example, the XML Module includes a filter to determine if a message is XML. For more information, see Available Transports and Using Mule Modules. Also, there are filters on MuleForge that have been contributed by the community.
Creating Custom Filters The standard filters handle most filtering requirements, but you can also create your own filter. To create a filter, implement the Filter interface , which has a single method:
public boolean accept(MuleMessage message);
This method returns true if the message matches the criteria that the filter imposes. Otherwise, it returns false. You can then use this filter with the <custom-filter...> element, using the class attribute to specify the custom filter class you created and specifying any necessary properties using the <spring:property> child element. For example:
<custom-filter class="org.mule.transport.http.filters.HttpRequestWildcardFilter"> <spring:property name="pattern" value="/services/EnterOrder?wsdl"/>
Document generated by Confluence on Mar 11, 2009 14:57
Page 303
Document generated by Confluence on Mar 11, 2009 14:57
Page 304
Configuring a Transport This page last changed on Nov 19, 2008 by jackie.wheeler.
Configuring a Transport You can configure a transport in the following ways: • Define a connector configuration using the element in the Mule XML configuration file. • Set transport properties on endpoints to customize the transport behavior for a single endpoint instance. • Use an endpoint URI that defines the scheme and connection information for the transport, such as tcp://localhost:12345. See Mule Endpoint URIs for more information. The URI consists of the protocol followed by transport-specific information, and then zero or more parameters to set as properties on the connector. This page describes the common properties for all transports. The actual configuration parameters for each transport type are described separately for each transport. To see the details of a specific transport, see Available Transports.
Common Connector Attributes and Properties Attribute
Description
Required
name
The identifying name of the connector
Yes
createMultipleTransactedReceivers Whether to create multiple No concurrent receivers for this connector. This property is used by transports that support transactions, specifically receivers that extend the TransactedPollingMessageReceiver, and provides better throughput. numberOfConcurrentTransactedReceivers If No createMultipleTransactedReceivers is set to true, the number of concurrent receivers that will be launched. dynamicNotification
Whether to enable dynamic notification.
No
Property
Description
Default
Required
abstract-exceptionstrategy
The exception strategy to use when errors occur in the connector.
The default exception strategy set on the Mule Configuration.
No
receiver-threadingprofile
The threading properties and WorkManager to use when receiving events from the connector.
The default receiver threading profile set on the Mule Configuration
Yes
Document generated by Confluence on Mar 11, 2009 14:57
Page 305
dispatcher-threadingprofile
The threading properties and WorkManager to use when dispatching events from the connector.
The default dispatcher threading profile set on the Mule Configuration.
Yes
connection-strategy
The object responsible for controlling how connection failures and retries are handled. The connection strategy can attempt to make a connection based on frequency, retry attempts, Jmx, or some other trigger. NOTE: this feature is not yet available for 2.0.
org.mule.transport. Yes SingleAttemptConnectionStrategy
service-overrides
A map of service configuration values that can be used to override the default configuration for this transport.
No
Retry Policies Retry policies are used to configure how a connector behaves when its connection fails. For complete information, see Configuring Retry Policies.
Creating Your Own Transport For information on creating a custom transport for Mule, see Creating Transports.
Detailed Configuration Information • Threading profiles ° Receiver threading profile ° Dispatcher threading profile • Service overrides
Receiver Threading Profile The threading profile to use when a connector receives messages.
Attributes of
Name
Type
Required
maxThreadsActive
integer
no
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description The maximum number of threads that will be used.
Page 306
maxThreadsIdle
integer
no
The maximum number of idle or inactive threads that can be in the pool before they are destroyed.
threadTTL
integer
no
Determines how long an inactive thread is kept in the pool before being discarded.
poolExhaustedAction WAIT/DISCARD/ no DISCARD_OLDEST/ ABORT/RUN
When the maximum pool size or queue size is bounded, this value determines how to handle incoming tasks. Possible values are: WAIT (wait until a thread becomes available; don't use this value if the minimum number of threads is zero, in which case a thread may never become available), DISCARD (throw away the current request and return), DISCARD_OLDEST (throw away the oldest request and return), ABORT (throw a RuntimeException), and RUN (the default; the thread making the execute request runs the task itself, which helps guard against lockup).
threadWaitTimeout
integer
no
How long to wait in milliseconds when the pool exhausted action is WAIT. If the value is negative, it will wait indefinitely.
doThreading
boolean
no
Document generated by Confluence on Mar 11, 2009 14:57
true
Whether threading should be used (default is true).
Page 307
maxBufferSize
integer
no
Determines how many requests are queued when the pool is at maximum usage capacity and the pool exhausted action is WAIT. The buffer is used as an overflow.
Dispatcher Threading Profile The threading profile to use when a connector dispatches messages.
Attributes of
Name
Type
Required
maxThreadsActive
integer
no
The maximum number of threads that will be used.
maxThreadsIdle
integer
no
The maximum number of idle or inactive threads that can be in the pool before they are destroyed.
threadTTL
integer
no
Determines how long an inactive thread is kept in the pool before being discarded.
poolExhaustedAction WAIT/DISCARD/ no DISCARD_OLDEST/ ABORT/RUN
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
When the maximum pool size or queue size is bounded, this value determines how to handle incoming tasks. Possible values are: WAIT (wait until a thread becomes available; don't use this value if the minimum number of threads is zero, in which case a thread may never become available), DISCARD (throw away the current request and return), DISCARD_OLDEST
Page 308
(throw away the oldest request and return), ABORT (throw a RuntimeException), and RUN (the default; the thread making the execute request runs the task itself, which helps guard against lockup). threadWaitTimeout
integer
no
doThreading
boolean
no
maxBufferSize
integer
no
How long to wait in milliseconds when the pool exhausted action is WAIT. If the value is negative, it will wait indefinitely. true
Whether threading should be used (default is true). Determines how many requests are queued when the pool is at maximum usage capacity and the pool exhausted action is WAIT. The buffer is used as an overflow.
Service Overrides Service overrides allow the connector to be further configured/customized by allowing parts of the transport implementation to be overridden, for example, the message receiver or dispatcher implementation, or the message adaptor that is used.
Attributes of <service-overrides...>
Name
Type
Required
messageReceiver
name (no spaces)
no
transactedMessageReceiver name (no spaces)
no
xaTransactedMessageReceiver name (no spaces)
no
dispatcherFactory
name (no spaces)
no
inboundTransformer name (no spaces)
no
outboundTransformername (no spaces)
no
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 309
responseTransformer name (no spaces)
no
endpointBuilder
name (no spaces)
no
messageAdapter
name (no spaces)
no
streamMessageAdapter name (no spaces)
no
serviceFinder
name (no spaces)
no
sessionHandler
name (no spaces)
no
Document generated by Confluence on Mar 11, 2009 14:57
Page 310
Configuring Retry Policies This page last changed on Feb 19, 2009 by jackie.wheeler.
Configuring Retry Policies [ Configuring Retry Policies with the Retry Schema ] [ Simple Policy ] [ Forever Policy ] [ Custom Policy ] [ Connect Notifier ] [ Custom Notifier ] [ Creating a Custom Retry Policy ] [ Configuring Retry Policies with the Spring Schema ] Retry policies configure how a connector behaves when its connection fails. Different policies can be used to control how a reconnection is made based on type of exception, number and/or frequency of retry attempts, notifications, and more. Retry policies are available for JMS connectors as of Mule 2.1. As of Mule 2.1.2, it has been officially tested with Active MQ only. For Mule Enterprise 2.2, we are adding support for the Mule WMQ Transport. If you are using the Enterprise Edition of Mule, there are several standard retry policies available that you can configure using the Retry schema. If you are using the Community Edition of Mule, you must create your own policies and configure them using standard Spring syntax rather than the Retry schema.
Configuring Retry Policies with the Retry Schema This section describes the retry policies you can configure directly in your XML by including the muleretry-ee.xsd schema. You import the schema as follows:
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:retry="http://www.mulesource.com/schema/mule/retry/2.2" xsi:schemaLocation=" http://www.mulesource.org/schema/mule/core/2.2 http://www.mulesource.org/schema/mule/core/2.2/ mule.xsd http://www.mulesource.com/schema/mule/retry/2.2 http://www.mulesource.com/schema/mule/retry/2.2/ mule-retry-ee.xsd">
Simple Policy This policy allows the user to configure how many times a retry should be attempted and how long to wait between retries.
Attributes of <simple-policy...>
Name
Type
Required
Default
Description
frequency
long
no
2000
How often (in ms) to retry
count
integer
no
2
How many retry attempts to make
For example:
<jms:activemq-connector name="AMQConnector" brokerURL="tcp://localhost:61616" specification="1.1" durable="true" clientId="C1"
Document generated by Confluence on Mar 11, 2009 14:57
Page 311
numberOfConcurrentTransactedReceivers="1" maxRedelivery="-1" persistentDelivery="true">
Forever Policy Retry an infinite amount of times at the specified frequency.
Attributes of
Name
Type
Required
Default
Description
frequency
long
no
2000
How often (in ms) to retry
For example (most of the connector information is truncated as ...):
<jms:activemq-connector name="AMQConnector" ...>
Custom Policy A user-defined retry policy.
Attributes of <custom-policy...>
Name
Type
Required
class
class name
no
Default
Description A class that implements the RetryPolicyTemplate interface.
Child Elements of <custom-policy...>
Name
Cardinality
spring:property
0..*
Description
For example:
<jms:activemq-connector name="AMQConnector" ...> <spring:property name="fooBar" value="true"/> <spring:property name="revolutions" value="500"/>
Document generated by Confluence on Mar 11, 2009 14:57
Page 312
Asynchronous Retry (As of Mule 2.2) By default, a retry policy will block until it is able to connect/reconnect. Enabling asynchronous retry means the application does not need to wait for all endpoints to connect before it can start up, and if a connection is lost, the reconnection will happen in a separate thread from the application thread. Note that such behavior may or may not be desirable depending on your application. Any retry policy can be made asynchronous by simply setting the attribute asynchronous="true". For example:
<jms:activemq-connector name="AMQConnector" ...>
Transactions If transactions are properly configured, any messages being routed by Mule at the time a retry policy goes into effect will not be dropped. Instead, the transaction will roll back and only commit once the transport finally reconnects successfully via the retry policy.
Retry Notifiers A retry notifier is called upon each retry attempt and is also configurable.
Connect Notifier Fires a ConnectionNotification upon each retry attempt. For example:
<jms:activemq-connector name="AMQConnector" ...>
Custom Notifier A user-defined retry notifier.
Attributes of <custom-notifier...>
Name
Type
Required
class
class name
no
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description A class that implements the RetryNotifier interface.
Page 313
Child Elements of <custom-notifier...>
Name
Cardinality
spring:property
0..*
Description
For example:
<jms:activemq-connector name="AMQConnector" ...> <spring:property name="color" value="red"/>
Configuring Separate Connectors for Inbound and Outbound The retry policy for a connector is used for both inbound and outbound connections. If you require a different behavior for inbound and outbound connections, you can achieve this by configuring two connectors with the different policies and reference them from the inbound and outbound endpoints, respectively.
Default Retry Policy The default retry policy is used for any connector that does not have retry explicitly configured. You can set the default policy using the element:
Creating a Custom Retry Policy To create a custom retry policy, you implement the interface RetryPolicy , where the method PolicyStatus applyPolicy(Throwable cause) takes some action based on the type of exception and returns PolicyStatus to indicate whether the policy has been exhausted or should continue to retry. You also create a RetryPolicyTemplate , which is what you actually configure on the connector. The template should generally inherit from AbstractPolicyTemplate and have the method RetryPolicy createRetryInstance() return an instance of your custom RetryPolicy. At runtime, a new instance of the RetryPolicy will be created each time the policy goes into effect, thereby resetting any state information it may contain, such as counters. For example:
package com.acme.retry; public class AstronomicalRetryPolicyTemplate extends AbstractPolicyTemplate { int totalPlanets; public RetryPolicy createRetryInstance()
Document generated by Confluence on Mar 11, 2009 14:57
Page 314
{ return new AstronomicalRetryPolicy(totalPlanets); } protected static class AstronomicalRetryPolicy implements RetryPolicy { int totalPlanets; public AstronomicalRetryPolicy(int totalPlanets) { this.totalPlanets = totalPlanets; } public PolicyStatus applyPolicy(Throwable cause) { if (AstronomyUtils.getPlanetsAligned() == totalPlanets) { return PolicyStatus.policyExhausted(cause); } else { Thread.sleep(5000); return PolicyStatus.policyOk(); } } } public int getTotalPlanets() { return totalPlanets; } public void setTotalPlanets(int totalPlanets) { this.totalPlanets = totalPlanets; } }
Configuring Retry Policies with the Spring Schema Because the retry schema is available in Mule Enterprise Edition only, Mule Community users must use standard Spring syntax for configuring a custom retry policy. For example:
<jms:activemq-connector name="AMQConnector" ...> <spring:property name="retryPolicyTemplate"> <spring:bean class="com.acme.retry.AstronomicalRetryPolicyTemplate"> <spring:property name="totalPlanets" value="8"/>
Document generated by Confluence on Mar 11, 2009 14:57
Page 315
Configuring Logging This page last changed on Nov 11, 2008 by jackie.wheeler.
Configuring Logging [ Troubleshooting Logging ] [ Controlling Logging from JMX ] For logging, Mule uses slf4j, which is a logging facade that discovers and uses a logging strategy from the classpath, such as Log4J or the JDK Logger. By default, Mule includes Log4J, which is configured with a file called log4j.properties. The Mule server has a log4j.properties in its conf directory, which you can customize when running the server in standalone mode. Additionally, all the examples included with Mule have log4j.properties files in their conf directories.
Troubleshooting Logging I don't see any logging output A log4j.properties file must be at the root of your classpath. If you don't have a log4j.properties file, you can get a simple one here. For more information about configuring Log4J, see their website.
I reconfigured Log4J, but nothing happened This happens because there is another log4j.properties file on your classpath that is getting picked up before your modified one. To find out which configuration file Log4J is using, you must add the following JVM parameter to the Mule startup script (or container startup script if you are embedding Mule): -Dlog4j.debug=true
This parameter will write the Log4J startup information, including the location of the configuration file being used, to stdout. You must remove that configuration file before your modified configuration will work.
I don't want to use Log4J You can remove Log4J by deleting log4j-xx.jar from your Mule classpath. You will then need to check that the logging system you are using is supported by slf4j and put the necessary JAR (unless using JDK1.4 Logger) and configuration files on the Mule classpath.
Controlling Logging from JMX You can expose a manager's logging configuration over JMX by configuring a Log4J Jmx agent in your Mule configuration file. See JMX Management for more information.
Document generated by Confluence on Mar 11, 2009 14:57
Page 316
Configuring Queues This page last changed on Nov 06, 2008 by jackie.wheeler.
Configuring Queues [ SEDA Service Queues ] [ Transport Queues ] [ Queue Configuration ] [ Queue Profile ] Mule uses queues to enable asynchronous message processing. This page describes the places where Mule uses queues and how to configure them. Note that you can use Mule HQ to monitor your queues and see historically how many messages they have contained. For more information, see Using Mule HQ.
SEDA Service Queues When requests come in to a SEDA service (the default model type), they are stored on a queue until threads from the component thread pool can pick them up and process them. The queue profile specifies how this queue behaves. Typically, you do not need to configure the queue profile for performance, as the endpoints or the component, and not the queue, are the usual bottleneck. However, you might want to specify the maximum queue size, or specify that you want to enable persistence on the queue (disabled by default) to store a copy of all messages processed by the component. When a SEDA service is stopped either by calling stop() on the service or by shutting down Mule, all messages still in the queue are processed before the service completes the stop phase if a nonpersistent queue is being used. If a persistent queue is being used, Mule will complete the processing of any messages that are currently being processed but will not take any new messages from the queue once the service has been requested to stop. Once the service or Mule is restarted, any messages in the persistent queue will be processed. Note: If a SEDA service is paused when stop() is called, and a non-persistent queue is being used, all messages pending processing in the queue will be lost. By using persistent SEDA queues and using transports that support persistence for any message channels that Mule uses internally, you can easily achieve graceful shutdown. Although message loss shouldn't occur if you design your system using these guidelines, if messages are absolutely critical, you should be using synchronous endpoints with transactions.
Transport Queues Transports may also uses queues internally to enable asynchronous message delivery. Often this is inherent in the transport implementation, such as with JMS, whereas the Mule VM Transport allows you to enable or disable queuing and to configure the queue.
Queue Configuration You configure the queue profile using the element on the model and/or services, where services inherit the queue configuration from the model but override it if a is configured explicitly on a service.
Queue Profile Specifies the properties of an internal Mule queue. Internal queues are used to queue messages for each component managed by Mule.
Attributes of
Name
Type
Required
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 317
maxOutstandingMessages integer
no
persistent
no
boolean
Defines the maximum number of messages that can be queued. false
Whether Mule messages are persisted to a store. Primarily, this is used for persisting queued messages to disk so that the internal state of the server is mirrored on disk in case the server fails and needs to be restarted. Default is false.
Persistence Strategies By default, Mule use two persistence strategies: • MemoryPersistenceStrategy : a volatile in-memory persistence strategy • FilePersistenceStrategy : uses a file store to persist messages to disk and maintains messages even if Mule is restarted. You specify the persistence strategy to use by setting the persistent attribute of the queue-profile. If set to true, the FilePersistenceStrategy is used, and if false, the MemoryPersistenceStrategy is used. Currently, you cannot configure alternative persistence strategies as part of the typed Mule XML configuration. However, if you need to change them, such as to persist to a database instead of disk, you can override the defaults in mule-default-config.xml by redefining the _muleQueueManager bean in your own configuration file. Custom persistence strategies must implement QueuePersistenceStrategy .
Document generated by Confluence on Mar 11, 2009 14:57
Page 318
Configuring Security This page last changed on Feb 20, 2009 by jackie.wheeler.
Configuring Security Mule allows you to authenticate requests via endpoints using transport-specific or generic authentication methods. It also allows you to control method-level authorization on your service components. The Security Manager is responsible for authenticating requests based on one or more security providers. All security is pluggable via the Mule security API , so you can easily plug in custom implementations.
Acegi Acegi provides a number of authentication and authorization providers such as JAAS, LDAP, CAS (Yale Central Authenication service), and DAO. The following topics will help you get started securing your services using Acegi: • Configuring the Acegi Security Manager • Component Authorization Using Acegi • Setting up LDAP Provider for Acegi
Spring Security 2.0 (Available as of Mule 2.2) Spring Security is the next version of Acegi and provides a number of authentication and authorization providers such as JAAS, LDAP, CAS (Yale Central Authenication service), and DAO. The following topics will help you get started securing your services using Acegi: • Configuring the Spring Security Manager • Component Authorization Using Spring Security • Setting up LDAP Provider for Spring Security
Other Security Integration Mule also supports the following security technologies: • • • •
Encryption Strategies - Secure your messages by encrypting them. PGP Security - Secure your messages by encrypting them with PGP. Enabling WS-Security - Secure your CXF SOAP endpoints with WS-Security. Jaas Security
Document generated by Confluence on Mar 11, 2009 14:57
Page 319
Component Authorization Using Acegi This page last changed on Dec 16, 2008 by jackie.wheeler.
Component Authorization Using Acegi [ Securing Services Components ] [ Setting Security Properties on the Security Provider ] This page describes how you can configure method-level authorization on your components so that users with different roles can only invoke certain service methods.
Securing Services Components To secure MethodInvocations, developers must add a properly configured MethodSecurityInterceptor into the application context. The beans requiring security are chained into the interceptor. This chaining is accomplished using Spring's ProxyFactoryBean or BeanNameAutoProxyCreator. Alternatively, Acegi security provides a MethodDefinitionSourceAdvisor, which you can use with Spring's DefaultAdvisorAutoProxyCreator to automatically chain the security interceptor in front of any beans defined against the MethodSecurityInterceptor. In addition to the daoAuthenticationProvider and inMemoryDaoImpl beans (see Configuring Security}, the following beans must be configured: • • • • •
MethodSecurityInterceptor AuthenticationManager AccessDecisionManager AutoProxyCreator RoleVoter
The MethodSecurityInterceptor The MethodSecurityInterceptor is configured with a reference to an: • AuthenticationManager • AccessDecisionManager Following is a security interceptor for intercepting calls made to the methods of a component that has an interface myComponentIfc, which defines two methods: delete and writeSomething. Roles are set on these methods as seen below in the property objectDefinitionSource.
<property name="authenticationManager" ref="authenticationManager"/> <property name="accessDecisionManager" ref="accessDecisionManager"/> <property name="objectDefinitionSource"> com.foo.myComponentIfc.delete=ROLE_ADMIN com.foo.myComponentIfc.writeSomething=ROLE_ANONYMOUS
Document generated by Confluence on Mar 11, 2009 14:57
Page 320
The AuthenticationManager An AuthenticationManager is responsible for passing requests through a chain of AuthenticationProvider objects.
<property name= "providers"> <list>
The AccessDecisionManager This bean specifies that a user can access the protected methods if they have any one of the roles specified in the objectDefinitionSource.
<property name="decisionVoters"> <list>
The AutoProxyCreator This bean defines a proxy for the protected bean. When an application asks Spring for a myComponent bean, it will get this proxy instead.
<property name="interceptorNames"> <list> myComponentSecurity <property name="beanNames"> <list> myComponent <property name='proxyTargetClass' value="true"/>
When using BeanNameAutoProxyCreator to create the required proxy for security, the configuration must contain the property proxyTargetClass set to true. Otherwise, the method passed to MethodSecurityInterceptor.invoke is the proxy's caller, not the proxy's target.
The RoleVoter The RoleVoter class will vote if any ConfigAttribute begins with ROLE_. The RoleVoter is case sensitive on comparisons as well as the ROLE_ prefix.
Document generated by Confluence on Mar 11, 2009 14:57
Page 321
• It will vote to grant access if there is a GrantedAuthority, which returns a String representation (via the getAuthority() method) exactly equal to one or more ConfigAttributes starting with ROLE. • If there is no exact match of any ConfigAttribute starting with ROLE_, the RoleVoter will vote to deny access. • If no ConfigAttribute begins with ROLE_, the voter will abstain.
Setting Security Properties on the Security Provider You can add any additional properties to the security provider in the securityProperties map. For example, this map can be used to change Acegi's default security strategy into one of the following: • MODE_THREADLOCAL, which allows the authentication to be set on the current thread (this is the default strategy used by Acegi) • MODE_INHERITABLETHREADLOCAL, which allows authentication to be inherited from the parent thread • MODE_GLOBAL, which allows the authentication to be set on all threads
Securing Components in Asynchronous Systems The use of Acegi's security strategies is particularly useful when using an asynchronous system, since we have to add a property on the security provider for the authentication to be set on more than one thread. In this case, we would use MODE_GLOBAL as seen in the example below.
Document generated by Confluence on Mar 11, 2009 14:57
Page 322
Component Authorization Using Spring Security This page last changed on Feb 20, 2009 by jackie.wheeler.
Component Authorization Using Spring Security [ Securing Service Components ] [ Setting Security Properties on the Security Provider ] This page describes how you can configure method-level authorization using Spring Security on your components so that users with different roles can only invoke certain service methods. Spring Security is available as of Mule 2.2.
Securing Service Components To secure MethodInvocations, you must add a properly configured MethodSecurityInterceptor into the application context. The beans requiring security are chained into the interceptor. This chaining is accomplished using Spring's ProxyFactoryBean or BeanNameAutoProxyCreator. Alternatively, Acegi Security provides a MethodDefinitionSourceAdvisor, which you can use with Spring's DefaultAdvisorAutoProxyCreator to automatically chain the security interceptor in front of any beans defined against the MethodSecurityInterceptor. In addition to the daoAuthenticationProvider and inMemoryDaoImpl beans (see Configuring Security}, the following beans must be configured: • • • • •
MethodSecurityInterceptor AuthenticationManager AccessDecisionManager AutoProxyCreator RoleVoter
The MethodSecurityInterceptor The MethodSecurityInterceptor is configured with a reference to the following: • AuthenticationManager • AccessDecisionManager Following is a security interceptor for intercepting calls made to the methods of a component that has an interface myComponentIfc, which defines two methods: delete and writeSomething. Roles are set on these methods as seen below in the property objectDefinitionSource.
<property name="authenticationManager" ref="authenticationManager"/> <property name="accessDecisionManager" ref="accessDecisionManager"/> <property name="objectDefinitionSource"> com.foo.myComponentIfc.delete=ROLE_ADMIN com.foo.myComponentIfc.writeSomething=ROLE_ANONYMOUS
Document generated by Confluence on Mar 11, 2009 14:57
Page 323
The AuthenticationManager This bean is responsible for passing requests through a chain of AuthenticationProvider objects.
<property name= "providers"> <list>
The AccessDecisionManager This bean specifies that a user can access the protected methods if they have any one of the roles specified in the objectDefinitionSource.
<property name="decisionVoters"> <list>
The AutoProxyCreator This bean defines a proxy for the protected bean. When an application asks Spring for a myComponent bean, it will get this proxy instead.
<property name="interceptorNames"> <list> myComponentSecurity <property name="beanNames"> <list> myComponent <property name='proxyTargetClass' value="true"/>
When using BeanNameAutoProxyCreator to create the required proxy for security, the configuration must contain the property proxyTargetClass set to true. Otherwise, the method passed to MethodSecurityInterceptor.invoke is the proxy's caller, not the proxy's target.
Document generated by Confluence on Mar 11, 2009 14:57
Page 324
The RoleVoter The RoleVoter class will vote if any ConfigAttribute begins with ROLE_. The RoleVoter is case sensitive on comparisons as well as the ROLE_ prefix. • It will vote to grant access if there is a GrantedAuthority, which returns a String representation (via the getAuthority() method) exactly equal to one or more ConfigAttribute objects starting with ROLE. • If there is no exact match of any ConfigAttribute starting with ROLE_, the RoleVoter will vote to deny access. • If no ConfigAttribute begins with ROLE_, the voter will abstain.
Setting Security Properties on the Security Provider You can add any additional properties to the security provider in the securityProperties map. For example, this map can be used to change Acegi's default security strategy into one of the following: • MODE_THREADLOCAL: allows the authentication to be set on the current thread (this is the default strategy used by Acegi) • MODE_INHERITABLETHREADLOCAL: allows authentication to be inherited from the parent thread • MODE_GLOBAL: allows the authentication to be set on all threads
Securing Components in Asynchronous Systems The use of Acegi's security strategies is particularly useful for asynchronous systems, since we have to add a property on the security provider for the authentication to be set on more than one thread. In this case, we would use MODE_GLOBAL as shown in the following example:
<mule-ss:security-manager> <mule-ss:delegate-security-provider name="memory-dao" delegate-ref="authenticationManager"> <mule-ss::security-property name="securityMode" value="MODE_GLOBAL"/>
Document generated by Confluence on Mar 11, 2009 14:57
Page 325
Configuring the Acegi Security Manager This page last changed on Dec 16, 2008 by jackie.wheeler.
Configuring the Acegi Security Manager The Mule Acegi security manager implementation delegates to Acegi to provide authorization and authentication functions. You can use any of the Acegi security providers such as JAAS, LDAP, CAS (Yale Central Authenication service), and DAO.
Example Configuration The following example illustrates how to configure a single security provider on Mule, in this case an in-memory DAO. Here we have a static DAO security provider that allows user credentials to be set in memory with two users: ross and anon.
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:spring="http://www.springframework.org/schema/beans" xmlns:acegi="http://www.mulesource.org/schema/mule/acegi/2.2" ...cut... <spring:bean id="inMemoryDaoImpl" class="org.acegisecurity.userdetails.memory.InMemoryDaoImpl"> <spring:property name="userMap"> <spring:value> ross=ross,ROLE_ADMIN anon=anon,ROLE_ANONYMOUS <spring:bean id="daoAuthenticationProvider" class="org.acegisecurity.providers.dao.DaoAuthenticationProvider"> <spring:property name="userDetailsService" ref="inMemoryDaoImpl"/> ...cut...
Security Filters Security filters can be configured on an object to either authenticate inbound requests or attach credentials to outbound requests. For example, to configure an HTTP basic authorization filter on an HTTP endpoint, you would use the following endpoint security filter:
When a request is received, the authentication header will be read from the request and authenticated against all security providers on the Security Manager. If you only want to validate on certain ones, you can supply a comma-separated list of security provider names.
Document generated by Confluence on Mar 11, 2009 14:57
Page 326
Document generated by Confluence on Mar 11, 2009 14:57
Page 327
Configuring the Spring Security Manager This page last changed on Feb 20, 2009 by jackie.wheeler.
Configuring the Spring Security Manager [ Example ] [ Security Filters ] As of Mule 2.2, you can use Spring Security 2.0 as a Security Manager inside of Mule. You can use any of the library's security providers such as JAAS, LDAP, CAS (Yale Central Authenication service), and DAO.
Example The following example illustrates how to configure a single security provider on Mule, in this case an in-memory database of users. To configure the provider, we set up a <user-service> element and the to which Mule delegates.
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:spring="http:// www.springframework.org/schema/beans" xmlns:http="http://www.mulesource.org/schema/mule/http/2.2" xmlns:mule-ss="http://www.mulesource.org/schema/mule/spring-security/2.2" xmlns:ss="http://www.springframework.org/schema/security" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/springbeans-2.5.xsd http://www.mulesource.org/schema/mule/core/2.2 http://www.mulesource.org/schema/mule/core/2.2/ mule.xsd http://www.mulesource.org/schema/mule/http/2.2 http://www.mulesource.org/schema/mule/http/2.2/ mule-http.xsd http://www.mulesource.org/schema/mule/spring-security/2.2 http://www.mulesource.org/schema/mule/spring-security/2.2/mule-spring-security.xsd http://www.springframework.org/schema/security http://www.springframework.org/schema/security/ spring-security-2.0.xsd"> <mule-ss:security-manager> <mule-ss:delegate-security-provider name="memory-provider" delegate-ref="authenticationManager" /> <spring:beans> <ss:authentication-manager alias="authenticationManager" /> <ss:authentication-provider> <ss:user-service id="userService"> <ss:user name="ross" password="ross" authorities="ROLE_ADMIN" /> <ss:user name="anon" password="anon" authorities="ROLE_ANON" /> ...cut...
Security Filters Security filters can be configured on an object to either authenticate inbound requests or attach credentials to outbound requests. For example, to configure an HTTP basic authorization filter on an HTTP endpoint, you would use the following endpoint security filter:
Document generated by Confluence on Mar 11, 2009 14:57
Page 328
<mule-ss:http-security-filter realm="mule-realm"/>
When a request is received, the authentication header will be read from the request and authenticated against all security providers on the Security Manager. If you only want to validate on certain ones, you can supply a comma-separated list of security provider names.
<mule-ss:http-security-filter realm="mule-realm" securityProviders="default,another"/>
Document generated by Confluence on Mar 11, 2009 14:57
Page 329
Encryption Strategies This page last changed on Dec 16, 2008 by jackie.wheeler.
Encryption Strategies The Security Manager can be configured with one or more encryption strategies that can then be used by encryption transformers, security filters, or secure transports such as SSL or HTTPS. These encryption strategies can greatly simplify configuration for secure messaging as they can be shared across components. Following is an example of a password-based encryption strategy (PBE) that provides password-based encryption using JCE. Users must specify a password and optionally a salt and iteration count as well. The default algorithm is PBEWithMD5AndDES, but users can specify any valid algorithm supported by JCE.
<security-manager> <password-encryption-strategy name="PBE" password="mule"/>
This strategy can then be referenced by other components in the system such as filters or transformers.
<decrypt-transformer name="EncryptedToByteArray" strategy-ref="PBE"/> <service name="Svc1"> <encryption-security-filter strategy-ref="PBE"/> ...cut... <service name="Svc2"> ...cut... <pass-through-router>
Document generated by Confluence on Mar 11, 2009 14:57
Page 330
Setting up LDAP Provider for Acegi This page last changed on Dec 16, 2008 by jackie.wheeler.
Setting Up an LDAP Provider for Acegi [ Declaring the Beans ] [ Configuring the Mule Security Provider ] [ Configuring the MethodSecurityInterceptor ] This page describes how you can configure an Acegi LDAP provider, which can be: • Used by Mule as its security provider via AcegiProviderAdapter • Used by Acegi/Spring to perform Component Authorization For information on configuring an in-memory DAO provider, see Configuring Security.
Declaring the Beans You must set up two beans in Spring, an InitialDirContextFactory and an LdapAuthenticationProvider. The InitialDirContextFactory is the access point for obtaining an LDAP context where the LdapAuthenticationProvider provides integration with the LDAP server. For example:
<property name="managerDn"> cn=root,dc=com,dc=foobar <property name="managerPassword"> secret
Document generated by Confluence on Mar 11, 2009 14:57
Page 331
<property name="searchSubtree"> true <property name="rolePrefix"> ROLE_ <property name="convertToUpperCase"> true
Configuring the Mule Security Provider The AcegiProviderAdapter delegates to an AuthenticationProvider such as the LdapAuthenticationProvider.
With the above configuration, you can achieve endpoint-level security and other security features in Mule that require one or more security providers.
Configuring the MethodSecurityInterceptor The configuration for component authorization is similar to the one described in Component Authorization Using Acegi. A key point of configuration is ObjectDefinitionSource:
<property name="objectDefinitionSource" value="org.mule.api.lifecycle.Callable.onCall=ROLE_MANAGERS"/>
The roles are looked up by the DefaultLdapAuthoritiesPopulator, which you configured in the previous section. By default, a role is prefixed with ROLE_ and its value is extracted (and converted to uppercase) from the LDAP attribute defined by the groupRoleAttribute.
Document generated by Confluence on Mar 11, 2009 14:57
Page 332
Setting up LDAP Provider for Spring Security This page last changed on Feb 20, 2009 by jackie.wheeler.
Setting Up an LDAP Provider for Spring Security [ Declaring the Beans ] [ Configuring the Mule Security Provider ] [ Configuring the MethodSecurityInterceptor ] This page describes how you can configure a Spring Security LDAP provider, which can be used by Mule 2.2 or later as follows: • As its security provider via SpringProviderAdapter • To perform component authorization For information on configuring an in-memory provider, see Configuring Security.
Declaring the Beans You must set up two beans in Spring, an InitialDirContextFactory and an LdapAuthenticationProvider. The InitialDirContextFactory is the access point for obtaining an LDAP context where the LdapAuthenticationProvider provides integration with the LDAP server. For example:
<property name="managerDn"> cn=root,dc=com,dc=foobar <property name="managerPassword"> secret <property name="userDnPatterns"> <list> uid={0},ou=people <property name="groupRoleAttribute" value="ou"/>
Document generated by Confluence on Mar 11, 2009 14:57
Page 333
Configuring the Mule Security Provider The AcegiProviderAdapter delegates to an AuthenticationProvider such as the LdapAuthenticationProvider.
<mule-ss:security-manager> <mule-ss:delegate-security-provider name="acegi-ldap" delegate-ref="authenticationManager"/>
With the above configuration, you can achieve endpoint-level security and other security features in Mule that require one or more security providers.
Configuring the MethodSecurityInterceptor The configuration for component authorization is similar to the one described in Component Authorization Using Acegi. A key point of configuration is ObjectDefinitionSource:
<property name="objectDefinitionSource" value="org.mule.api.lifecycle.Callable.onCall=ROLE_MANAGERS"/>
The roles are looked up by the DefaultLdapAuthoritiesPopulator, which you configured in the previous section. By default, a role is prefixed with ROLE_, and its value is extracted and converted to uppercase from the LDAP attribute defined by the groupRoleAttribute.
Document generated by Confluence on Mar 11, 2009 14:57
Page 334
Upgrading from Acegi to Spring Security This page last changed on Dec 19, 2008 by jackie.wheeler.
Upgrading from Acegi to Spring Security [ Adding the Namespaces ] [ Updating the Acegi Package Names ] [ Using an AuthenticationManager ] [ Simplifying the Configuration ] Spring Security is version 2.0 of the Acegi Security framework. Upgrading your Mule application to use Spring Security instead of Acegi involves the following steps: 1. 2. 3. 4.
Adding the necessary namespaces to your Mule configuration Updating the Acegi package names Updating your Mule configuration to use an AuthenticationManager Simplification using new Spring Security elements
Adding the Namespaces Your Mule configuration file should have the following namespaces declared.
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:spring="http:// www.springframework.org/schema/beans" xmlns:mule-ss="http://www.mulesource.org/schema/mule/spring-security/2.2" xmlns:ss="http://www.springframework.org/schema/security" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/springbeans-2.5.xsd http://www.mulesource.org/schema/mule/core/2.2 http://www.mulesource.org/schema/mule/core/2.2/ mule.xsd http://www.mulesource.org/schema/mule/spring-security/2.2 http://www.mulesource.org/schema/mule/spring-security/2.2/mule-spring-security.xsd http://www.springframework.org/schema/security http://www.springframework.org/schema/security/spring-security-2.0.xsd"> ...
The mule-ss namespace is for the Mule Spring Security extensions. The ss namespace is for the Spring Security schema elements that are not Mule specific and allows you to use the less verbose XML that is part of Spring Security 2.0.
Updating the Acegi Package Names Except for the changed package names, the Spring Security API has remained compatible with Acegi. For example, assume you configured a DaoAuthenticationProvider like this one:
<property name="userDetailsService" ref="userService"/>
To use Spring Security, you simply change the acegisecurity package to springframework.security:
Document generated by Confluence on Mar 11, 2009 14:57
Page 335
<property name="userDetailsService" ref="userService"/>
Repeat this step for all your Acegi bean definitions.
Using an AuthenticationManager The only major difference between Mule integration with Acegi and Spring Security is that the latter uses the AuthenticationManager to provider authentication functions, while the former tied in at the Acegi AuthenticationProvider level. With the Acegi provider, the authentication flow followed this progression:
AcegiProviderAdapter (Mule) -> AuthenticationProvider (Acegi)
With the new Spring Security adapter, it follows this progression:
SpringProviderAdapter (Mule) -> AuthenticationManager (Spring Security) -> AuthenticationProvider (Spring Security)
This allows the authentication manager to try multiple authentication providers to authenticate your messages. Configuration of this approach requires a little more XML. For example, consider this original configuration:
<mule ...> <spring:bean id="inMemoryDaoImpl" class="org.acegisecurity.userdetails.memory.InMemoryDaoImpl"> <spring:property name="userMap"> <spring:value> ross=ross,ROLE_ADMIN anon=anon,ROLE_ANONYMOUS <spring:bean id="daoAuthenticationProvider" class="org.acegisecurity.providers.dao.DaoAuthenticationProvider"> <spring:property name="userDetailsService" ref="inMemoryDaoImpl"/>
To upgrade this configuration, you add an AuthenticationManager. This would result in the following:
<mule ...> <mule-ss:security-manager> <mule-ss:delegate-security-provider name="memory-dao" delegate-ref="authenticationManager"/>
Document generated by Confluence on Mar 11, 2009 14:57
Page 336
<spring:bean id="inMemoryDaoImpl" class="org.springframework.security.userdetails.memory.InMemoryDaoImpl"> <spring:property name="userMap"> <spring:value> ross=ross,ROLE_ADMIN anon=anon,ROLE_ANONYMOUS <spring:bean id="daoAuthenticationProvider" class="org.springframework.security.providers.dao.DaoAuthenticationProvider"> <spring:property name="userDetailsService" ref="inMemoryDaoImpl"/> <spring:bean id="authenticationManager" class="org.springframework.security.providers.ProviderManager"> <spring:property name="providers"> <spring:list> <spring:ref bean="daoAuthenticationProvider"/>
Simplifying the Configuration Spring Security 2.0 includes new XML syntax that can simplify configurations, especially in simple cases. For example, the previous example has an in-memory user database, a DAO authentication provider, and an authentication manager. This can be simplified to:
<mule ...> <mule-ss:security-manager> <mule-ss:delegate-security-provider name="memory-dao" delegate-ref="authenticationManager" /> <spring:beans> <ss:authentication-manager alias="authenticationManager" /> <ss:authentication-provider> <ss:user-service id="userService"> <ss:user name="ross" password="ross" authorities="ROLE_ADMIN" /> <ss:user name="anon" password="anon" authorities="ROLE_ANON" />
The element defines the name of our AuthenticationManager bean. We then create a single AuthenticationProvider with the elements. This <user-service> is the same as our InMemoryDaoImpl above. For more information on how to configure Acegi, see the following Spring documentation: • Spring Security Documentation • Spring Security Javadoc • Spring Security XML Schema reference
Document generated by Confluence on Mar 11, 2009 14:57
Page 337
Controlling the Infrastructure with Mule Galaxy This page last changed on Aug 04, 2008 by jackie.wheeler.
Controlling the Infrastructure with Mule Galaxy Mule Galaxy helps you get control over your infrastructure by providing the following features: • Governance: provides a centralized control point for policy management and compliance, ensuring that your SOA adheres to your firm's policies. • Registry: automatically detects and displays dependencies among services and manages service lifecycles. • Repository: stores and manages artifacts (including Mule configuration files, web services frameworks, and any other artifact), providing version management and collaborative comments, and allows you to publish the artifacts in a web browser using the Atom Publishing Protocol. Mule Galaxy can be deployed either alongside Mule or as a standalone component in an enterprise's SOA infrastructure. Mule Galaxy is available with Mule Enterprise Edition. For complete information on Mule Galaxy, see the Mule Galaxy site.
Document generated by Confluence on Mar 11, 2009 14:57
Page 338
Creating a Custom XML Namespace This page last changed on Feb 25, 2009 by jackie.wheeler.
Creating a Custom XML Namespace XML schema definitions are used for each module to define the objects and properties that the module makes available to Mule. These configuration elements are introduced using a namespace for each module and associating the namespace with the schema. This page describes how configuration is handled in Mule and what steps are required when writing a new module or transport in Mule.
Advantages of Using Namespaces The use of namespaces provides the following advantages: • Class names are removed from XML so that implementation details are hidden. • All objects introduced by the module are self-contained by a namespace. • The schema provides a domain-specific language (DSL) for the module where all objects and properties are described in the schema with type validation. • The schema can provide additional validation for types, value ranges, and required properties.
Using Module Schemas Schemas are located in each package's main/resources/META-INF directory. The core schema is in the mule-core package, the TCP schema is in the tcp package, and so on. The Mule schema can be used directly or embedded inside Spring. In addition, Spring beans can be created directly inside the Mule schema (just use <spring:bean .../>) and elements from other namespaces can be placed in ....
Mule Namespace The default namespace for Mule xml configuration files is mule:
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:spring="http://www.springframework.org/schema/beans" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/springbeans-2.5.xsd http://www.mulesource.org/schema/mule/core/2.2 META-INF/mule.xsd"> <spring:bean ...you can also embed Spring bean definitions directly.../> <spring:beans>
Note here we have a spring namespace declared so we can embed spring beans directly inside your Mule configuration file.
Document generated by Confluence on Mar 11, 2009 14:57
Page 339
More on Mixing Mule and Spring The Mule schema includes the ability to use Spring elements at certain points by including <spring:bean> inside <mule>. These elements are handled explicitly by Mule code, which delegates their processing to Spring. Be careful when using Spring elements in your own schema, and check that they behave as expected. The and elements are all forwarded to Spring for processing. In addition, the predefined mule:mapType can be used and, when associated with the ChildMapDefinitionParser, will automatically construct a map using Spring's <entry> elements (this is the only way that <entry> can be used directly inside Mule elements). For examples, see the use of mapType in the Mule schema. Similar behavior with ChildPropertiesDefinitionParser should also be possible (but ChildMapEntry and ChildListEntryDefinitionParsers are unrelated to Spring). Other namespaces can be introduced via <spring:beans> or by adding a dedicated element in a module (see the Scripting module's element).
Documentation You add documentation to the schema using the <xsd:annotation> and <xsd:documentation> tags:
<xsd:element name="my-element" type="myType"> <xsd:annotation> <xsd:documentation>This element does this <xsd:complexType name="myType"> <xsd:annotation> <xsd:documentation>This type does that
While documentation can be added in various places within the schema, tools that use this information follow certain conventions (see below). As a consequence, embedded documentation should: • • • •
Be placed in the element, attribute, or associated type Avoid duplicating information in element and type Avoid reference elements (<xsd:element ref="..."/>) Make documentation at each level correct and distinct (do not rely on inheritance, but try to avoid duplication)
IntelliJ Idea Idea will show documentation defined for an element or attribute, or for the associated type if those are missing. The information is displayed when the user presses Ctrl-J. For more information see this post about how to work with Mule schemas in IntelliJ. Eclipse The Web Tools Platform (WTP) XML editor shows documentation defined for an element or attribute, or for the associated type if those are missing. The information is displayed when you press F2 when an element or attribute is selected or has the cursor on it. The same information is also shown when using the context-sensitive auto-completion functionality by pressing the "CTRL-." key combination. The WTP XML editor will display "inherited" documentation but does not show documentation associated with referenced global elements.
Document generated by Confluence on Mar 11, 2009 14:57
Page 340
Writing Configuration Handlers When writing a new Mule transport of module, you will need to write a schema definition and the code necessary to parse the XML, but most of the work is done for you. The following section will walk through the process of: • Defining the XML Schema: Describes all the objects that your module exposes, such as transformers, components, filters, routers, agents, etc. • Writing the Namespace Handler: Responsible for configuring the XML parsers for each of the elements that your schema defines. • Writing a Definition Parser for each of the elements (objects) defined in the schema • Testing your Namespace Handler
Defining the Schema If you are not familiar with XML schema, you may want to take an introductory course here. However, Mule defines most of what you need out of the box, so it's fairly straightforward to jump in and write your own. Following are a few key concepts: • Complex Types are defined for each object in the module. Complex types define the elements and attributes that make up the type. For example, a connectorType would define shared attributes for all connectors and define any nested elements such as <service-overrides>.
<xsd:complexType name="connectorType" mixed="true"> <xsd:choice minOccurs="0" maxOccurs="unbounded"> <xsd:element name="receiver-threading-profile" type="threadingProfileType" minOccurs="0" maxOccurs="1"/> <xsd:element name="dispatcher-threading-profile" type="threadingProfileType" minOccurs="0" maxOccurs="1"/> <xsd:group ref="exceptionStrategies" minOccurs="0" maxOccurs="1"/> <xsd:element name="service-overrides" type="serviceOverridesType" minOccurs="0" maxOccurs="1"/> <xsd:attribute name="name" type="xsd:string" use="required"/> <xsd:attribute name="createDispatcherPerRequest" type="xsd:boolean"/> <xsd:attribute name="createMultipleTransactedReceivers" type="xsd:boolean"/>
Note that complex types can be extended (much like inheritance), so new complex types can be built upon existing ones. Mule provides a number of base complex types out of the box for connectors, agents, transformers, and routers. If you write one of these, your schema should extend the corresponding complex type. Using TCP as an example, here is an excerpt from where we define the noProtocolTcpConnectorType:
<xsd:import namespace="http://www.mulesource.org/schema/mule/core/2.2"/> <xsd:complexType name="noProtocolTcpConnectorType"> <xsd:complexContent> <xsd:extension base="mule:connectorType"> <xsd:attribute name="sendBufferSize" type="mule:substitutableInt"> <xsd:annotation> <xsd:documentation> The size of the buffer (in bytes) used when sending data, set on the socket itself. <xsd:attribute name="receiveBufferSize" type="mule:substitutableInt"> <xsd:annotation> <xsd:documentation>
Document generated by Confluence on Mar 11, 2009 14:57
Page 341
The size of the buffer (in bytes) used when receiving data, set on the socket itself. ... <xsd:attribute name="validateConnections" type="mule:substitutableBoolean"> <xsd:annotation> <xsd:documentation> This "blips" the socket, opening and closing it to validate the connection when first accessed.
This complex type extends the mule:connectorType type. Notice that we need to import the Mule core schema since that is where the connectorType is defined. Schema Types Note that the types we use for int, boolean, and all numeric types are custom types called substitutableInt or substitutableBoolean. These types allow for int values and boolean values but also allow developers to use property placeholders, such as ${tcp.keepAlive} as a valid value for the property. These placeholders will be replaced at run-time by real values defined in property files. Element definitions describe what elements are available in the schema. An element has a type, which should be declared as a Complex Type. For example:
<xsd:element name="connector" type="tcpConnectorType"/>
This makes the connector element available within the tcp namespace. The schema should be called mule-<short module name>.xsd and stored in the META-INF of the module or transport.
Versioning In Mule, the version of the schema is maintained in the schema URI. This means that the namespace and the targetNamespace implicitly contain the schema version. Schema URIs use the following convention: http://www.mulesource.org/schema/mule/core/2.2
The first part of the URI http://www.mulesource.org/schema/mule/ is the same for each schema. It is then followed by the module's short name, followed by the version of the schema.
Schema Mapping To stop the XML parser from loading Mule schemas from the Internet, you add a mapping file that maps the remote schema location to a local classpath location. This mapping is done in a simple properties file called spring.schemas located in the META-INF directory for the module/transport.
http\://www.mulesource.org/schema/mule/tcp/2.2/mule-tcp.xsd=META-INF/mule-tcp.xsd
Document generated by Confluence on Mar 11, 2009 14:57
Page 342
Namespace Handler The namespace handler is responsible for registering definition parsers, so that when an element in the configuration is found, it knows which parser to use to create the corresponding object. A namespace handler is a single class that is directly associated with a namespace URI. To make this association, there needs to be a file called spring.handlers in the root of the META-INF directory of the module or transport. The file contains the following:
http\://www.mulesource.org/schema/mule/tcp/2.1=org.mule.transport.tcp.config.TcpNamespaceHandler
The TcpNamespaceHandler code is very simple because there is a base support class provided:
public class TcpNamespaceHandler extends NamespaceHandlerSupport { public void init() { registerBeanDefinitionParser("connector", new OrphanDefinitionParser(TcpConnector.class, true)); } }
Here, there should be one or more registrations binding an element name with a definition parser.
Definition Parsers The definition parser is where the actual object reference is created. It includes some Spring-specific classes and terminology, so it's worth reading this introduction. Mule already includes a number of useful definition parsers that can be used for most situations or extended to suit your needs. You can also create a custom definition parser. The following table describes the existing parsers. To see how they are used, see org.mule.config.spring.handlers.MuleNamespaceHandler .
Parser
Description
org.mule.config.spring.parsers.generic.OrphanDefinitionParser Contructs a single, standalone bean from an element. It is not injected into any other object. This parser can be configured to automatically set the class of the object, the init and destroy methods, and whether this object is a singleton. org.mule.config.spring.parsers.generic.ChildDefinitionParser Creates a definition parser that will construct a single child element and inject it into the parent object (the enclosing XML element). The parser will set all attributes defined in the XML as bean properties and will process any nested elements as bean properties too, except the correct definition parser for the element will be looked up automatically. If the class is read from an attribute (when class is null), it is checked against the constraint. It must be a subclass of the constraint. org.mule.config.spring.parsers.generic.ParentDefinitionParser Processes child property elements in XML but sets the properties on the parent object. This is useful when an object has lots of properties and
Document generated by Confluence on Mar 11, 2009 14:57
Page 343
it's more readable to break those properties into groups that can be represented as a sub-element in XML. org.mule.config.spring.parsers.collection.ChildMapEntryDefinitionParser Allows a series of key value pair elements to be set on an object as a Map. There is no need to define a surrounding 'map' element to contain the map entries. This is useful for key value pair mappings. org.mule.config.spring.parsers.AbstractChildBeanDefinitionParser This definition parser introduces the notion of hierarchical processing to nested XML elements. Definition parsers that extend this class are always child beans that get set on the parent definition parser. A single method getPropertyName must be overriden to specify the name of the property to set on the parent bean with this bean. Note that the property name can be dynamically resolved depending on the parent element. This implementation also supports collections and Maps. If the bean class for this element is set to MapEntryDefinitionParser.KeyValuePair, it is assumed that a Map is being processed and any child elements will be added to the parent Map. org.mule.config.spring.parsers.AbstractMuleSingleBeanDefinitionParser This parser extends the Spring provided AbstractBeanDefinitionParser to provide additional features for consistently customizing bean representations for Mule bean definition parsers. Most custom bean definition parsers in Mule will use this base class. The following enhancements are made: • Attribute mappings can be registered to control how an attribute name in Mule XML maps to the bean name in the object being created. • Value mappings can be used to map key value pairs from selection lists in the XML schema to property values on the bean being created. These are a comma-separated list of key=value pairs. • Provides an automatic way of setting the init-method and destroy-method for this object. This will then automatically wire the bean into the lifecycle of the application context. • The singleton property provides a fixed way to make sure the bean is always a singleton or not.
Naming Conventions The number and variety of definition parsers is growing rapidly. To make them more manageable, please use the following conventions. • Group by function. Abstract bases live in org.mule.config.spring.parsers. Under that we have generic, specific, and collection, which should be self-explanatory. Inside those you may want to add further grouping (e.g., specific.security). • Use consistent names for the relationship of the object being created with the surrounding context: ° Child objects are injected into parents (the enclosing DOM element) ° Grandchild are like child, but recurse up the DOM tree more than one generation ° Orphan objects stand alone
Document generated by Confluence on Mar 11, 2009 14:57
Page 344
° °
Named objects are injected into a target identified by name rather than DOM location. Parent definition parsers are something like facades, providing an alternative interface to the parent.
Testing Testing the namespace handler is pretty simple. You configure the object in Mule XML, start the server, and check that the values have been set correctly. For example:
public class TcpNamespaceHandlerTestCase extends FunctionalTestCase { protected String getConfigResources() { return "tcp-namespace-config.xml"; } public void testConfig() throws Exception { TcpConnector c = (TcpConnector)managementContext.getRegistry().lookupConnector("tcpConnector"); assertNotNull(c); assertEquals(1024, c.getReceiveBufferSize()); assertEquals(2048, c.getSendBufferSize()); assertEquals(50, c.getReceiveBacklog()); assertEquals(3000, c.getReceiveTimeout()); assertTrue(c.isKeepAlive()); assertTrue(c.isConnected()); assertTrue(c.isStarted()); } }
Extending Existing Handlers Instead of creating a new handler, you can extend an existing transport and add new properties and elements. For example, the SSL transport extends the TCP transport.
<xsd:schema xmlns="http://www.mulesource.org/schema/mule/ssl/2.2" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:mule="http://www.mulesource.org/schema/mule/core/2.2" xmlns:tcp="http://www.mulesource.org/schema/mule/tcp/2.2" targetNamespace="http://www.mulesource.org/schema/mule/ssl/2.2" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xsd:import namespace="http://www.w3.org/XML/1998/namespace"/> <xsd:import namespace="http://www.mulesource.org/schema/mule/core/2.2" schemaLocation="http://www.mulesource.org/schema/mule/core/2.2/mule.xsd" /> <xsd:import namespace="http://www.mulesource.org/schema/mule/tcp/2.2" schemaLocation="http://www.mulesource.org/schema/mule/tcp/2.2/mule-tcp.xsd"/> <xsd:element name="connector" substitutionGroup="mule:abstract-connector"> <xsd:annotation> <xsd:documentation> Connect Mule to an SSL socket, to send or receive data via the network. <xsd:complexType> <xsd:complexContent> <xsd:extension base="tcp:tcpConnectorType">
Document generated by Confluence on Mar 11, 2009 14:57
Page 345
<xsd:sequence> <xsd:element minOccurs="0" type="mule:tlsClientKeyStoreType"/> <xsd:element minOccurs="0" type="mule:tlsKeyStoreType"/> <xsd:element minOccurs="0" type="mule:tlsServerTrustStoreType"/> <xsd:element minOccurs="0" type="mule:tlsProtocolHandler"/>
maxOccurs="1" name="client" maxOccurs="1" name="key-store" maxOccurs="1" name="server" maxOccurs="1" name="protocol-handler"
Simple Recipe The following recipe is sufficient for a simple transport (like UDP). The ordering helps guarantee complete coverage. 1. Write a test case for the connector. a. Use IDE's auto completion to test each public getter (as a first approximation to the public API - tidy by hand). b. Set the test value to something other than the default. 2. Write the XML configuration for the connector (test/resources/foo-connector-test.xml) using the properties from the test (make sure the import section is correct). 3. Write the schema definition (tweaking until the XML connector config shows no errors) (META-INF/ mule-foo.xsd). 4. Write the namespace handler (and any needed definition parsers) (src/main/java/org/mule/ providers/foo/config/FooNamespaceHandler) 5. Set the Spring handler mapping (META-INF/spring.handlers). 6. Set the local schema mapping (META-INF/spring.schemas). 7. Make sure the test runs. 8. Check properties against the documentation and make consistent (but note that things like connection strategy parameters are handled by an embedded element that is itself inherited from the connectorType) and then re-run the test.
Resources • A useful set of PDF slides that give an overview of the new approach in Spring and (slides 29 on) given an introductory example. The Mule code is more complex, but follows the same structure: org.mule.config.spring.handlers.MuleNamespaceHandler is the namespace handler; org.mule.config.spring.parsers.AbstractMuleBeanDefinitionParser and subclasses are the bean definition parsers. • A couple of blog posts (1, 2) that give a developer's-eye overview. • Useful papers on mutable/extensible containers 1, 2
Document generated by Confluence on Mar 11, 2009 14:57
Page 346
Creating Custom Routers This page last changed on Sep 12, 2008 by jackie.wheeler.
Creating Custom Routers Typically, you implement custom routing with filters, but occasionally you may need to implement a customer router.
Custom Outbound Routers Outbound routers control how a message gets routed to a list of endpoints. For example, sometimes a message gets routed based on simple rules or business logic, whereas in other cases you may multicast a message to every router. The easiest way to write an outbound router is to extend the org.mule.routing.outbound.AbstractOutboundRouter class:
import org.mule.routing.outbound.AbstractOutboundRouter; public class CustomOutboundRouter extends AbstractOutboundRouter { .... }
There are two methods you must implement that control how messages will be routed through the system. First, you must implement the isMatch method. This determines if a message should be processed by the router. For example, to route only messages that have a payload containing the string "hello":
public boolean isMatch(MuleMessage message) throws RoutingException { return "hello".equals(message.getPayloadAsString()); }
The second method you must implement is the route method. Each outbound router has a list of endpoints that are associated with it. The route method contains the logic to control how the event is propagated to the endpoints. For example, if there were two endpoints you want to route to based on a condition, you would use this method to select the endpoint:
MuleMessage route(MuleMessage message, MuleSession session, boolean synchronous) throws MessagingException { OutboundEndpoint ep = null; if (isConditionMet(message)) { ep = getEndpoints().get(0); } else { ep = getEndpoints().get(1); } ....
Once you've selected an endpoint, you must then dispatch or send the message to it based on whether or not the message is synchronous:
Document generated by Confluence on Mar 11, 2009 14:57
Page 347
try { if (synchronous) { return send(session, message, ep); } else { dispatch(session, message, ep); return null; } } catch (MuleException e) { throw new CouldNotRouteOutboundMessageException(message, ep, e); } return result; }
If the request is synchronous, you must use the send method to send the inbound messages synchronously to the endpoint. The result from this is then returned. If the request is asynchronous, it is sent using the dispatch method, and no response message is returned.
Custom Inbound Routers Inbound routers control whether a message is consumed by an inbound endpoint. Typically, you do not have to create custom routers, as the existing ones provide a high degree of customization using existing or custom filters. If a new inbound router class is needed, it will typically extend the org.mule.routing.inbound.SelectiveConsumer router. This class uses the Mule filter APIs to determine if a message should be consumed and can be configured using the existing filters. The other responsibility of inbound routers is to control how a message is processed by a service. It can choose to: • • • •
Consume the message and start a new message. Aggregate several messages. Forward an incoming message to an outbound transport and skip the service invocation. Pass on the original message. For more information, examine the source code for the available inbound routers.
Document generated by Confluence on Mar 11, 2009 14:57
Page 348
Creating Transports This page last changed on Feb 09, 2009 by jackie.wheeler.
Creating Transports [ Overview ] [ Transport Interfaces ] [ Implementation ] [ Connectors ] [ Message Receivers ] [ Message Dispatchers ] [ Message Requesters ] [ Service Descriptors ] [ Coding Standards ] [ Package Structure ] Transports are used to implement message channels and provide connectivity to an underlying data source or message channel in a consistent way. Mule provides transports for many different protocols, including File, FTP, HTTP, JMS, JDBC, Quartz, and many more. For a complete list, see Available Transports. There are also community-created transports on MuleForge. If you need to send messages on a protocol other than those provided, you can create a new transport.
Overview When creating a new transport, you must implement a set of Mule interfaces in the org.mule.transport package, and then extend the provided abstract classes. For a quick start, you can use the Maven transport archetype as a code template for your transports. If you want to update an existing transport, use the Module Archetype instead. Mule transports can be one of the following types: 1. inbound-only: Components can only subscribe to events. They cannot dispatch events. 2. outbound-only: Components can only dispatch events. They cannot subscribe to events. 3. inbound-outbound: Components can subscribe and dispatch events
Transport Interfaces A transport consists of a set of interface implementations that expose the features for the underlying transport. Cannot resolve external resource into attachment.
Interface
Role
Connector
Used to manage Receivers, Dispatchers and Requesters and to store any configuration information.
Message Receiver
Implements the server part of the transport. For example, a TcpMessageReceiver creates a server socket to receive incoming requests. A MessageReceiver instance is created when this transport is used for inbound communication.
Message Dispatcher
Implements the client part of the transport. For example, a TcpMessageDispatcher opens a socket to send requests. A MessageDispatcher instance is created when this transport for outbound communication.
Message Requester
Is also used to receive incoming messages like the MessageReceiver but rather than subscribing to inbound events or polling a resource or message channel messages are only received on "request". Inbound endpoints on services always use a MessageReceiver rather than a MessageRequester but they can be used elsewhere programatically to
Document generated by Confluence on Mar 11, 2009 14:57
Page 349
request a single message from a message channel or resource. Message Adapter
Is contained within the message and acts as a bridge between the underlying message type used by this transport and a MuleMessage. For example, the JMS message adapter exposes Mule methods such as getPayload() to provide access to the payload of the JMS message, and all headers and user properties are accessible as message properties.
Transformers
Transformers are used to convert data between the transport-specific data format and another format, such as from an HTTP response to a string. The dispatcher must call MuleEvent.transformMessage() to transform the message.
Endpoints
The means of configuring the use of message channels or resource as part of service configuration. The endpoint defines which transport to use and includes settings like the host or queue name, the filter to use, and transaction info. Defining an endpoint on a service will cause Mule to create the necessary transport connector for the protocol being used.
When writing a transport, you must implement the following interfaces that define the contract between Mule and the underlying technology. org.mule.api.transport.Connector The connector is used by Mule to register listeners and create message dispatchers for the transport. Configuration parameters that should be shared by all Message Receivers, Dispatchers and Requesters are stored on the connector. Usually, only one connector instance is needed for multiple inbound and outbound endpoints as multiple Message Receivers, Dispatchers and Requesters can be associated with a connector. However, where the underlying transport API has the notion of a connection such as the JMS or JDBC API, there should be a one-to-one mapping between the Mule connector and the underlying connection. org.mule.api.transport.MessageReceiver The Message Receiver is used to receive incoming data from the underlying transport and package it as an event. The Message Receiver is essentially the server implementation of the transport (where the Message Dispatcher is a client implementation). For example, the HTTP Message Receiver is an HTTP server implementation that accepts HTTP requests. An implementation of this class is needed if the transport supports inbound communication. org.mule.api.transport.MessageDispatcher The Message Dispatcher is used to send messages, which is akin to making client calls with the underlying technology. For example, the CXF Message Dispatcher will make a web service call. An implementation of this class is needed if the transport supports outbound communication. The Message Dispatcher must call MuleEvent.transformMessage() to invoke any necessary transformers before dispatching it. org.mule.api.transport.MessageRequester The Message Requester is used to request messages from a message channel or resource rather than subscribing to inbound events or polling a resource for messages. This is often used programatically but is not used for inbound endpoints configured on services. An implementation of this class is needed if the transport supports the requesting of messages from a message channel.
Document generated by Confluence on Mar 11, 2009 14:57
Page 350
org.mule.api.transport.MessageDispatcherFactory This is a factory class used to create MessageDispatcher instances. An implementation of this class is needed if the transport supports outbound communication. org.mule.api.transport.MessageAdapter The message adapter is used to provide a consistent way of reading messages in Mule. The message adapter provides methods for reading the payload of the message and reading message properties. These properties may be message headers, custom properties, or other meta information about the message.
Implementation Mule provides abstract implementations for all of the above interfaces. These implementations handle all the Mule specifics, leaving a few abstract methods where custom transport code should be implemented. Therefore, writing a custom transport is as easy as writing/embedding client and or server code specific to the underlying technology. The following sections describes the implementations available to you. For a quick start, use the Maven Transport Archetype.
Connectors The org.mule.transport.AbstractConnector implements all the default functionality required for Mule connectors, such as threading configuration and receiver/dispatcher management. For details about the standard connector properties, see Configuring a Transport. You can set further properties on the connector that act as defaults. For example, you can set endpoint properties that are used by default unless you override them when configuring a specific endpoint. Sometimes the connector is responsible for managing a connection resource of the transport where the underlying technology has the notion of a connection, such as in JMS or JDBC. These types of connectors will have a one-to-one mapping between a Mule connector and the underlying connection. Therefore, if you want to have two or more physical JMS connections in a single Mule instance, a new connector should be created for each connection. For other transports, there will be only one connector of a particular protocol in a Mule instance that manages all endpoint connections. One such example would be socket-based transports such as TCP where each receiver manages its own ServerSocket and the connector manages multiple receivers.
Methods to Implement
Method Name
Description
Required
doInitialise()
Is called once all bean properties have been set on the connector and can be used to validate and initialize the connector's state.
No
doStart()
If there is a single server instance or connection associated with the connector (such as AxisServer or a JMS or JDBC Connection), this method should put the resource in a started state.
No
doConnect()
Makes a connection to the underlying resource if this is not handled at the receiver/ dispatcher level.
No
Document generated by Confluence on Mar 11, 2009 14:57
Page 351
doDisconnect()
Close any connection made in doConnect().
No
doStop()
Should put any associated resources into a stopped state. Mule automatically calls the stop() method.
No
doDispose()
Should clean up any open resources associated with the connector.
No
Message Receivers Message Receivers will behave a bit differently for each transport, but Mule provides some standard implementations that can be used for polling resources and managing transactions for the resource. Usually there are two types of Message Receivers: Polling and Listener-based. • A Polling Receiver polls a resource such as the file system, database, and streams. • A Listener-based receiver registers itself as a listener to a transport. Examples would be JMS (javax.message.MessageListener) and Pop3 (javax.mail.MessageCountListener). These base types may be transacted. The abstract implementations provided by Mule are described below.
Abstract Message Receiver The AbstractMessageReceiver provides methods for routing events. When extending this class, you should set up the necessary code to register the object as a listener to the transport. This will usually be a case of implementing a listener interface and registering itself. Methods to Implement
Method name
Description
Required
doConnect()
Should make a connection to the underlying transport, such as to connect to a socket or register a SOAP service. When there is no connection to be made, this method should be used to check that resources are available. For example, the FileMessageReceiver checks that the directories it will be using are available and readable. The MessageReceiver should remain in a 'stopped' state even after the doConnect() method is called. This means that a connection has been made but no events will be received until the start() method is called. Calling start() on the MessageReceiver will call doConnect() if the receiver hasn't connected.
Yes
doDisconnect()
Disconnects and tidies up any resources allocated using
Yes
Document generated by Confluence on Mar 11, 2009 14:57
Page 352
the doConnect() method. This method should return the MessageReceiver in a disconnected state so that it can be connected again using the doConnect() method. doStart()
Should perform any actions necessary to enable the receiver to start receiving events. This is different from the doConnect() method, which actually makes a connection to the transport but leaves the MessageReceiver in a stopped state. For polling-based MessageReceivers, the doStart() method simply starts the polling thread. For the Axis message receiver, the start method on the SOAPService is called. The action performed depends on the transport being used. Typically, a custom transport doesn't need to override this method.
No
doStop()
Should perform any actions necessary to stop the receiver from receiving events.
No
doDispose()
Is called when the connector is being disposed and should clean up any resources. The doStop() and doDisconnect() methods will be called implicitly when this method is called.
No
Polling Message Receiver Some transports poll a resource periodically waiting for new data to arrive. The polling message receiver, which is based on AbstractPollingMessageReceiver , implements the code necessary to set up and destroy a listening thread and provides a single method poll() that is invoked repeatedly at a given frequency. Setting up and destroying the listening thread should occur in the doStart() and doStop() methods respectively. Methods to Implement
Method name
Description
Required
poll()
Is executed repeatedly at a configured frequency. This method should execute the logic necessary to read the data and return it. The data returned will be the payload of the new message. Returning null will cause no event to be fired.
Yes
Document generated by Confluence on Mar 11, 2009 14:57
Page 353
Transacted Polling Message Receiver The TransactedPollingMessageReceiver can be used by transaction-enabled transports to manage polling and transactions for incoming requests. This receiver uses a transaction template to execute requests in transactions, and the transactions themselves are created according to the endpoint configuration for the receiver. Derived implementations of this class must be thread safe, as several threads can be started at once for an improved throughput. Methods to Implement You implement the following methods for the transacted polling message receiver in addition to those in the standard Message Receiver:
Method name
Description
Required
getMessages()
Returns a list of objects that represent individual message payloads. The payload can be any type of object and will by sent to Mule services wrapped in a MuleEvent object.
Yes
processMessage(Object)
is called for each object in the list returned from getMessages(). Each object processed is managed in its own transaction.
Yes
Thread Management It's common for receivers to spawn a thread per request. All receiver threads are allocated using the WorkManager on the receiver. The WorkManager is responsible for executing units of work in a thread. It has a thread pool that allows threads to be reused and ensures that only a prescribed number of threads will be spawned. The WorkManager is an implementation of org.mule.api.context.WorkManager , which is really just a wrapper of javax.resource.spi.work.WorkManager with some extra lifecycle methods. There is a getWorkManager() method on the AbstractMessageReceiver that you can use to get a reference to the WorkManager for the receiver. Work items (such as the code to execute in a separate thread) must implement javax.resource.spi.work.Work. This interface extends java.lang.Runnable and thus has a run() method that will be invoked by the WorkManager. When scheduling work with the WorkManager, you should call scheduleWork(...) on the WorkManager rather than startWork(...).
Message Dispatchers Whereas a message receiver is equivalent to a server for the transport in that it serves client requests, a message dispatcher is the client implementation of the transport. Message dispatchers are responsible for making client requests over the transport, such as writing to a socket or invoking a web service. The AbstractMessageDispatcher provides a good base implementation, leaving three methods for the custom MessageDispatcher to implement. Methods to Implement
Method Name
Description
Document generated by Confluence on Mar 11, 2009 14:57
Required
Page 354
doSend(MuleEvent)
Sends the message payload over the transport. If there is a response from the transport, it should be returned from this method. The sendEvent method is called when the endpoint is running synchronously, and any response returned will ultimately be passed back to the caller. This method is executed in the same thread as the request thread.
Yes
doDispatch(MuleEvent)
Invoked when the endpoint is asynchronous and should invoke the transport but not return any result. If a result is returned, it should be ignored, and if they underlying transport does have a notion of asynchronous processing, that should be invoked. This method is executed in a different thread from the request thread.
Yes
doConnect()
Makes a connection to the underlying transport, such as connecting to a socket or registering a SOAP service. When there is no connection to be made, this method should be used to check that resources are available. For example, the FileMessageDispatcher checks that the directories it will be using are available and readable. The MessageDispatcher should remain in a 'stopped' state even after the doConnect() method is called.
Yes
doDisconnect()
Disconnects and tidies up any resources that were allocated by the doConnect() method. This method should return the MessageDispatcher into a disconnected state so that it can be connected again using the doConnect() method
Yes
doDispose()
Called when the Dispatcher is being disposed and should clean up any open resources.
No
Message Requesters As with message receivers and dispatchers the implementation of a message requester for a transport, if it even applies, will vary greatly. The abstract AbstractMessageRequester provides a base from which to extend and implement your own Message Requester and implemented methods for routing events. Although requesters can implement doConnect} and {{doDisconnect methods given the nature of a requester this can also be done as part of the doRequest implementation, it really depending on the
Document generated by Confluence on Mar 11, 2009 14:57
Page 355
underlying transport and if you need to maintain a connection open all the time or not to be able to make arbitrary requests.
Method Name
Description
Required
doRequest(long)
Used to make arbitrary requests to a transport resource. If the timeout is 0, the method should block until a message on the endpoint is received.
doConnect()
Should make a connection to the underlying transport if required, such as to connect to a socket..
No
doDisconnect()
Disconnects and tidies up any resources allocated using the doConnect() method. This method should return the MessageReceiver in a disconnected state so that it can be connected again using the doConnect() method.
No
doInitialise()
Called when the Requester is being initialized after all properties have been set. Any required initialization can be done here.
No
doStart()
Called when the Requester is started. Any transport specific implementation that is required when the requestor is started should be implemented here.
No
doStop()
Called when the Requester is stopped. Any transport specific implementation that is required when the requestor is stopped should be implemented here.
No
doDispose()
Called when the Requester is being disposed and should clean up any open resources.
No
Threads and Dispatcher Caching Custom transports do not need to worry about dispatcher threading. Unless threading is turned off, the Dispatcher methods listed above will be executed in their own thread. This is managed by the AbstractMessageDispatcher. When a request is made for a dispatcher, it is looked up from a dispatcher cache on the AbstractConnector. The cache is keyed by the endpoint being dispatched to. If a Dispatcher is not found, one is created using the MessageDispatcherFactory and then stored in the cache for later.
Message Adapters Message adapters are usually simple objects that provide a uniform way of accessing a message payload and associated metadata from a format used by the underlying transport. Almost all messaging protocols have the notion of message payload and header properties, which means that a message adapter just needs to allow access to the header properties using standard Map notation. For example:
Document generated by Confluence on Mar 11, 2009 14:57
Page 356
//JMS message ID String id = (String)message.getProperty("JMSMssageID"); //HTTP content length int contentLength = message.getIntProperty("Content-Length");
Note that the property names use the same name that is used by the underlying transport; ContentLength is a standard HTTP header name, and JMSMessageID is the equivalent bean property name on the javax.jms.Message interface. A message adapter should extend org.mule.transport.AbstractMessageAdapter , which implements much of the mundane methods needed by the org.mule.api.transport.MessageAdapter interface. Methods to Implement
Method Name
Description
Required
getPayload()
Returns the message payload 'as is'.
Yes
getUniqueId()
This ID is used by various routers when correlating messages. The superclass supplies a unique value by default, but this method can be overridden to provide an ID recognized by the underlying transport.
No
Service Descriptors Each transport has a service descriptor that describes what classes are used to construct the transport. For complete information, see Transport Service Descriptors.
Coding Standards Following are coding standards to use when creating transports.
Package Structure All Mule transports have a similar package structure. They follow the convention of:
org.mule.transport.<protocol>
Where protocol is the protocol identifier of the transport such as 'tcp' or 'soap'. Any transformers and filters for the transport are stored in either a 'transformers' or 'filters' package under the main package. Note that if a transport has more than one implementation for a given protocol, such as the Axis and CXF implementations of the SOAP protocol, the package name should be the protocol, such as soap instead of axis or cxf.
Document generated by Confluence on Mar 11, 2009 14:57
Page 357
Internationalization Any exceptions messages used in your transport implementation should be stored in a resource bundle so that they can be internationalized . The message bundle is a standard Java properties file and must be located at:
META-INF/services/org/mule/i18n/<protocol>-messages.properties
Document generated by Confluence on Mar 11, 2009 14:57
Page 358
Transport Archetype This page last changed on Feb 24, 2009 by jackie.wheeler.
Transport Archetype [ Configuring Maven ] [ Using the Archetype ] [ The Questions Explained ] [ Example Console Output ] [ Command Line Options ] Mule provides Maven archetypes that you can use as code templates for your Mule projects. These templates include a set of implementation notes and "todo" pointers that help you get started quickly. The Mule transport archetype will help you generate a tailored boilerplate transport project in seconds. For more information on Maven, see Using Maven. If you want to update an existing transport instead of creating a new one, such as adding new schema namespaces and registry bootstrapping to the transport, use the Module Archetype instead. Follow the instructions below to create template files for a new transport, including all the necessary Java boilerplate and detailed implementation instructions in comments.
Configuring Maven Add the following to the file settings.xml (usually in your Maven conf or $HOME/.m2 directory) so that Maven will allow you to execute Mule plug-ins.
<settings> org.mule.tools ...
Using the Archetype First, open a command shell and change to the directory where you want to create your project. > cd yourDir
Next, you execute the archetype and generate the code. If this is your first time running this command, Maven will download the archetype for you. > mvn mule-transport-archetype:create -DtransportId=xxx -DmuleVersion=2.2.0
As of Mule 2.2, the parameter -DtransportId can be replaced with -DartifactId, which is in line with the other Mule archetypes. At minimum, you pass in two system parameters: • artifactId: The short name for the project (such as 'tcp'). This must be a single word in lower case with no spaces, periods, hyphens, etc. For transports this is usually the short protocol name of the underlying transport being connected. • muleVersion: The version of the Mule project archetype you want to use. This will also be the default Mule version used for the generated artifact. The plug-in will ask various questions (described below) and then generate the files. You can also use this plug-in without user prompts by entering all the arguments at the command line. For a full list of arguments that can be passed in, see the Command Line Options.
Document generated by Confluence on Mar 11, 2009 14:57
Page 359
After you have answered all the questions, the archetype creates a directory using the transport name you specified. The directory includes a POM file for building with Maven, a Mule configuration file (src \main\resources\mule-config.xml) that includes the namespaces for the transports and modules you specified and has placeholder elements for creating your first service, and a package.html file under src \main\java using the package path you specified. Lastly, it creates some template files under src\test to help you get started creating a unit test for the transport. A new MULE-README.txt file will be created in the root of your project explaining what files were created.
The Questions Explained The plug-in prompts you to answer several questions about the transport you are writing. These may vary according to the options you select. An example of the output is shown below. Provide a description of what the transport does: You should provide an accurate description of the transport with any high-level details of what you can or cannot do with it. This text will be used where a description of the transport is required. Which version of Mule is this transport targeted at? The version of Mule you want to use for your transport. By default this will default to the version passed in on the command line. Will this project be hosted on MuleForge? If the transport is going to be hosted on MuleForge, additional information will be added to your project for linking to its issue tracker, web site, build server and deployment information. Will this transport have a custom schema for configuring the transport in Xml? All new transports targeted for Mule 2.x should define an XML schema that defines how the transport is configured. If you do not use this option, users will have to use generic configuration to use your transport. Can the transport receive inbound requests? Can this transport receive inbound events? For example, the File transport allows you to listen for files written to a directory. JMS allows you to listen for events being written to a topic or queue. Does the Message Receiver need to poll the underlying resource? To receive a message, some transports must do polling. For example, the File transport must poll a directory to know something has been written there, whereas JMS provides a callback (MessageListener) to deliver the message. This question is asked only if the transport can receive inbound requests. If this transport will have a default inbound transformer, enter the name of the transformer? If the protocol of the application being connected to has its own message type, you can define a default inbound transformer that will be invoked by default when defining endpoints that use this transport. You enter the name of the transformer class (without package name) to generate, such as JmsMessageToObject. Can the transport dispatch outbound requests? Asks whether messages can be written to this transport. With the File transport, you can write file data to a directory, and with JMS you can write to a queue or topic.
Document generated by Confluence on Mar 11, 2009 14:57
Page 360
If this transport will have a default outbound transformer, enter the name of the transformer? If the protocol of the application being connected to has its own message type, you can define a default outbound transformer that will be invoked by default when defining outbound endpoints that use this transport. You enter the name of the transformer class (without package name) to generate, such as ObjectToJmsMessage. Does the transport need a custom MessageAdapter? This is usually only required if the underlying transport has an API that has a message object i.e. JMSMessage or HttpServletRequest. Can the transport request individual messages from the underlying resource? If the transport can request messages from a message channel or resource rather than subscribing to inbound events or polling a resource, answer yes to this question. This will generate a MessageRequester class. Does this transport support transactions? If the underlying resource for this transport is transactional, you can have Mule generate a transaction wrapper that will allow users to enable transactions on endpoints defined using this transport. Does this transport use a non-JTA transaction manager? Not all technologies (such as JavaSpaces) support the standard JTA transaction manager. Mule can still work with different non-JTA transaction managers, and this archetype can generate the necessary stubs for you. What type of endpoints does this transport use? Mule supports a number of well-defined endpoints • • • •
Resource endpoints (e.g., jms://my.queue) URL endpoints (e.g., http://localhost:1234/context/foo?param=1) Socket endpoints (e.g., tcp://localhost:1234) Custom
The Custom option allows you to deviate from the existing endpoint styles and parse your own. Which Mule transports do you want to include in this project? If you are extending one or more existing transports, specify them here in a comma-separated list. Which Mule modules do you want to include in this project? By default, the Mule client module is included to enable easier testing. If you want to include other modules, specify them here in a comma-separated list.
Example Console Output ******************************************************************************** Provide a description of what the transport does: [default: ] ******************************************************************************** [INFO] muleVersion: ********************************************************************************
Document generated by Confluence on Mar 11, 2009 14:57
Page 361
Which version of Mule is this transport targeted at? [default: 2.2.0] ******************************************************************************** [INFO] forgeProject: ******************************************************************************** Will this project be hosted on MuleForge? [y] or [n] [default: y] ******************************************************************************** [INFO] hasCustomSchema: ******************************************************************************** Will this transport have a custom schema for configuring the transport in Xml? [y] or [n] [default: y] ******************************************************************************** [INFO] hasReceiver: ******************************************************************************** Can the transport receive inbound requests? [y] or [n] [default: y] ******************************************************************************** [INFO] isPollingReceiver: ******************************************************************************** Does the Message Receiver need to poll the underlying resource? [y] or [n] [default: n] ******************************************************************************** [INFO] inboundTransformer: ******************************************************************************** If this transport will have a default inbound transformer, enter the name of the transformer? (i.e. JmsMessageToObject) [default: n] ******************************************************************************** [INFO] hasDispatcher: ******************************************************************************** Can the transport dispatch outbound requests? [y] or [n] [default: y] ******************************************************************************** [INFO] outboundTransformer: ******************************************************************************** If this transport will have a default outbound transformer, enter the name of the transformer? (i.e. ObjectToJmsMessage) [default: n] ******************************************************************************** [INFO] hasCustomMessageAdapter: ******************************************************************************** Does the transport need a custom MessageAdapter? [y] or [n] (This is usually only required if the underlying transport has an API that has a message object i.e. JMSMessage or HttpServletRequest) [default: n] ******************************************************************************** [INFO] hasRequester: ******************************************************************************** Can the transport request incoming messages programmatically? [y] or [n] [default: y] ******************************************************************************** [INFO] hasTransactions: ******************************************************************************** Does this transport support transactions? [y] or [n]
Document generated by Confluence on Mar 11, 2009 14:57
Page 362
[default: n] ******************************************************************************** [INFO] hasCustomTransactions: ******************************************************************************** Does this transport use a non-JTA Transaction manager? [y] or [n] (i.e. needs to wrap proprietary transaction management) [default: n] ******************************************************************************** [INFO] endpointBuilder: ******************************************************************************** What type of endpoints does this transport use? - [r]esource endpoints (i.e. jms://my.queue) - [u]rl endpoints (i.e. http://localhost:1234/context/foo?param=1) - [s]ocket endpoints (i.e. tcp://localhost:1234) - [c]ustom - parse your own [default: r] ******************************************************************************** [INFO] transports: ********************************************************************************
Which Mule transports do you want to include in this project? If you intend extending a transport you should add it here: (options: axis,cxf,ejb,file,ftp,http,https,imap,imaps,jbpm,jdbc, jetty,jms,multicast,pop3,pop3s,quartz,rmi,servlet,smtp, smtps,servlet,ssl,tls,stdio,tcp,udp,vm,xmpp): [default: vm] ******************************************************************************** [INFO] modules: ********************************************************************************
Which Mule modules do you want to include in this project? The client is added f or testing: (options: bulders,client,jaas,jbossts,management,ognl,pgp,scripting, spring-extras,sxc,xml): [default: client] ********************************************************************************
Command Line Options By default, this plug-in runs in interactive mode, but it's possible to run it in silent mode by using the following option: -Dinteractive=false
The following options can be passed in:
Name
Example
Default Value
transportId
-DtransportId=tcp
none
description
-Ddescription="some text"
none
Document generated by Confluence on Mar 11, 2009 14:57
Page 363
muleVersion
-DmuleVersion=2.2.0
none
hasCustomSchema
-DhasCustomSchema=true
true
forgeProject
-DforgeProject=true
true
hasDispatcher
-DhasDispatcher=true
true
hasRequester
-DhasRequester=true
true
hasCustomMessageAdapter (Since Mule 2.2)
false DhasCustomMessageAdapter=true
hasTransactions
-DhasTransactions=false
false
version
-Dversion=1.0-SNAPSHOT
<muleVersion>
inboundTransformer
-DinboundTransformer=false
false
groupId
org.mule.transport. DgroupId=org.mule.transport.tcp
hasReceiver
-DhasReceiver=true
true
isPollingReceiver
-DisPollingReceiver=false
false
outboundTransformer
-DoutboundTransformer=false
false
endpointBuilder
-DendpointBuilder=s
r
hasCustomTransactions
-DhasCustomTransactions=false
false
artifactId
-DartifactId=mule-transport-tcp
mule-transport-
transports
-Dtransports=vm,jms
vm
modules
-Dmodules=client,xml
client
Document generated by Confluence on Mar 11, 2009 14:57
Page 364
Transport Service Descriptors This page last changed on Dec 18, 2008 by jackie.wheeler.
Transport Service Descriptors A service descriptor is a file containing properties that describes how the internals of a transport is configured, such as which dispatcher factory to use or which endpoint builder to use. The service descriptor file must have the same name as the protocol of the transport and must be stored in the META-INF directory.
META-INF/services/org/mule/providers/<protocol>.properties
Following are the properties that can be set in a transport service descriptor.
Property
Description
Required
connector
The name of the default connector class to use. This must be an implementation of org.mule.api.transport.Connector .
Yes
dispatcher.factory
The name of the dispatcher No (if inbound only) factory class to use. This must be an implementation of org.mule.api.transport.MessageDispatcherFactory .
requester.factory
The name of the requester No factory class to use. org.mule.api.transport.MessageRequesterFactory .
message.receiver
The name of the message No (if inbound only) receiver class to use. This must be an implementation of org.mule.api.transport.MessageReceiver .
transacted.message.receiver
The name of the message No receiver class to use for transacted messages. Some transports implement a transacted message receiver separately, in which case the MessageReceiver class can be specified here so Mule knows which receiver to use when creating endpoints that are transacted. This must be an implementation of org.mule.api.transport.MessageReceiver
xa.transacted.message.receiver
If the transport supports XA transactions, the name of the XA transacted message receiver implementation to use.
Document generated by Confluence on Mar 11, 2009 14:57
No
Page 365
Some transports implement an XA transacted message receiver separately, in which case the MessageReceiver class can be specified here so Mule knows which receiver to use when creating endpoints that are XA transacted. This must be an implementation of org.mule.api.transport.MessageReceiver . message.adapter
The name of the message No (if outbound only) adapter class to use for this connector when receiving messages. This must be an implementation of org.mule.api.transport.MessageAdapter .
inbound.transformer
The default transformer to No use on inbound endpoints using this transport if no transform has been explicitly set on the endpoint. The property is the class name of a transformer that implements org.mule.api.transformer.Transformer .
response.transformer
The default transformer to use No on inbound endpoints using this transport if no transformer has been explicitly set for the response message flow in Request/Response style messaging. The property is the class name of a transformer that implements org.mule.api.transformer.Transformer .
outbound.transformer
The default transformer to No use on outbound endpoints using this transport if no transform has been explicitly set on the endpoint. The property is the class name of a transformer that implements org.mule.api.transformer.Transformer .
endpoint.builder
The class name of the endpoint Yes builder used to parse the endpoint and create the URI. Mule provides a standard set of endpoint builders such as ResourceNameEndpointURIBuilder used by JMS and VM, SocketEndpointURIBuilder used by TCP, HTTP, and UDP, and UrlEndpointURIBuilder used by SOAP. Custom endpoint builders should extend
Document generated by Confluence on Mar 11, 2009 14:57
Page 366
org.mule.endpoint.AbstractEndpointBuilder . session.handler
The name of the session No handler class to use for reading and writing session information to and from the current message. This must be an implementation of org.mule.api.transport.SessionHandler .
Document generated by Confluence on Mar 11, 2009 14:57
Page 367
Deployment Scenarios This page last changed on Nov 25, 2008 by jackie.wheeler.
Deployment Scenarios [ Embedding Mule in a Java Application or Webapp ] [ Embedding Mule in an Application Server ] [ Using Spring ] [ Using Mule NetBoot ] There are several ways in which you can deploy Mule. The simplest way is from the command prompt, or from a script or IDE. For more information, see Running Mule. Following are additional deployment scenarios:
Embedding Mule in a Java Application or Webapp You can start and stop Mule from a Java application or embed it in a Webapp (such as a JSP or servlet). For details, see Embedding Mule in a Java Application or Webapp.
Embedding Mule in an Application Server You can deploy the Mule JCA Resource Adapter to several J2EE application servers, allowing EJBs to send and receive Mule events. Following are details on specific application servers: • Geronimo: The Geronimo application server uses ActiveMQ as its default JMS provider. For details, see ActiveMQ Integration. • JBoss • WebLogic
Using Spring Mule fully integrates with Spring, allowing you to take advantage of Spring's many features, including support for JNDI and EJB session beans. You can also use Spring remoting to access Mule from an external applications. For details, see Using Mule with Spring.
Using Mule NetBoot Mule NetBoot allows you to start and configure multiple instances of Mule simultaneously using Galaxy. For complete information, see Using Mule NetBoot.
Document generated by Confluence on Mar 11, 2009 14:57
Page 368
Deploying Mule to WebLogic This page last changed on Feb 24, 2009 by jackie.wheeler.
Deploying Mule to WebLogic [ Creating a WebLogic Domain for Mule ] [ Configuring Logging ] [ Setting Up Web.xml ] [ Deploying Mule ] [ Replacing the Mule Configuration File ] This page describes how to deploy the Mule JCA Resource Adapter to the WebLogic Application Server, allowing EJBs to send and receive Mule events. For details on configuring WebLogic JMS in Mule, see WebLogic JMS Integration. These instructions assume you have downloaded and installed WebLogic Application Server version 10.3 and that you have downloaded the Mule JCA Resource Adapter. Note that WebLogic 8.x and 9.x are also supported, but these instructions are specific to version 10.3, both on BEA Weblogic and Oracle WebLogic. Note: You can also deploy the Mule JCA Resource Adapter within an EAR, in which case you follow the same steps but deploy your EAR rather than the RAR. Alternatively, you can deploy Mule embedded in a web application, in which case you will need to configure logging as described below, but you will not need to switch configuration files in the RAR, and you won't use the JCA Resource Adapter, as your web.xml file will define the configuration file to use instead.
Creating a WebLogic Domain for Mule The first step is to create a WebLogic domain for Mule using the BEA WebLogic Configuration Wizard. 1. Launch the Configuration Wizard. For example, on Windows choose Start > All Programs > BEA Products > Tools > Configuration Wizard. 2. In the Welcome screen, select the option to create a new domain and click Next. 3. In the Select Domain Source screen, select the option to generate a domain for WebLogic Server and click Next. 4. In the Configure Administrator Username and Password screen, enter the user name and password you want to use, and then click Next. 5. In the Configure Server Start Mode and JDK screen, select Development Mode, select the Sun SDK 1.5 instead of JRockit, and then click Next. 6. In the Customize Environment and Services Settings screen, leave No selected and click Next. 7. In the Create WebLogic Domain screen, enter Mule2 for the domain name, leave the location set to the default user projects domains directory, and then click Create. Note that you can use whatever domain name you like, but the rest of this page assumes the name Mule2. 8. When the domain has been created, click Done.
Configuring Logging Mule uses Commons logging and Commons lang. Because WebLogic does not include the Commons logging JAR, and because Mule requires a newer version of Commons lang, you must copy these files and modify your classpath so they are used correctly by Mule and WebLogic. For more information on using Commons logging and WebLogic, see http://e-docs.bea.com/wls/docs103/logging/ config_logs.html#wp1015132. 1. Download the Commons logging JAR as a TAR or ZIP file here. 2. Unzip the file and copy commons-logging-api.jar to any location on the WebLogic server classpath, such as APP-INF/LIB or WEB-INF/LIB, or in Mule2/lib under the <WLHome>/ user_projects/domains directory. 3. Copy wlcommons-logging.jar from <WLHome>/server/lib to the same location where you copied commons-logging.jar. 4. Copy commons-lang.osgi-2.4.jar from inside the Mule JCA Resource Adapter RAR file to the Mule2/lib directory under the <WLHome/user_projects/domains directory. You can use any decompression program that supports RAR files to extract the JAR from it, or unpackage the RAR using the jar xvf command, such as: jar xvf muleesb-enterprise-jca-2.1.1.rar 5. In the Mule2EE/bin directory, modify the startWebLogic file so that the
Document generated by Confluence on Mar 11, 2009 14:57
Page 369
commons-lang.osgi-2.4.jar in your Mule2/lib directory is loaded first. For example, on Windows you would modify startWebLogic.cmd and change this line: set CLASSPATH=%CLASSPATH%;%MEDREC_WEBLOGIC_CLASSPATH%...
to this (type it all on one line): set CLASSPATH=%WL_HOME%/user_projects/domains/Mule2/lib/commons-lang.osgi-2.4.jar; %CLASSPATH%;%MEDREC_WEBLOGIC_CLASSPATH%...
6. Configure a system property in WebLogic's startup script by adding the following line after the classpath modification line: set JAVA_OPTIONS=%JAVA_OPTIONS% Dorg.apache.commons.logging.LogFactory=weblogic.logging.commons.LogFactoryImpl
Setting Up Web.xml You must set up your WebLogic web.xml file to enable WebLogic to work with Mule. Open your web.xml file and modify it with the following information: • The class prefix and name of your Mule configuration file • The listener class • The Mule servlet configuration, including the order in which the servlet should be loaded. Typically, set this to a high number so that it is loaded last. For example, the beginning of the file should look similar to this:
<web-app id="WebApp_ID"> <param-name>org.mule.config <param-value>mule-config.xml <listener> <listener-class> org.mule.config.builders.MuleXmlBuilderContextListener <servlet> <servlet-name>muleServlet <servlet-class>org.mule.transport.servlet.MuleReceiverServlet 100 ...
Note: Make sure that the ports you specify in your Mule configuration file are open. You can use netstat -a to verify this.
Deploying Mule There are many ways to deploy applications to the WebLogic server. These instructions demonstrate the two most common approaches: through auto-deployment, which provides a fast method for deploying for testing and evaluation, and through the Administration console, which provides more control over the configuration. Note that this section also applies when deploying an EAR or WAR that embeds Mule to WebLogic, in which case you deploy the EAR or WAR instead of the RAR file.
Document generated by Confluence on Mar 11, 2009 14:57
Page 370
To Auto-deploy Mule: 1. Copy muleesb-enterprise-jca-2.1.2.rar (for Mule Enterprise users) or mule-jca-2.2.0.rar (for Mule Community users) into the <WLHome>/user_projects/domains/Mule2/autodeploy directory. 2. Restart your domain server instance in development mode. During the starting process, the new RAR file will be auto-discovered and deployed by the domain server. To Deploy Mule Using the Administration Console: 1. Start the WebLogic server. For example, on Windows choose Start > BEA Products > WebLogic Server. 2. Start the Admin Server for the Mule2 domain. For example, on Windows you would choose Start > BEA Products > User Projects > Mule2 > Start Admin Server for WebLogic Server Domain. 3. When prompted, log in to the console using the user name and password you specified when creating the domain. If you close the console and need to restart it later, you can go to the URL http://localhost:7001/console/console.portal. 4. In the Domain Structure on the left, click Deployments, and then click Lock & Edit. 5. Click Install, and then navigate to the location where you downloaded the Mule RAR file. 6. Select the RAR file and click Next. 7. Specify that you want to go to the deployment's configuration screen, and then click Finish. 8. In the Change Center on the left, click Activate Change. Mule is now deployed to WebLogic via the Mule JCA Resource Adapter. You must now replace the default configuration file in the RAR file with the configuration file for your Mule application.
Replacing the Mule Configuration File Mule includes a placeholder configuration file called mule-config.xml in the RAR file under mule-modulejca-core-2.2.0.jar. If you simply want to modify this file, you can do the following: 1. Unpackage the RAR and the JAR file. 2. Modify the configuration file. 3. Repackage the JAR and RAR with the updated file and copy the RAR into the <WLHome>/ user_projects/domains/Mule2/autodeploy directory. 4. Run the startWebLogic command. If you want to replace this file, do the following: 1. Unpackage the RAR file and copy your configuration file to the top level where all the JAR files are located. 2. Open the META-INF folder, and then open weblogic-ra.xml for editing. 3. Immediately after the <enable-global-access-to-classes>true entry and right before outbound-resource-adapter, add the following lines, where echoaxis-config.xml is the name of your configuration file:
<properties> <property> Configurations echo-axis-config.xml
4. Repackage the RAR file and deploy it by copying it to the autodeploy directory and running startWebLogic.
Document generated by Confluence on Mar 11, 2009 14:57
Page 371
Embedding Mule in a Java Application or Webapp This page last changed on Dec 05, 2008 by jackie.wheeler.
Embedding Mule in a Java Application or Webapp This page describes how to start and stop Mule from a Java application or to embed it in a Webapp (such as a JSP or servlet), and how to interact with Mule from your code in both scenarios.
Starting Mule from a Java Application To start Mule from any Java application, you can call one of its configuration builders. To use Mule XML configuration:
DefaultMuleContextFactory muleContextFactory = new DefaultMuleContextFactory(); SpringXmlConfigurationBuilder configBuilder = new SpringXmlConfigurationBuilder("mule-config.xml"); muleContext = muleContextFactory.createMuleContext(configBuilder);
Make sure you store a reference to the MuleContext, as you will need it to stop Mule. If you have multiple configuration files, you can provide a comma-separated list or an array of configuration files:
SpringXmlConfigurationBuilder configBuilder = new SpringXmlConfigurationBuilder(new String[] { "mule-config.xml", "another-config.xml" });
You then call the start method to start the server:
muleContext.start();
Stopping Mule from a Java Application To stop Mule, you stop its context like this:
muleContext.stop(); muleContext.dispose();
Embedding Mule in a Webapp To embed Mule inside a webapp, you provide one or more configuration file locations as context params and include a context listener to initialize the Mule Server. If you are using Mule XML configuration, use the following -
<param-name>org.mule.config <param-value>mule-config-main.xml,mule-components.xml <listener> <listener-class>org.mule.config.builders.MuleXmlBuilderContextListener
Document generated by Confluence on Mar 11, 2009 14:57
Page 372
The configuration parameter can be a classpath location or file location. You can also specify multiple configuration files on the classpath or on the file system.
Interacting with Mule from Your Code To interact with the Mule server from your application, JSP, or servlet, you can use the Mule Client.
//create a client MuleClient client = new MuleClient(); //send a jms message asynchronously client.dispatch("jms://my.queue", "some data", null); //or to receive a pop3 message via a configured mailbox MuleMessage message = client.receive("pop3://myInboxProvider", 3000); //or synchonous send a inter-vm message MuleMessage message2 = client.send("vm://my.object", "Some more data", null);
Document generated by Confluence on Mar 11, 2009 14:57
Page 373
JBoss Integration This page last changed on Oct 21, 2008 by jackie.wheeler.
Deploying Mule to JBoss The recommended approach for integrating with enterprise application deployed in JBoss is to deploy Mule as a standalone application and use the Mule EJB Transport or components configured using spring EJB proxies (http://static.springframework.org/spring/docs/2.5.x/reference/ejb.html using to integrate with your EJB's in JBoss. If you need to deploy Mule in the JBoss application server for other reasons (e.g., to use JBoss clustering), use the instructions on this page. Note that if you are using JBoss clustering, you cannot use stateful routers. There are three main approaches you can take to deploying Mule to JBoss: 1. Simple WAR deployment: in this approach, you simply embed Mule in your application and build the WAR. Your custom implementation classes are part of the WAR. 2. EAR application: you can embed the WAR inside the EAR file and include additional files such as EJBs. 3. JCA deployment: you can use the Mule JCA Resource Adapter. The Mule JCA adaptor allows you to use "JCA Message Inflow" to Message Driven Beans (MDB's) and use the Mule "ManagedConnection" for tighter integration when sending message from your Jee application via Mule.
Classloader Isolation When JBoss comes to classloading, unless classloader isolation is specified, JBoss will first try to use its own classes for deployment and only when these are not found will it look for them in the libraries of the deployment file. Since the versions of the libraries used to load Mule are not the same as the ones used by JBoss, various errors such as ClassCastExceptions can appear, so classloading isolation is important. Therefore, for best results, you should use classloader isolation in your JBoss configuration. For more information, see http://wiki.jboss.org/wiki/ClassLoadingConfiguration. If you're using the JCA adapter, and you have other applications running on JBoss, you should use classloader isolation. However, classloader isolation is not supported for JCA deployment on JBoss. Therefore, you must wrap your JCA adapter in an EAR and configure classloader isolation for the EAR.
Building an EAR File for the Deployment of the Mule JCA Resource Adapter on JBoss 4.2.x Although you can deploy the Mule JCA Resource Adapter directly, the best way to deploy Mule on JBoss is to place the resource adapter inside an EAR file. The advantages of this approach over using the Mule JCA Resource Adapter directly are the following: • JBoss allows EAR, WAR, and SAR files to have classloader isolation. This feature is not yet available for the RAR file. • The Mule JCA Resource Adapter contained in the EAR file is specific for JBoss deployment. • In order to avoid deployment issues with JBoss the mule-jboss-ds.xml file has to be moved from the mule-module-jca-jboss-<muleVersion>.jar file up to the EAR level.
Adaptation of the RAR File for Use with the EAR File In mule-jca-jboss-x.rar (where x is the Mule version number), you must remove mule-jboss-ds.xml from mule-module-jca-jboss-2.x.jar. Note that if you are going to repackage mule-jca-jboss-x.rar, repackage it in a simple zip file format instead of other compression formats.
Mule EAR File Structure The file structure of the EAR file should have the following format:
Document generated by Confluence on Mar 11, 2009 14:57
Page 374
META-INF | - application.xml | - jboss-app.xml | - MANIFEST.MF mule-jca-jboss-x.rar mule-jboss-ds.xml
Mule EAR Configuration Files Following are the configuration files for the XML files in the above file structure: mule-jboss-ds.xml
<jndi-name>mule/ConnectionFactory my-ear.ear#mule-jca-jboss-2.x.rar org.mule.module.jca.MuleConnectionFactory
The mule-jboss-ds.xml file is an adaptation of the one you removed from mule-module-jcajboss-2.x.jar. Note that because the RAR file is found inside the EAR, the name inside the tag should be the EAR file name and the RAR file name separated by the # symbol. This will be your data source. application.xml
mule-ear <description>EAR packaging for Mule Resource Adapter <module> mule-jca-jboss-2.x.rar
This file is required for telling the EAR file to use mule-jca-jboss-2.x.rar as a connector, allowing it to be deployed as a resource adapter. jboss-app.xml The following configuration file creates a loader-repository that loads the classes during the classloading operation. The java2ParentDelegation property must be set to false to enable classloader isolation. The configuration specifies mule-jboss-ds.xml as a service to be loaded.
Document generated by Confluence on Mar 11, 2009 14:57
Page 375
<jboss-app> org.mule:loader=mule-ear-2.1.0.ear java2ParentDelegaton=false <module> <service>mule-jboss-ds.xml
Deploying Your Application The resource adapter comes configured with a dummy mule-config.xml file, which you will replace with your own configuration file. You can physically replace the mule-config.xml file in the Mule JCA Resource Adapter (mule-module-jca-core-2.x.jar) with your own, but if your POJOs are bundled in a JAR, you can take the following more elegant approach: 1. Put the resource files (xslt, properties, etc.) in your JAR file (these should be picked up automatically when Mule starts) 2. Create a folder in the root of the mule-jca-jboss-2.x.rar file and put your Mule configuration in there. For the time being, let's call this folder "conf". 3. Edit the ra.xml file found in the mule-jca-jboss-2.x.rar META-INF folder and reference your configuration file name as seen below. Alternatively you can put your jar files with classes/resources that will be used by mule in your EAR, but in order to do this you will need to add a "Class-Path" entry in the rar's MANIFEST.MF referencing the required libraries.
Configurations java.lang.String conf/my-config1.xml
The should contain a list of configuration files separated by a comma. The "conf/" is the path name telling the loader to look at the conf folder found in the root of the RAR file. If only the name of the configuration file is given, the loader will only look for the configuration file inside the mule-module-jca-core-2.x.jar.
JBoss MQ Configuration For information on configuring a JBoss JMS connector, see JBoss Jms Integration.
Scenarios your User Application with Mule in JBoss For this scenario, the deployment is very simple: you simply add your own JAR and WAR archives to you EAR file. Because everything will be deployed in the same EAR, all the classes required by both the user application and Mule share the same classloader. However sometimes other classes may be required that are not deployed within your EAR..
Resolving Cross-dependencies The situation becomes more complex when you want to deploy Mule-dependent code in a separate EAR file (for example, you have a custom transformer that extends Mule's AbstractTransformer class). The user EAR depends on the Mule libraries to be loaded to be able to load the custom transformer library, while Mule expects the user EAR to be loaded to be able to use the transformer class that is found in the user EAR. To solve these cross-dependencies, you can create a shared library (in another EAR file, perhaps) and specify the library in the element of the jboss-app.xml file in
Document generated by Confluence on Mar 11, 2009 14:57
Page 376
both the Mule EAR and the user EAR. Mule Enterprise Edition users can see an example of this in the Knowledge Base article titled "Embedding in JBoss: How to Share Classes Between Your Mule EE EAR and Another Application".
Document generated by Confluence on Mar 11, 2009 14:57
Page 377
Mule as MBean This page last changed on Nov 25, 2008 by jackie.wheeler.
Mule as MBean [ Creating a Simple MBean ] [ Creating JBoss Service Descriptor ] [ Deploying MBean to JBoss ] [ Copy the Dependencies ] [ References ] An MBean is a named managed object representing a resource in an JMX environment. You can easily deploy an MBean with Mule by taking the following steps: 1. 2. 3. 4.
Create an MBean Create service descriptor Deploy MBean (as .sar) to application server Copy dependencies to the service's classpath
This page describes these steps using the JBoss application server.
Creating a Simple MBean To create an MBean, you need an interface and an implementation:
package foo.mbean; public interface FooServiceMBean { public String getBar(); public void start(); public void stop(); }
package foo.mbean; import import import import
org.jboss.system.ServiceMBeanSupport; org.mule.config.spring.SpringXmlConfigurationBuilder; org.mule.api.MuleContext; org.mule.api.context.notification.ServerNotification;
public class FooService extends ServiceMBeanSupport implements FooServiceMBean{ public String getBar() { return "bar"; } public void start() { this.getLog().info("MBean being started"); try{ MuleContext context = new DefaultMuleContextFactory().createMuleContext (new SpringXmlConfigurationBuilder("foo-config.xml")); context.registerListener(this); context.start(); } catch(Exception e){ e.printStackTrace(); } this.getLog().info("MBean started"); }
Document generated by Confluence on Mar 11, 2009 14:57
Page 378
public void stop() { this.getLog().info("MBean being stopped"); try { if (context != null) { context.stop(); context.dispose(); // } this.getLog().info("Done stopping Mule MBean Service!"); } catch (Exception ex) { this.getLog().error("Stopping Mule caused and exception!", ex); } } }
The extension of ServiceMBeanSupport is simply to provide you more control over the API provided by JBoss.
Creating JBoss Service Descriptor You must create a service descriptor and add it to to META-INF/. Following is a simple example:
<server> <mbean code="foo.FooService" name="foo:service=Foo">
Deploying MBean to JBoss Based on the examples above, your distribution looks like this: . ./foo ./foo/FooService ./foo/FooServiceMBean ./META-INF ./META-INF/jboss-service.xml
Package the distribution either as a JAR, which you can then rename to a *.sar that you will eventually extract, or as a directory called .sar.
Copy the Dependencies Follow the steps below to copy the dependencies and complete the deployment: 1. Copy your .sar/ directory to JBOSS_HOME/server/default/deploy/. 2. Copy all dependencies of Mule, such as MULE_HOME/lib/*/*.jar to the .sar/ directory 3. Start JBoss. You will see the MBean appears in its MBean console.
Document generated by Confluence on Mar 11, 2009 14:57
Page 379
References • Wikipedia - MBean • The Java Tutorials - Standard MBeans
Document generated by Confluence on Mar 11, 2009 14:57
Page 380
Developing Service Components This page last changed on Dec 02, 2008 by jackie.wheeler.
Developing Service Components [ Entry Point ] [ Default Message Flow Behavior ] [ Customizing the Message Flow Behavior ] [ Component Lifecycle ] When developing service components, you focus on developing code to handle the business logic, not to integrate the service component with Mule. For example, if you are developing a service component that adds customer data to an invoice, you focus on writing code that queries the customer database and updates the invoice as needed. You do not have to write any special code to handle the message that's passed to the service component or to integrate with Mule, as all integration is handled through configuration. You can develop the service component as a POJO, or as a web service using popular containers such as Spring, EJB, or Plexus. Mule does allow you to enable service components to obtain information about or even control the current message instead of just working with the message payload. To enable the service component to work directly with the message, you must implement the Callable() interface in the service component (see Entry Points below). To get started with developing Mule service components, you can use the Mule IDE. The Mule IDE is an Eclipse plug-in that provides an integrated development environment for developing Mule applications. You can also use the standard components provided with Mule, or use them as a starting point for building your own.
Entry Point The entry point is the method in your component that is invoked by Mule when a message is received. To specify the method explicitly on your endpoint, you can use the method argument on the endpoint, such as:
or <ejb:endpoint host="localhost" port="1099" object="SomeService" method="remoteMethod"/>
If you do not specify this argument, Mule uses an entry point resolver to dynamically choose the method to invoke based on the payload type of the message. When the match is found, the method is cached with the parameter types so that introspection is only done once per method for the life of the service. If multiple methods in the component match the payload type, or no method matches, an error is thrown. You can also call a method on the component that has no arguments. Alternatively, your component can implement the org.mule.api.lifecycle.Callable interface. If your component implements this interface, it will override any dynamic resolution and call the interface method implementation instead. For details on configuring entry point resolvers, see Entry Point Resolver Configuration Reference.
Legacy Entry Point Resolver Set The LegacyEntryPointResolverSet that is used if no other resolver is configured. The LegacyEntryPointResolverSet provides generic entry point resolution as follows: 1. Use the "method" attribute as described above, if one is specified (see MethodHeaderPropertyEntryPointResolver ). 2. If the component implements the org.mule.api.lifecycle.Callable lifecycle interface, use the onCall(MuleEventContext) method to receive the message. 3. If the component has a transformer configured for it, the return type for the transformer will be matched against methods on the component to see if there is a method that accepts the
Document generated by Confluence on Mar 11, 2009 14:57
Page 381
transformer return type. If so, this method will be used. Note if there is more than one match, an exception will be thrown. 4. The message type (without transformer) will be matched against methods on the component to see if there is a method that accepts the transformer return type. If so, this method will be used. Note if there is more than one match, an exception will be thrown. 5. If none of the above finds a match, an exception will be thrown and the component registration will fail. There are many scenarios where the LegacyEntryPointResolverSet is unsuitable. More control is available by extending its set of implementations, or by configuring a completely new set. There are several EntryPointResolver implementations, such as org.mule.model.resolvers.CallableEntryPointResolver , org.mule.model.resolvers.MethodHeaderPropertyEntryPointResolver , and org.mule.model.resolvers.ReflectionEntryPointResolver . While these are used in the LegacyEntryPointResolverSet, they can be more comprehensively configured when specified separately.
Calling No-arguments Methods If you want to call a method with no arguments, you can use the org.mule.model.resolvers.NoArgumentsEntryPointResolver . Regardless of the payload of the current message, this resolver looks only for no-argument methods in the component. Additionally, ReflectionEntryPointResolver supports the resolution of no-argument service methods if the payload received is of type NullPayload.
Custom Entry Point Resolver If you want to create your own entry point resolver, you create a class that implements the EntryPointResolver interface and specify it with the <custom-entry-point-resolver> element in your Mule configuration.
Default Message Flow Behavior Mule has some default behavior rules about managing message flow to and from your component. 1. When a message is received, the entry point method is invoked as described above. 2. The response or outbound message is obtained as follows: • If the method invoked is not void, (that is, Callable.onEvent() returns an Object), the method return value is used. If null is returned, no further processing is done for the current request. • If the method is void, the parameters used to invoke the method are used. This assumes that the parameters themselves were altered or there was no change to the message. 3. If the inbound endpoint used in synchronous then the result of the component invocation is returned to caller. 4. The outbound message is then routed according the services configuration: See Mule Messaging Styles for more detail about the different configuration options that affect message flow.
Customizing the Message Flow Behavior To customize the message flow behavior, you must get a reference to org.mule.api.MuleEventContext . You can get the reference by implementing the Callable interface, which passes the event context as a parameter on this interface:
public interface Callable { public Object onCall(MuleEventContext eventContext) throws Exception; }
Document generated by Confluence on Mar 11, 2009 14:57
Page 382
From the MuleEventContext, you can send and receive events synchronously and asynchronously, manage transactions, and override the default event flow behavior. For example:
MuleEventContext context = RequestContext.getEventContext(); OutboundEndpoint endpoint = ... //to send asynchronously context.dispatchEvent(new MuleMessage("IBM:0.01", null), endpoint); //or to request InboundEndpoint endpoint = ... MuleMessage quote = context.request(endpoint, 5000);
Even when you use the event context to manually control event flow, when your method returns, Mule will route the outbound event as normal. You can stop Mule processing events further as follows: • If your service method is not void, you can return null. This approach tells Mule there is no further event information to process. • If your service method is void, Mule will use the inbound message payload as the outbound message payload. You can override this behavior using the setStopFurtherProcessing method as described below.
Halting Message Flow To halt the message flow, you can either call setStopFurtherProcessing() from the MuleEventContext or else throw an exception. This will cause the ExceptionStrategy on the component to be invoked. Note: The use of additional services or the use of component bindings is much preferred to the above techniques to control message flow from within your component implementation. This is because it allows for a much more decoupled implementation that can be modified via your configuration file and avoids the need to use Mule API in your component implementations. To take this approach, do one of the following: • Ensure your service components are implemented in such a way that they do a single unit of work that do not need to do any message sending/receiving. This additional sending/receiving/routing is then done using Mule services. • Design your component in such a way that interface methods can be mapped to outbound endpoints and then use bindings to map these in configuration. For information on how to configure bindings, see Configuring Java Components.
Component Lifecycle Your component can implement several lifecycle interfaces. The lifecycle flow typically looks like this, with onCall() often being replaced by an entry point resolver as described above:
Document generated by Confluence on Mar 11, 2009 14:57
Page 383
Following are the most commonly used interfaces: • org.mule.api.lifecycle.Initialisable is called only once for the lifecycle of the component. It is called when the component is created when the component pool initializes. • org.mule.api.lifecycle.Startable is called when the component is started. This happens once when the server starts and whenever the component is stopped and started either through the API or JMX. • org.mule.api.lifecycle.Stoppable is called when the component is stopped. This happens when the server stops or whenever the component is stopped either through the API or JMX. • org.mule.api.lifecycle.Disposable is called when the component is disposed. This is called once when the server shuts down. For more information, see the org.mule.api.lifecycle Javadocs . If your custom component already has its own lifecycle methods, possibly implementing your own API, or you just prefer not to depend on Mule's, you can implement and configure a LifecycleAdaptorFactory to map Mule's lifecyle to your component's lifecycle. To do this, you implement your own org.mule.api.component.LifecycleAdaptorFactory and org.mule.api.component.LifecycleAdaptor . See Configuring Java Components for information on how to configure a custom life-cycle adaptor factory.
Document generated by Confluence on Mar 11, 2009 14:57
Page 384
Entry Point Resolver Configuration Reference This page last changed on Feb 20, 2009 by jackie.wheeler.
Entry Point Resolver Configuration Reference This page provides details on the elements you configure for entry point resolvers and entry point resolver sets. This information is pulled directly from mule.xsd and is cached. If the information appears to be out of date, refresh the page.
Entry Point Resolver Sets <entry-point-resolver-set ...> An extensible set of entry point resolvers. These determine how a message is passed to a component in Java. Each entry point resolver is tried in turn until one succeeds in delivering the message to the component. This element can be set on the model or component; the model value provides a default that individual component values can override.
Attributes Child Elements
Name
Type
Required
Name
Cardinality
Description
abstract-entrypoint-resolver
0..*
A placeholder for an entry point resolver element. Entry point resolvers define how payloads are delivered to Java code by choosing the method to call.
Default
Description
An extensible set of entry point resolvers (which determine how a message is passed to a component in Java) that already contains resolvers to implement the standard logic. This is already provided by default and is only needed explicitly if it will be extended with other entry point resolvers. This element can be set on the model or component; the model value provides a default that individual component values can override.
Document generated by Confluence on Mar 11, 2009 14:57
Page 385
Attributes Child Elements
Name
Type
Required
Name
Cardinality
Description
abstract-entrypoint-resolver
0..*
A placeholder for an entry point resolver element. Entry point resolvers define how payloads are delivered to Java code by choosing the method to call.
Default
Description
<custom-entry-point-resolver-set ...> A custom entry point resolver set. This allows user-supplied code to determine how a message is passed to a component in Java. This element can be set on the model or component; the model value provides a default that individual component values can override.
Attributes
Name class
Type
Required
class name
Default
no
Description An implementation of the EntryPointResolverSet interface.
Child Elements
Name
Cardinality
spring:property
0..*
Description
Entry Point Resolvers An entry point resolver for components that implement the Callable interface. This passes a MuleEventContext to the component. This element can be set on the model or component; the model value provides a default that individual component values can override. This element can also be used directly or as part of a set of resolvers; the resolvers in a set are used in turn until one is successful.
Document generated by Confluence on Mar 11, 2009 14:57
Page 386
Attributes Child Elements
Name
Type
Required
Name
Cardinality
Description
Default
Description
<custom-entry-point-resolver ...> A custom entry point resolver. This allows user-supplied code to determine how a message is passed to a component in Java. This element can be set on the model or component; the model value provides a default that individual component values can override. This element can also be used directly or as part of a set of resolvers; the resolvers in a set are used in turn until one is successful.
Attributes
Name class
Type
Required
class name
Default
no
Description An implementation of the EntryPointResolver interface.
Child Elements
Name
Cardinality
spring:property
0..*
Description
<property-entry-point-resolver ...> Uses a message property to select the component method to be called. This element can be set on the model or component; the model value provides a default that individual component values can override. This element can also be used directly or as part of a set of resolvers; the resolvers in a set are used in turn until one is successful.
Attributes
Name transformFirst
Type
Required boolean
Document generated by Confluence on Mar 11, 2009 14:57
no
Default
Description Whether the message should be transformed before being delivered to the component. By default, messages are transformed.
Page 387
acceptVoidMethods
property
boolean
no
Whether the resolver should call void methods. By default, void methods are not considered as possible candidates for message delivery.
name (no spaces)
no
The name of the message property used to select a method on the component.
Child Elements
Name
Cardinality
Description
<method-entry-point-resolver ...> Delivers the message to a named method. This element can be set on the model or component; the model value provides a default that individual component values can override. This element can also be used directly or as part of a set of resolvers; the resolvers in a set are used in turn until one is successful.
Attributes
Name
Type
Required
Default
Description
transformFirst
boolean
no
Whether the message should be transformed before being delivered to the component. By default, messages are transformed.
acceptVoidMethods
boolean
no
Whether the resolver should call void methods. By default, void methods are not considered as possible candidates for message delivery.
Child Elements
Name
Cardinality
Description
include-entry-point
1..*
A possible method for delivery.
Document generated by Confluence on Mar 11, 2009 14:57
Page 388
Generates a list of candidate methods from the component via reflections. This element can be set on the model or component; the model value provides a default that individual component values can override. This element can also be used directly or as part of a set of resolvers; the resolvers in a set are used in turn until one is successful.
Attributes
Name
Type
Required
Default
Description
transformFirst
boolean
no
Whether the message should be transformed before being delivered to the component. By default, messages are transformed.
acceptVoidMethods
boolean
no
Whether the resolver should call void methods. By default, void methods are not considered as possible candidates for message delivery.
Child Elements
Name
Cardinality
Description
exclude-object-methods
0..1
If specified, methods in the Java Object interface are not included in the list of possible methods that can receive the message.
exclude-entry-point
0..*
Explicitly excludes a named method from receiving the message.
<array-entry-point-resolver ...> Delivers the message to a method that takes a single array as argument. This element can be set on the model or component; the model value provides a default that individual component values can override. This element can also be used directly or as part of a set of resolvers; the resolvers in a set are used in turn until one is successful.
Document generated by Confluence on Mar 11, 2009 14:57
Page 389
Attributes
Name
Type
Required
Default
Description
transformFirst
boolean
no
Whether the message should be transformed before being delivered to the component. By default, messages are transformed.
acceptVoidMethods
boolean
no
Whether the resolver should call void methods. By default, void methods are not considered as possible candidates for message delivery.
enableDiscovery
boolean
no
true
If no method names are configured, attempts to discover the method to invoke based on the inbound message type.
Child Elements
Name
Cardinality
Description
exclude-object-methods
0..1
If specified, methods in the Java Object interface are not included in the list of possible methods that can receive the message.
exclude-entry-point
0..*
Explicitly excludes a named method from receiving the message.
include-entry-point
0..*
A possible method for delivery.
<no-arguments-entry-point-resolver ...> Calls a method without arguments (the message is not passed to the component).
Document generated by Confluence on Mar 11, 2009 14:57
Page 390
Attributes
Name
Type
Required
Default
Description
transformFirst
boolean
no
Whether the message should be transformed before being delivered to the component. By default, messages are transformed.
acceptVoidMethods
boolean
no
Whether the resolver should call void methods. By default, void methods are not considered as possible candidates for message delivery.
enableDiscovery
boolean
no
true
If no method names are configured, attempts to discover the method to invoke based on the inbound message type.
Child Elements
Name
Cardinality
Description
exclude-object-methods
0..1
If specified, methods in the Java Object interface are not included in the list of possible methods that can receive the message.
exclude-entry-point
0..*
Explicitly excludes a named method from receiving the message.
include-entry-point
0..*
A possible method for delivery.
A possible method for delivery.
Document generated by Confluence on Mar 11, 2009 14:57
Page 391
Attributes
Name method
Type
Required name
Default
no
Description The name of the method.
Child Elements
Name
Cardinality
Document generated by Confluence on Mar 11, 2009 14:57
Description
Page 392
Error Handling This page last changed on Mar 06, 2009 by jackie.wheeler.
Error Handling [ Exception Strategies ] [ Using the Exception-based Router ] [ Using the Exception Type Filter ] Mule provides several ways to handle errors. You can set exception strategies for models, components, and connectors. You can use the exception router to specify where the message goes when an error occurs. You can also use the exception type filter for fine-grained control. This page describes the various error-handling techniques. For information on setting retry policies, which control how a connector behaves when its connection fails, see Configuring Retry Policies.
Exception Strategies Exception strategies are used to handle exception conditions when an error occurs during the processing of a message. Exception strategies are used by components and connectors. You can set a common exception strategy for all components in a model by configuring the exception strategy on that model. Cannot resolve external resource into attachment. Exception strategies associated with components or the model are used to handle component exceptions. These are typically business logic exceptions. Typically, you customize the exception handler to control how component exceptions are logged and routed. Exceptions strategies associated with the connector handle exceptions thrown when messages are received or sent using a connector. Typically, you do not need to customize connector strategies, but you can configure them to route exceptions to a common error queue. For details on configuring exception strategies, see Exception Strategy Configuration Reference.
Model and Component Exception Strategies The default exception strategy used by the model (and thus all components managed by the model) is org.mule.service.DefaultServiceExceptionStrategy , which you configure with the <default-serviceexception-strategy> element. To configure it at the model level, add the element before the services:
<model name="CreditCheck"> <default-service-exception-strategy> <service> ... <service> ...
To configure it on a service, add it at the end of the service:
<model name="CreditCheck"> <service> ... <default-service-exception-strategy>
Document generated by Confluence on Mar 11, 2009 14:57
Page 393
You set an endpoint on an exception strategy to forward the message that failed to a destination such as an error queue. To implement your own strategy, your class can extend org.mule.AbstractExceptionListener , but a recommended approach is to extend org.mule.service.DefaultServiceExceptionStrategy and just overload the defaultHandler() method. You can set bean properties on your custom exception strategy in the same way as other Mule-configured objects using a <properties> element. It is up to the defaultHandler() method to do all necessary processing to contain the exception, so an exception should never be thrown from an exception strategy. The exception strategy must manage fatal errors. For example, if an error queue is being used but the dispatch fails, you might want to stop the current component and fire a server notification to alert a system monitor and write the event to file. If you want to change the way exceptions are logged, override the logException() method from org.mule.AbstractExceptionListener .
Connector Exception Strategies The default exception strategy used by a connector is org.mule.DefaultExceptionStrategy , which you configure with the <default-exception-strategy> element. This strategy simply logs exceptions and continues. The exceptions this strategy must handle are typically connection-related exceptions that may or may not be recoverable.
Using the Exception-based Router When an exception occurs, the exception-based router org.mule.routing.outbound.ExceptionBasedRouter determines where the message goes. You can have multiple endpoints specified on the exception-based router, so that if the first endpoint fails with a FatalConnectionException, the next endpoint is tried, and then the next. If all endpoints fail, an org.mule.api.routing.RoutingException is thrown. Note that the exception-based router will override the endpoint mode to synchronous while looking for a successful send, and it will resort to using the endpoint's mode for the last item in the list. Following is an example of configuring the exception-based router:
<exception-based-router>
For more information on routers, see Using Message Routers.
Using the Exception Type Filter You can use the exception type filter to gain fine-grained control over messages that produce errors. For example, assume you want a synchronous flow where the message is sent to a validation service, and then if it fails validation, the message and its exception are forwarded to another service AND the message and its exception are returned to the caller. You could achieve this using a chaining router and the <exception-type-filter> as follows:
<exception-type-filter expectedType="java.lang.Exception"/>
Document generated by Confluence on Mar 11, 2009 14:57
Page 394
For more information on filters, see Using Filters.
Document generated by Confluence on Mar 11, 2009 14:57
Page 395
Functional Testing This page last changed on Feb 27, 2009 by jackie.wheeler.
Functional Testing [ FunctionalTestCase ] [ FunctionalTestComponent ] [ Additional Features ] [ Additional Example: Event Callback With a Spring Component ] [ Test Component Configuration Reference ] [ Component ] [ Web Service Component ] Because Mule is light-weight and embeddable, it is easy to run a Mule Server inside a test case. Mule provides an abstract JUnit test case called org.mule.tck.FunctionalTestCase that runs Mule inside a test case and manages the lifecycle of the server. The org.mule.tck.functional package contains a number of supporting classes for functionally testing Mule code, including FunctionalTestComponent . These classes are described in more detail in the following sections.
FunctionalTestCase FunctionalTestCase is a base test case for Mule functional tests. Your test cases can extend FunctionalTestCase to use its functionality. FunctionalTestCase fires up a Mule server using a configuration you specify by overriding the getConfigResources():
protected String getConfigResources() { return "mule-conf.xml"; }
You can use the method getConfigResources to specify a configuration file or commaseparated list of configuration files to use. All configuration files must exist in your classpath. You then create tests that interact with the Mule server. FunctionalTestCase extends junit.framework.TestCase, so JUnit the framework for creating and running your test cases. For example, this simple test would send a message to a vm endpoint .
public void testSend() throws Exception { MuleClient client = new MuleClient(); String payload = "foo"; MuleMessage result = client.send("vm://test", new DefaultMuleMessage(payload)); assertEquals("foo Received", result.getPayloadAsString()); }
Notice the use of MuleClient to interact with the running Mule server. MuleClient is used to send messages to and receive messages from endpoints you specify in your Mule configuration file (muleconf.xml in this case). The example mule-conf.xml file used in this example is shown below:
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:spring="http://www.springframework.org/schema/beans" xmlns:vm="http://www.mulesource.org/schema/mule/vm/2.2" xmlns:test="http://www.mulesource.org/schema/mule/test/2.2"
Document generated by Confluence on Mar 11, 2009 14:57
Page 396
xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/springbeans-2.5.xsd http://www.mulesource.org/schema/mule/core/2.2 http://www.mulesource.org/schema/mule/core/2.2/ mule.xsd http://www.mulesource.org/schema/mule/vm/2.2 http://www.mulesource.org/schema/mule/vm/2.2/ mule-vm.xsd http://www.mulesource.org/schema/mule/test/2.2 http://www.mulesource.org/schema/mule/test/2.2/ mule-test.xsd"> <model name="TestComponentModel"> <service name="TestComponentService">
Watchdog Timeout The base test case class includes a watchdog timeout feature that times out your functional test after 60 seconds. To change this setting, add -Dmule.test.timeoutSecs=XX either to the mvn command you use to run Mule or to the JUnit test runner in your IDE.
FunctionalTestComponent The previous example of FunctionalTestCase covers many common (synchronous) test scenarios, where the service responds directly to the caller. FunctionalTestComponent can help support richer tests, such as: 1. Simulating asynchronous communication 2. Returning mock data to the caller 3. Common scenarios such as forced exceptions, storing message history, appending text to responses, and delayed responses. The component includes two methods: the onCall method and the onReceive method that basically do the same thing. • onCall: receives a MuleEventContext as input and returns an Object. • onReceive: receives an Object as input and returns an Object. In both methods, FunctionalTestComponent takes the message that is passed to it (either from the MuleEventContext or from the Object) and transform it into a String. It then creates a message and sends it back to the caller. It also checks whether any of its properties are set and acts accordingly.
Asynchronous Tests with FunctionalTestComponent The FunctionalTestComponent supports two event mechanisms for responding to a caller asynchronously: event callbacks and notifications. Both event callbacks and notifications fire events that get handled by registered listeners. During functional testing, the listener will typically be a class accessible in the FunctionalTestCase. Event Callbacks User-defined event callbacks get called when the test component is invoked. Following is an example of a test case and Mule configuration that uses callbacks:
public void testEventCallback() throws Exception
Document generated by Confluence on Mar 11, 2009 14:57
Page 397
{ EventCallback callback = new EventCallback() { public void eventReceived(MuleEventContext context, Object component) throws Exception { System.out.println("Thanks for calling me back"); } }; muleContext.getFunctionalTestComponent("TestComponentService").setEventCallback(callback); MuleClient client = new MuleClient(); client.send("vm://test", new DefaultMuleMessage("foo"));
}
In this example, the eventReceived callback method is invoked as soon as the FunctionalTestComponent receives the message, and a message is printed to the console. Test assertions could be made in this method. The corresponding Mule configuration used in this example is as follows:
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:spring="http://www.springframework.org/schema/beans" xmlns:vm="http://www.mulesource.org/schema/mule/vm/2.2" xmlns:test="http://www.mulesource.org/schema/mule/test/2.2" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/springbeans-2.5.xsd http://www.mulesource.org/schema/mule/core/2.2 http://www.mulesource.org/schema/mule/core/2.2/ mule.xsd http://www.mulesource.org/schema/mule/vm/2.2 http://www.mulesource.org/schema/mule/vm/2.2/ mule-vm.xsd http://www.mulesource.org/schema/mule/test/2.2 http://www.mulesource.org/schema/mule/test/2.2/ mule-test.xsd"> <model name="TestComponentModel"> <service name="TestComponentService"> <singleton-object class="org.mule.tck.functional.FunctionalTestComponent"/>
Notice that in this configuration, we did not use the "" element, since we need FunctionalTestComponent to be singleton for the callback to work properly. For an example of an event callback on a Spring component, see the additional example below.
Document generated by Confluence on Mar 11, 2009 14:57
Page 398
Notifications Notifications are an alternative to event callbacks. When an event is received, the FunctionalTestComponent fires a notification informing us that the event has been received. It is up to us to set up a listener (the FunctionalTestNotificationListener) on our test to capture this notification. To do this, we must first make our test case implement the FunctionalTestNotificationListener interface. Then, we must implement the method exposed by this listener, which is onNotification. In the example below, we check notification.getAction to see whether it is the FunctionalTestNotification fired by the FunctionalTestComponent. If it is, we print it out to the console.
public void onNotification(ServerNotification notification) { if (notification.getAction() == FunctionalTestNotification.EVENT_RECEIVED) { System.out.println("Event Received"); } }
Now, in order for our listener to start listening for notifications, we must register it:
muleContext.registerListener(this,"myComponent");
Returning Mock Data from FunctionalTestComponent FunctionalTestComponent can return mock data specified either in a file or embedded in the Mule configuration. For example, to have the FunctionalTestComponent return the message "donkey", you would configure the component as follows:
donkey
To return contents from a file, you could use:
The file referenced should exist on the Mule classpath.
Other Useful Features of FunctionalTestComponent Forcing Exceptions You can use throwException to always return the exception specified by exceptionToThrow, as follows:
Document generated by Confluence on Mar 11, 2009 14:57
Page 399
Storing Message History By default, every message that is received by the FunctionalTestComponent is stored and can be retrieved. If you do not want this information stored, you can set enableMessageHistory to false. For example, if you are running millions of messages through the component, an out-of-memory error would probably occur eventually if this feature were enabled. To enable:
Messages are stored in an ArrayList. To retrieve a stored message, you use the getReceivedMessage method to retrieve it by number (e.g., getReceivedMessage(1) to retrieve the first message stored), or use getLastReceivedMessage to retrieve the last message that was received. You can use getReceivedMessages to return the total number of messages stored. Appending Text to Responses You can use appendString to append text to the response message, as follows:
Delayed Responses You can set waitTime to delay responses from this FunctionalTestComponent. In this example, responses are delayed five seconds:
Disable Inbound Transformer You can set doInboundTransform to false to disable the inbound transformer. For example:
Additional Features The functional package includes several additional classes, such as CounterCallback, a test callback that counts the number of messages received. For complete information, see the org.mule.tck.functional Javadoc.
Document generated by Confluence on Mar 11, 2009 14:57
Page 400
Additional Example: Event Callback With a Spring Component This example is similar to the "Event Callbacks" example above, except the component used here is a Spring component. In this case, we can look up the component using the Spring registry.
public void testEventCallback() throws Exception { EventCallback callback = new EventCallback() { public void eventReceived(MuleEventContext context, Object component) throws Exception { System.out.println("Thanks for calling me back"); } }; ApplicationContext ac = (ApplicationContext)muleContext.getRegistry().lookupObject(SpringRegistry.SPRING_APPLICATION_CONTEXT); FunctionalTestComponent testComponent = (FunctionalTestComponent) ac.getBean("FTC"); testComponent.setEventCallback(callback); MuleClient client = new MuleClient(); client.send("vm://test", new DefaultMuleMessage("foo"));
}
The corresponding Mule configuration would be as follows:
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:spring="http://www.springframework.org/schema/beans" xmlns:vm="http://www.mulesource.org/schema/mule/vm/2.2" xmlns:test="http://www.mulesource.org/schema/mule/test/2.2" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/springbeans-2.5.xsd http://www.mulesource.org/schema/mule/core/2.2 http://www.mulesource.org/schema/mule/core/2.2/ mule.xsd http://www.mulesource.org/schema/mule/vm/2.2 http://www.mulesource.org/schema/mule/vm/2.2/ mule-vm.xsd http://www.mulesource.org/schema/mule/test/2.2 http://www.mulesource.org/schema/mule/test/2.2/ mule-test.xsd"> <spring:bean id="FTC" class="org.mule.tck.functional.FunctionalTestComponent" /> <model name="TestComponentModel"> <service name="TestComponentService"> <spring-object bean="FTC" />
Document generated by Confluence on Mar 11, 2009 14:57
Page 401
Test Component Configuration Reference Following is detailed information about the test components provided in the test framework (muletest.xsd).
Component A component that can be used for testing message flows. It is a configurable component. The return data for the component can be set so that users can simulate a call to a real service. This component can also track invocation history and fire notifications when messages are received.
Attributes of
Name
Type
Required
throwException
boolean
no
Whether the component should throw an exception before any processing takes place.
doInboundTransform boolean
no
Whether the message will be transformed using the transformer(s) set on the inbound endpoint before it gets processed. The default is true.
exceptionToThrow
no
A fully qualified classname of the exception object to throw. Used in conjunction with throwException. If this is not specified, a FunctionalTestException will be thrown by default.
no
Every message that is received by the test component is stored and can be retrieved. If you do not want this information stored, such as if you are running millions of messages through
name (no spaces)
enableMessageHistoryboolean
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 402
the component, you can disable this feature to avoid a potential out of memory error. enableNotifications
boolean
no
Whether to fire a FunctionalTestNotification when a message is received by the component. Test cases can register to receive these notifications and make assertions on the current message.
appendString
string
no
A string value that will be appeneded to every message payload that passes through the component. Note that by setting this property you implicitly select that the message payload will be converted to a string and that a string payload will be returned. The inbound transformer (if any) will get applied first, but if that does not return a string, MuleEventContext.getMessage will be called directly after.
waitTime
long
no
The time in milliseconds to wait before returning a result. All processing happens in the component before the wait begins.
Child Elements of
Name
Cardinality
Description
return-data
0..1
Defines the data to return from the service once it has been invoked. The return data can be located in a file, which you
Document generated by Confluence on Mar 11, 2009 14:57
Page 403
specify using the file attribute (specify a resource on the classpath or on disk), or the return data can be embeddded directly in the XML. callback
0..1
A user-defined callback that is invoked when the test component is invoked. This can be useful for capturing information such as message counts. Use the class attribute to specify the callback class name, which must be an object that implements org.mule.tck.functional.EventCallback.
Web Service Component A component that can be used for testing web services. This component has the same properties as component element, but in addition to implementing org.mule.api.lifecycle.Callable, it also implements org.mule.api.component.simple.EchoService, org.mule.tck.testmodels.services.DateService, and org.mule.tck.testmodels.services.PeopleService. When using this with WS endpoints such as CXF, be sure to set the serviceClass property of the endpoint to the type of service you are using.
Attributes of <web-service-component...>
Name
Type
Required
throwException
boolean
no
Whether the component should throw an exception before any processing takes place.
doInboundTransform boolean
no
Whether the message will be transformed using the transformer(s) set on the inbound endpoint before it gets processed. The default is true.
exceptionToThrow
no
A fully qualified classname of the exception object to throw. Used in conjunction with throwException. If this is not specified, a FunctionalTestException will be thrown by default.
no
Every message that is received
name (no spaces)
enableMessageHistoryboolean
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 404
by the test component is stored and can be retrieved. If you do not want this information stored, such as if you are running millions of messages through the component, you can disable this feature to avoid a potential out of memory error. enableNotifications
boolean
no
Whether to fire a FunctionalTestNotification when a message is received by the component. Test cases can register to receive these notifications and make assertions on the current message.
appendString
string
no
A string value that will be appeneded to every message payload that passes through the component. Note that by setting this property you implicitly select that the message payload will be converted to a string and that a string payload will be returned. The inbound transformer (if any) will get applied first, but if that does not return a string, MuleEventContext.getMessage will be called directly after.
waitTime
long
no
The time in milliseconds to wait before returning a result. All processing happens in the component before the wait begins.
Document generated by Confluence on Mar 11, 2009 14:57
Page 405
Child Elements of <web-service-component...>
Name
Cardinality
Description
return-data
0..1
Defines the data to return from the service once it has been invoked. The return data can be located in a file, which you specify using the file attribute (specify a resource on the classpath or on disk), or the return data can be embeddded directly in the XML.
callback
0..1
A user-defined callback that is invoked when the test component is invoked. This can be useful for capturing information such as message counts. Use the class attribute to specify the callback class name, which must be an object that implements org.mule.tck.functional.EventCallback.
Document generated by Confluence on Mar 11, 2009 14:57
Page 406
Open MQ Integration This page last changed on Feb 09, 2009 by jackie.wheeler.
Open MQ Integration This page describes how to integrate Mule with the Open MQ JMS broker, the community version of Sun Java System Message Queue. It includes examples for configuring a direct connection and a JNDI connection.
Direct Connection To create a direct connection, simply specify the connection factory and JMS connector as follows in your Mule configuration file:
<spring:bean name="connectionFactory" class="com.sun.messaging.ConnectionFactory"/> <jms:connector name="JMSConnector" connectionFactory-ref="connectionFactory" specification="1.1"/>
JNDI Connection To create a JNDI connection, take the following steps: 1. Configure Open MQ using the instructions from Sun here. You must use the Open MQ or Message Queue Administration Console to define the connectionFactory (Factory type topic/queue connection factory) and to configure any Open MQ JMS endpoints you will specify in your Mule configuration file. 2. Configure the JMS connector, Spring beans, and endpoints in your Mule configuration file as follows, ensuring that you include all the tags shown below:
<jms:connector name="jmsConnector" connectionFactory-ref="openMQ" specification="1.1"> <spring:property name="jmsSupport" ref="jndiJmsSupport" /> <spring:beans> <spring:bean name="jndiJmsSupport" class="org.mule.transport.jms.Jms102bSupport"> <spring:constructor-arg ref="jmsConnector" /> <spring:bean name="context" class="javax.naming.InitialContext"> <spring:constructor-arg type="java.util.Hashtable"> <spring:props> <spring:prop key="java.naming.factory.initial">com.sun.jndi.fscontext.RefFSContextFactory <spring:prop key="java.naming.provider.url">file:///C:/pawan/openMQ/mq <spring:bean name="openMQ" class="org.springframework.jndi.JndiObjectFactoryBean"> <spring:property name="jndiName" value="MyTopicConnectionFactory" /> <spring:property name="jndiEnvironment"> <spring:props>
Document generated by Confluence on Mar 11, 2009 14:57
Page 407
<spring:prop key="java.naming.factory.initial">com.sun.jndi.fscontext.RefFSContextFactory <spring:prop key="specifications">1.1 <spring:prop key="java.naming.provider.url">file:///C:/Temp <endpoint name="MyEndPoint" address="jms://topic:my_topic" synchronous="false" connectorref="jmsConnector"/>
3. Copy imq.jar and fscontext.jar from the $OPENMQ_HOME/lib directory to the $MULE_HOME/lib/ user directory.
Document generated by Confluence on Mar 11, 2009 14:57
Page 408
Internationalizing Strings This page last changed on Aug 04, 2008 by jackie.wheeler.
Internationalizing Strings [ Internationalized Messages ] [ Exceptions ] [ Using Custom Message Bundles ] [ Creating Message Instances from your Code ] Mule supports internationalization of exception messages and any other type of string message. Mule has support for the following Languages: • English • Japanese
Internationalized Messages Mule uses the Java ResourceBundle class to load messages from properties files on the classpath based on the current system's locale. Mule provides a full set of messages in English and Japanese only, but there may be additional languages provided in the future. Mule's internationalized messages are represented by the org.mule.config.i18n.Message class. Instances are constructed with a message ID and zero or more message parameters. You can see a list of core messages that Mule provides in META-INF/service/org/mule/i18n/core-messages.properties. You never create instances of Message directly. Instead, you use subclasses of MessageFactory . The messages for Mule's core project are accessible through the org.mule.config.i18n.CoreMessages class. Each of Mule's modules and transports has such a messages class. Its name is equal to the module with Messages appended. For example, for the JMS transport you will use JmsMessages to retrieve messages. The dedicated messages class per module/transport has the following advantages: • • • •
Encapsulation of the message code Client code is not cluttered with Message constructors Client code has typesafe access to its messages Client code is not cluttered with formatting of message parameters. Instead, you handle tihs in the module-specific messages class
Exceptions MuleException is the base class of all Mule checked exceptions and can only be constructed using internationalized messages. To create a message for an exception, you use MuleExtension as follows:
MuleException e = new MuleException(CoreMessages.failedToGetPooledObject()); throw e;
Using Custom Message Bundles When writing Mule extensions or applications that will use the Mule internationalization class, you can supply custom message bundles containing messages specific to your extension or application. You create a resource bundle as follows:
1=Error message one 2=Error message with 2 parameters; param {0} and param {1}
Document generated by Confluence on Mar 11, 2009 14:57
Page 409
...
where the number is the message ID and the actual message comes after. Note that message parameters are specified using '{0}' notation, which is standard when using the Java MessageFormat class. The file should be named x-messages.properties where x is the identifying name for this bundle. You must place this file either in your JAR file under META-INF/services/org/mule/i18n/xmessages.properties or any other location on the classpath. To access the messages of your own resource bundle, you create a subclass of MessageFactory as follows:
public class MyMessages extends MessageFactory { // getBundlePath puts together the correct path (META-INF/services/org/mule/i18n/mymessages.properties) private static final String BUNDLE_PATH = getBundlePath("my"); public static Message errorMessageOne() { return createMessage(BUNDLE_PATH, 1); } public static Message anotherErrorMessage(Object param1, Object param2) { createMessage(BUNDLE_PATH, 2, param1, param2); } }
To load a message from this bundle, pass in the resource bundle name as follows:
Message m = MyMessages.anotherErrorMessage("one", "two"); System.out.pritln(m.toString());
This loads the message with ID 2 from x-messages.properties, formats the message with the parameters "one" and "two", and prints out the message to System.out as follows:
Error message with 2 parameters; param one and param two
Creating Message Instances from your Code If you need Message instances from your custom code (e.g., from a custom transformer), you create them as follows:
Message myMessage = MessageFactory.createStaticMessage("Oops");
Document generated by Confluence on Mar 11, 2009 14:57
Page 410
Introduction to Extending Mule This page last changed on Dec 11, 2008 by jackie.wheeler.
Introduction to Extending Mule [ Creating Extensions ] [ Developing Your Extension ] [ Promoting Your Extension on MuleForge ] [ Internationalizing Mule ] Mule provides a great deal of default functionality that you can use in your implementation. If you need different functionality, you can extend Mule as described on this page.
Creating Extensions There are four types of extensions you can create: projects, modules, transports, and examples. • A project is a stand-alone Mule application, such as the Mule IDE. • A module is a package of related functionality in Mule, such as the XML module, which provides XML-based utilities such as filters and routers. For a list of the available modules you can use, see Using Mule Modules. • A transport is a type of module that carries messages between Mule services via a specific protocol. For a list of the available transports you can use, see Available Transports. • An example is a sample application that you create to help users get up and running more quickly. There are several examples provided with Mule. Mule provides Maven archetypes that create the templates for each of these types of functionality in seconds, including the configuration files, unit tests, and packages: • • • •
Project Archetype Module Archetype Transport Archetype Example Archetype
An archetype acts as a wizard, prompting you to provide input, and then creates template configuration, source, and unit test files. Furthermore, if you run an archetype on an existing project or module you created, it will update it for you. For more information on Maven, see Using Maven. When working with transports, note that you can configure an existing transport, or you can create a new one. The recommended approach is to try to use and configure an existing transport first.
Developing Your Extension After using the Maven archetype to get started, the recommended practice is to use an integrated development environment (IDE) such as Eclipse or IntelliJ to develop your Mule project, transport, module, or example. The Mule IDE allows you to quickly get up and running developing with Mule in Eclipse. For more information, see Using IDEs.
Promoting Your Extension on MuleForge After you have created a new extension, you can submit it as a project on MuleForge. This allows you to share it with the Mule community so you can get feedback on the quality and design of the module before putting it into production. By submitting to MuleForge, you get the benefit of others trying out your module, and others get the benefit of your work. For more information, see About MuleForge.
Document generated by Confluence on Mar 11, 2009 14:57
Page 411
Internationalizing Mule If you will use Mule in countries where English is not spoken, you can extend Mule by internationalizing the strings in the messages and exceptions. Additionally, there are guidelines you should take into consideration to make sure your code handles different locales. For more information, see Internationalizing Strings and Internationalization Guidelines.
Document generated by Confluence on Mar 11, 2009 14:57
Page 412
Introduction to Testing Mule This page last changed on Jul 18, 2008 by jackie.wheeler.
Introduction to Testing Mule This page describes the types of testing you can perform on Mule.
Functional and Unit Tests When you configure and customize Mule, you perform the following types of tests: • Functional testing of your Mule configuration and setup • Unit testing of your simple extensions and customizations • Functional and unit testing of your custom modules and transports Mule provides functional test classes in the org.mule.tck and org.mule.tck.functional packages that allow you to test your configuration as well as your custom modules and transports. For more information, see Functional Testing. Additionally, the Mule test JAR file contains abstract test cases that you can use for unit testing your simple extensions (e.g., AbstractTransformerTestCase and AbstractOutboundRouterTestCase) as well as your custom modules and transports (e.g., AbstractConnectorTestCase, AbstractReceiverTestCase, AbstractDispatcherTestCase, and AbstractEndpointTestCase). For more information, see Unit Testing.
Performance Tests After you have ensured that your setup and configuration are correct and that your customizations are working, you should ensure that your system is performing correctly. You can run Japex benchmark tests to test individual packages. Additionally, the Mule Profiler Pack helps you identify memory leaks in your customizations.
Using MuleForge for Continuous Integration Testing If you host your Mule project on MuleForge, you can take advantage of continuous integration testing. MuleForge projects are configured to be automatically built using Bamboo, a Continuous Integration Build Server from Atlassian. The source code build frequency is set to 30 minutes, while the snapshot build frequency is set to 1 day. You can request that these frequencies be changed for your project. For more information on hosting your project on MuleForge, see the Despot's Guide.
Document generated by Confluence on Mar 11, 2009 14:57
Page 413
Models This page last changed on Oct 03, 2008 by jackie.wheeler.
About Models [ Configuring a Model ] [ Model Interface ] A model is a grouping of services. A model manages the runtime behavior of the service components that a Mule instance hosts. The manner in which these components are invoked and treated is all encapsulated inside the current Mule model.
Configuring a Model To configure a model, you add the <model> element to your Mule configuration file. You then add services within the model. For configuration details, see the Model Configuration Reference.
Model Interface Every Mule model implements the Model interface. This interface represents the behavior of a Mule server and works with the following objects. For a complete list of fields and methods, see in the Model interface org.mule.api.model.Model . Also, see org.mule.model.AbstractModel , which is an abstract class that implements this interface and is the parent for all models.
Object
Description
Name
A string that refers to the name of the model and is set as an attribute in the <model> element. If no name is given, a unique value is generated automatically.
ExceptionListener
The exception strategy to use for the entire model. The exception strategy is used to handle any exceptions that occur when a component is processing a message. For more information on exception strategies, see Error Handling.
EntryPointResolverSet
A set of classes that implement the EntryPointResolver interface. These will be used to determine the entry point for any hosted component when a message is received. You can configure an entry point resolver using the element or configure an entry point resolver set using the element. For more information on entry point resolvers, see Developing Service Components.
LifecycleAdapterFactory
Used by the model to create lifecycle adapters that are needed to translate Mule lifecycle events into messages that components registered with the model understand. You configure the lifecyle adapter on the elements, not on the model itself. For more information on lifecycle adapters, see Developing Service Components.
Document generated by Confluence on Mar 11, 2009 14:57
Page 414
Mule Agents This page last changed on Feb 24, 2009 by jackie.wheeler.
Using Mule Agents [ Configuring an Agent ] [ Creating Custom Agents ] An agent is a service that is associated with or used by Mule but is not a Mule-managed component. Agents have the same lifecycle as the Mule instance they are registered with, so you can initialize and destroy resources when the Mule instance starts or is disposed. Mule provides several agents for JMX support, including notifications and remote management. You can also create custom agents to plug any functionality into Mule, such as running functionality as a background process or embedding a server in Mule.
Configuring an Agent Agents are defined in the Management module. To use an agent, specify the management namespace and schema, and then specify the properties for the agents you want to use. For example:
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.2" ... xmlns:management="http://www.mulesource.org/schema/mule/management/2.2" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/springbeans-2.5.xsd http://www.mulesource.org/schema/mule/core/2.2 http://www.mulesource.org/schema/mule/core/2.2/ mule.xsd http://www.mulesource.org/schema/mule/management/2.2 http://www.mulesource.org/schema/mule/ management/2.2/mule-management.xsd" ...> <management:jmx-default-config port="1098" registerMx4jAdapter="true" /> <management:log4j-notifications logName="myMuleLog" logConfigFile="mule-log.txt"/> <management:chainsaw-notifications chainsawPort="8080" chainsawHost="127.0.0.1" /> <management:publish-notifications endpointAddress="vm://myService" /> ...
For a list of agents provided with Mule and how to configure them, see Jmx Management. You can also create a custom agent as described below.
Creating Custom Agents To create your own agent, your agent class must implement org.mule.api.agent.Agent . You then configure your agent using the <custom-agent> element, which takes two attributes: name specifies a unique name for this agent, and class specifies the class where it's defined. If your agent requires that you pass in properties, you can specify them as name/value pairs. For example:
<management:custom-agent name="test-custom-agent" class="org.mule.tck.testmodels.mule.TestAgent"> <spring:property name="frobbit" value="woggle"/>
Document generated by Confluence on Mar 11, 2009 14:57
Page 415
Document generated by Confluence on Mar 11, 2009 14:57
Page 416
Jmx Management This page last changed on Feb 24, 2009 by jackie.wheeler.
JMX Management [ Using the Default JMX Support Agent ] [ Jmx Default Config ] [ Configuring the JMX Agent ] [ Jmx Server ] [ Remote Management ] [ JMX Notifications Agent ] [ Endpoint Notifications Publisher Agent ] [ Log4J Agent ] [ Log4J Notifications Agent ] [ Chainsaw Notifications Agent ] [ MX4J Adapter ] [ Jmx Mx4j Adaptor ] [ YourKit Profiler ] Java Management Extensions (JMX) is a simple and standard way to manage applications, devices, services, and other resources. JMX is dynamic, so you can use it to monitor and manage resources as they are created, installed, and implemented. You can also use JMX to monitor and manage the Java Virtual Machine (JVM). Each resource is instrumented by one or more Managed Beans, or MBeans. All MBeans are registered in an MBean Server. The JMX server agent consists of an Mbean Server and a set of services for handling Mbeans. There are several agents provided with Mule for JMX support. The easiest way to configure JMX is to use the default JMX support agent.
Using the Default JMX Support Agent You can configure several JMX agents simultaneously using the <jmx-default-config> element. When set, this element registers the following agents: JMX agent RMI registry agent (if necessary) on rmi://localhost:1099 Remote JMX access on service:jmx:rmi:///jndi/rmi://localhost:1099/server Log4J JMX agent, which exposes the configuration of the Log4J instance used by Mule for JMX management • JMX notification agent used to receive server notifications using JMX notifications • (Optional) MX4J adapter, which provides web-based JMX management, statistics, and configuration viewing of a Mule instance • • • •
This element includes the following properties:
Jmx Default Config Attributes of <jmx-default-config...>
Name
Type
Required
Default
Description
registerMx4jAdapter boolean
no
Whether to enable the MX4J adaptor.
host
string
no
The host to bind to. Normally, override this only for multi-NIC servers (default is localhost).
port
port number
no
The port on which the RMI registry will run. This is also used
Document generated by Confluence on Mar 11, 2009 14:57
Page 417
for remote JMX management. Default is 1099.
Child Elements of <jmx-default-config...>
Name
Cardinality
Description
credentials
0..1
A map of username/password properties for remote JMX access. The configuration option delegates to the JmxAgent.
For example:
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:spring="http://www.springframework.org/schema/beans" xmlns:management="http://www.mulesource.org/schema/mule/management/2.2" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd http://www.mulesource.org/schema/mule/core/2.2 http://www.mulesource.org/schema/mule/core/2.2/mule.xsd http://www.mulesource.org/schema/mule/management/2.2 http://www.mulesource.org/schema/mule/management/2.2/mule-management.xsd"> <management:jmx-default-config port="1098" registerMx4jAdapter="true"> <management:credentials> <spring:entry key="jsmith" value="foo"/> <spring:entry key="dthomas" value="bar"/> <spring:entry key="clee" value="pwd"/>
Note: you only specify the port if you don't want to use the default of 1099. The default agent does a lot of useful plumbing for JMX but at the expense of defaulting many parameters. If you need to customize some subsystems, you could either: • Subclass DefaultJmxSupportAgent and override the corresponding createXXX() factory methods. • Disassemble the services provided by this support agent into separate agents and configure them individually.
Configuring the JMX Agent The JMX agent enables the configuration of a local or remote JMX connection to Mule and registers Mule services with the MBean server. You can then use JMX to view the configuration state of the Mule Manager, stop and start the Mule instance, stop and start services, stop/start/resume service components, and query event processing and endpoint routing statistics on individual services or the whole server instance. You configure the JMX agent using the <jmx-server> element. You can set the following properties on the agent.
Document generated by Confluence on Mar 11, 2009 14:57
Page 418
Jmx Server Attributes of <jmx-server...>
Name
Type
Required
Default
Description
server-ref
name (no spaces)
no
locateServer
boolean
no
true
Whether the agent should try locating an MBeanServer instance before creating one.
createServer
boolean
no
true
Whether the agent should create an MBean server if one couldn't be found or locateServer was set to false.
enableStatistics
boolean
no
true
Whether statistics reporting is enabled for the Mule instance.
The mBean server to use.
Child Elements of <jmx-server...>
Name
Cardinality
Description
connector-server
0..1
Configures the remote JMX connector server by specifying the URL and whether to rebind.
credentials
0..1
A map of username/password entries used to authenticate remote JMX access. If not specified, remote access is not restricted.
For example:
<management:jmx-server > <management:connector-server url="service:jmx:rmi:///jndi/rmi://localhost:1099/server" rebind="false" /> <management:credentials> <spring:entry key="jsmith" value="foo" /> <spring:entry key="dthomas" value="bar" />
Note that the JMX domain for the Mule server is taken from the Mule server ID. To set the server ID, you the -M-Dmule.serverId=YOUR_MULE_SERVER_ID system property or set it programatically by calling org.mule.config.DefaultMuleConfiguration.setId().
Document generated by Confluence on Mar 11, 2009 14:57
Page 419
Remote Management You can configure the Mule JMX subsystem for remote management with third-party tools like MC4J. Mule provides an RMI registry agent, which binds to an existing RMI registry or creates a new one on a defined URI. You configure the RMI registry agent using the element. This element has two attributes: serverUri, which you set to the URI of the RMI server (the default is rmi://localhost:1099), and createRegistry, which you set to true if you want to create a new registry instead of binding to an existing one. For example:
<management:rmi-server serverUri="rmi://myServer.com:1099" createRegistry="true" />
JMX Notifications Agent The <jmx-notifications> element configures the JMX notifications agent, which sends JMX server notifications. This element takes the following attributes:
Attribute
Description
ignoreManagerNotifications
Whether to ignore notifications for state changes on the Mule manager such as initializing, starting, and stopping.
ignoreModelNotifications
Whether to ignore notifications for state changes on models such as models initializing, starting, and stopping or components being registered or unregistered.
ignoreComponentNotifications
Whether to ignore notifications for state changes on components such as when a component is started, stopped, paused, or resumed.
ignoreConnectionNotifications
Whether to ignore notifications when a connector attempts to connect to its underlying resource. Notifications are fired when a connection is made, released, or the connection attempt fails.
ignoreSecurityNotifications
Whether to ignore notifications about security.
ignoreManagementNotifications
Whether to ignore notifications for when a request is denied security access.
ignoreCustomNotifications
Whether to ignore notifications fired by objects to custom notification listeners.
ignoreAdminNotifications
Whether to ignore administrative notifications about requests being received by the Mule Admin agent. These are usually trigged by MuleClient calls using the RemoteDispatcher, which proxies calls to a remote server.
ignoreMessageNotifications
Whether to ignore message notifications. These notifications are fired when an event is sent or received in the system. They are very good for
Document generated by Confluence on Mar 11, 2009 14:57
Page 420
tracing, but they create a performance impact, so they should only be used during testing. For example:
<management:jmx-notifications ignoreAdminNotifications="true" ignoreMessageNotifications="true" />
Endpoint Notifications Publisher Agent This agent routes server notifications to a specified endpoint URI. You configure it using the element and specify the endpoint using the endpointAddress attribute. For example:
<management:publish-notifications endpointAddress="vm://myService" />
Log4J Agent The log4j agent exposes the configuration of the Log4J instance used by Mule for JMX management. You enable the Log4J agent using the <jmx-log4j> element. It does not take any additional properties. For example:
<management:jmx-log4j/>
Log4J Notifications Agent The Log4J notifications agent logs server notifications to a file or console using Log4J. You configure this agent using the element. It takes the same attributes as the JMX notifications agent plus two additional attributes: logName, a name used to identify this log, and logConfigFile, the name of the file where you want to output the log messages. The Log4J notifications agent also takes the child element, which takes one or more pairs of severity/eventId attributes. The severity attribute specifies the severity level of the notifications you want to log for the corresponding event ID. The severity level can be DEBUG, INFO, WARN, ERROR, or FATAL. The eventId attribute specifies the type of event to log. The event ID is the notification type plus the action, such as ModelNotification.stop. For example:
<management:log4j-notifications logName="myMuleLog" logConfigFile="mule-log.txt"> <management:level-mapping eventId="ModelNotification.stop" severity="WARN"/>
Chainsaw Notifications Agent The Chainsaw notifications agent logs server notifications to a Chainsaw console. You configure this agent using the element. It takes the same attributes as the JMX notifications agent plus two additional attributes: chainsawHost and {chainsawPort}}, which specify the host name and port of the Chainsaw console.
Document generated by Confluence on Mar 11, 2009 14:57
Page 421
The Chainsaw notifications agent also takes the child element, which takes one or more pairs of severity/eventId attributes. The severity attribute specifies the severity level of the notifications you want to send to the Chainsaw console for the corresponding event ID. The severity level can be DEBUG, INFO, WARN, ERROR, or FATAL. The eventId attribute specifies the type of event to send to the Chainsaw console. The event ID is the notification type plus the action, such as ModelNotification.stop. For example:
<management:chainsaw-notifications chainsawHost="localhost" chainsawPort="20202"> <management:level-mapping eventId="ModelNotification.stop" severity="WARN"/>
MX4J Adapter MX4J is an open source implementation of the JMX technology. The MX4J agent for Mule configures an MX4J HTTP adapter to provide JMX management, statistics, and configuration viewing of a Mule instance. You configure the MX4J agent using the <jmx-mx4j-adaptor> element.
Jmx Mx4j Adaptor Attributes of <jmx-mx4j-adaptor...>
Name
Type
Required
Default
Description
jmxAdaptorUrl
string
no
The URL of the JMX web console. The default is http:// localhost:9999.
login
string
no
The login name for accessing the JMX web console.
password
string
no
The password for accessing the JMX web console.
authenticationMethodnone/basic/digest
no
basic
The type of authentication to perform when the login and password are set: basic (the default), digest, or none.
cacheXsl
no
true
Indicates whether to cache the transformation objects, which speeds-up the process. It is usually set to true, but you can
string
Document generated by Confluence on Mar 11, 2009 14:57
Page 422
set it to false for easier testing. xslFilePath
string
no
Specifies the path of the XSL files used to customize the adaptor's stylesheet. If you specify a directory, it assumes that XSL files are located in the directory. If you specify a .jar or .zip file, it assumes that the files are located inside. Specifying a file system is especially useful for testing.
pathInJar
string
no
If the xslFilePath is a JAR file, specifies the directory in the JAR where the XSL files are located.
Child Elements of <jmx-mx4j-adaptor...>
Name
Cardinality
Description
socketFactoryProperties
0..1
A map containing properties for SSL server socket factory configuration. If this element contains at least one property, the agent will switch to HTTPS connections. These properties will be delegated as is to the agent's HTTP/S adaptor. For a list of available properties, see the MX4J API documentation.
For example:
<management:jmx-mx4j-adaptor jmxAdaptorUrl="https://myjmxserver.com:9999"> <management:socketFactoryProperties> <spring:entry key="keystore" value="/path/to/keystore" /> <spring:entry key="storepass" value="storepwd" />
For security's sake, the management console is accessible from the localhost only. To loosen this restriction, change "localhost" to "0.0.0.0", which allows access from any computer on the LAN. For more information, see the MX4J documentation.
Document generated by Confluence on Mar 11, 2009 14:57
Page 423
MX4J Security You can protect the JMX web console with a user name and password. If the login property has been specified, the authentication scheme is applied. In addition to protecting the console, you can protect the in-transit data using SSL. If the socketFactoryProperties element contains at least one property, the agent switches to HTTPS connections. If this element is omitted from the configuration, the agent will always use HTTP, even if you specify https:// in the jmxAdaptorUrl property.
Viewing Statistics Mule traps many different statistics about the running state of a server and number of events processed. You can view the Mule statistics report in the JMX Management Console by pointing your browser to http://localhost:9999/ and then clicking on any JMX domain name (except for JMImplementation), or go to the Statistics tab and query the JMX domain for statistics from there.
YourKit Profiler This agent exposes the YourKit profiler to JMX to provide CPU and memory profiling. To use this agent, you must configure the element as shown below, and you must install and run the Profiler as described in Profiling Mule.
Document generated by Confluence on Mar 11, 2009 14:57
Page 424
<management:yourkit-profiler />
Document generated by Confluence on Mar 11, 2009 14:57
Page 425
Mule Server Notifications This page last changed on Nov 20, 2008 by jackie.wheeler.
Mule Server Notifications [ Configuring Notifications ] [ Firing Custom Notifications ] [ Notification Interfaces ] [ Registering Listeners Programmatically ] [ Notification Payloads ] Mule provides an internal notification mechanism that you can use to access changes that occur on the Mule Server, such as a service component being added, a Mule Model being initialized, or Mule being started. You can set up your agents or service components to react to these notifications.
Configuring Notifications Message notifications provide a snapshot of all information sent into and out of the Mule Server. These notifications are fired whenever a message is received or sent. These additional notifications have some impact on performance, so they are disabled by default. To enable message notifications, you set the type of messages you want to enable using the <notifications> element in your Mule configuration file. You also register the notification listeners and associate interfaces with specific notifications. For example, first you create beans for the notification listeners, specifying the class of the type of notification you want to receive:
<spring:bean name="componentNotificationLogger" class="org.myfirm.ComponentMessageNotificationLogger"/ > <spring:bean name="endpointNotificationLogger" class="org.myfirm.EndpointMessageNotificationLogger"/>
Next, you specify the notifications you want to receive using the <notification> element, and then register the listeners using the <notification-listener> element:
<notifications> <notification event="COMPONENT-MESSAGE"/> <notification event="ENDPOINT-MESSAGE"/> <notification-listener ref="componentNotificationLogger"/> <notification-listener ref="endpointNotificationLogger"/>
When you specify the COMPONENT-MESSAGE notification, a notification is sent before and after a component is invoked. When you set ENDPOINT-MESSAGE, a notification is sent whenever a message is sent, dispatched, or received on an endpoint. Because the listeners implement the interface for the type of notification they want to receive (for example, the ComponentMessageNotificationLogger class would implement org.mule.api.context.notification.ComponentMessageNotificationListener), the listeners receive the correct notifications. For a list of notification types, see Notifications Configuration Reference. For a list of notification listener interfaces, see Notification Interfaces below.
Specifying a Different Interface If you want to change the interface that is associated with a notification, you specify the new interface with the interface-class and interface attributes:
<notifications>
Document generated by Confluence on Mar 11, 2009 14:57
Page 426
<notification event="COMPONENT-MESSAGE" interface-class="org.myfirm.MyMessageNotifications" interface="myComponentListener"/>
Configuring a Custom Notification If you create a custom notification, you also specify the event-class attribute:
<notifications> <notification event="CUSTOM-MESSAGE" event-class="org.myfirm.MyMessageNotificationsCustomMessage" interface-class="org.myfirm.MyMessageNotifications" interface="myCustomListener"/> ...
Disabling Notifications If you want to block a specific interface from receiving a notification, you specify it with the element. You can specify the notification type (event), event class, interface, and/or interface class to block.
<notifications> ...
Using Subscriptions When registering a listener, you can specify that it only receive notifications from a specific component using the subscription attribute. For example, to specify that the listener only receive notifications from a service component called "MyService1", you would configure the listener as follows:
<notification-listener ref="endpointNotificationLogger" subscription="MyService1"/>
You can also register listeners and filter the subscriptions from your Java code:
MuleServer.getMuleContext().registerListener(listener, "MyService1");
To register interest in notifications from all service components with "Service" in the name, you would use a wildcard string as follows:
MuleServer.getMuleContext().registerListener(listener, "*Service*");
For more information, see Registering Listeners Programmatically below.
Firing Custom Notifications Custom notifications can be fired by objects in Mule to notify custom listeners. For example, a discovery agent might fire a Client Found notification when a client connects.
Document generated by Confluence on Mar 11, 2009 14:57
Page 427
You fire a custom notification as follows:
CustomNotification n = new CustomNotification("Hello"); MuleServer.getMuleContext().fireNotification(n);
Any objects implementing CustomNotificationListener will receive this notification. It's a good idea to extend CustomNotification and define actions for your custom notification type. For example:
DiscoveryNotification n = new DiscoveryNotification(client, DiscoveryNotification.CLIENT_ADDED); MuleServer.getMuleContext().fireNotification(n);
Note that non-system objects in Mule can only fire custom notifications through the manager. Attempting to fire other notifications such as ModelNotification will cause an UnsupportedOperationException.
Notification Interfaces The following table describes the Mule server notifications and the interfaces in the org.mule.api.context.notification class an object can implement to become a listener for that notification. All listeners extend the ServerNotificationListener interface.
Notification
Description
Interface
Component Message Notification
A message was processed by a service component.
ComponentMessageNotificationListener
Connection Notification
A connector connected to its underlying resource or released the connection, or the connection attempt failed.
ConnectionNotificationListener
Custom Notification
Can be fired by objects themselves to custom notification listeners and can be used to customize notifications on agents, service components, connectors, and more.
CustomNotificationListener
Endpoint Message Notification
A message was sent or received from an endpoint.
EndpointMessageNotificationListener
Exception Notification
An exception was thrown.
ExceptionNotificationListener
Management Notification
The state of the Mule instance or its resources have changed.
ManagementNotificationListener
Message Notification
An event was sent or received in the system. These notifications are very good for tracing, but they are not enabled by default because they have an impact on performance.
MessageNotificationListener
Model Notification
The state is changing on a model, such as initializing, starting and stopping, or
ModelNotificationListener
Document generated by Confluence on Mar 11, 2009 14:57
Page 428
service components within the model are being registered or unregistered. Mule Context Notification
An event occurred on the Mule Manager.
MuleContextNotificationListener
Registry Notification
An event occurred on the registry.
RegistryNotificationListener
Routing Notification
A routing event such as an async-reply miss occurred.
RoutingNotificationListener
Security Notification
A request was denied security access.
SecurityNotificationListener
Server Notification
Fired when the server, models, and components stop, start, or initialize.
ServerNotificationListener
Service Notification
An event occurred on a service.
ServiceNotificationListener
Transaction Notification
During transaction life cycle after a transaction has begun, was committed, or was rolled back.
TransactionNotificationListener
The listener interfaces all have a single method:
public void onNotification(ServerNotification notification);
Depending on the listener implemented, only certain notifications will be received. For example, if the object implements ManagerNotificationListener, only notifications of type ManagerNotification will be received. Objects can implement more than one listener to receive more types of notifications.
Registering Listeners Programmatically You can register listeners on the Mule Context as follows:
MuleServer.getMuleContext().registerListener(listener);
If you have local access to the Mule context already (for example, if you created it right before registering the listener), you would simply call registerListener() on the existing context instead of on MuleServer.getMuleContext(). For example:
MuleContext context = new DefaultMuleContextFactory().createMuleContext (new SpringXmlConfigurationBuilder("foo-config.xml")); context.registerListener(listener, "*Service*");
Registering Listeners Dynamically By default, you cannot register listeners in the Mule context after Mule has started. Therefore, you would register your listeners in your code before starting Mule. For example:
Document generated by Confluence on Mar 11, 2009 14:57
Page 429
MuleContext context = new DefaultMuleContextFactory().createMuleContext (new SpringXmlConfigurationBuilder("foo-config.xml")); context.registerListener(listener, "*Service*"); context.start();
To change this behavior so that you can add listeners dynamically at run time, you can set the dynamic attribute on the <notifications> element. If you just want to enable dynamic notifications for a specific connector, you can set the dynamicNotification attribute on the connector.
Notification Action Codes Each notification has an action code that determines the notification type. The action code can be queried in the onEvent method to determine its type. For example, to have an object do something when the model initializes:
public class MyObject implements ModelNotificationListener { public MyObject() { MuleServer.getMuleContext().registerListener(this); } public void onNotification(ServerNotification notification) { if (notification.getAction() == ModelNotification.MODEL_INITIALISED) { system.out.println("The model is initialized!"); } } }
For a list of the action codes available with each notification type, see the Javadocs for the org.mule.context.notification package and click on the class of the notification type you want.
Notification Payloads All notifications extend java.util.EventObject, and the payload of the object can be accessed using the getSource() method. The following table describes the payloads for each type of notification.
Notification
Payload Type
Resource ID
Description
Component Message Notification
Component
Component name
The service component that triggered this notification
Connection Notification
Connectable
.receiver(<endpointor message dispatcher uri>) that was connected
Custom Notification
Any object
Any String
Document generated by Confluence on Mar 11, 2009 14:57
The object type is custom to the object firing the notification
Page 430
Endpoint Message Notification
ImmutableEndpoint
Endpoint URI
The endpoint that triggered this notification
Exception Notification
Throwable
Component Name
The service component that triggered this notification
Management Notification
Object
The object ID
The monitored object that triggered this notification
Message Notification
MuleMessage
Message ID
The message sent or received
Model Notification
Model
Model Name
The Model instance on the Mule Context. Equivalent to calling MuleContext.getRegistry().lookupMod
Mule Context Notification
MuleContext
Mule context ID
The Mule context instance. Equivalent to calling getMuleContext().
Registry Notification
Registry
Mule registry ID
The Mule registry. Equivalent to calling MuleContext.getRegistry().
Routing Notification
MuleMessage
Message ID
The message sent or received
Security Notification
SecurityException
The exception message
The security exception that occurred
Service Notification
Service
Service ID
The service that triggered this notification
Transaction Notification
Transaction
Component name
The component that triggered this notification
Document generated by Confluence on Mar 11, 2009 14:57
Page 431
Profiling Mule This page last changed on Sep 29, 2008 by jackie.wheeler.
Profiling Mule [ Installing the Profiler Pack ] [ Enabling the Profiler Agent ] [ Running the Profiler ] [ Embedded Mule ] The Mule Profiler Pack uses YourKit to provide CPU and memory profiling, helping you identify memory leaks in your custom Mule extensions. The Profiler is useful during development and testing. In your production environment, you should turn off the Profiler because of the high performance overhead. You can also use any other Profiler, such as JProfiler, by adding it as an agent in your configuration.
Installing the Profiler Pack If you are installing Mule Enterprise Edition, simply select the Profiler check box when installing the product. If you are installing Mule Community Edition, go to the downloads page, and under the latest stable community release, expand the Downloads section. You can then click the link to the .zip, .tar, or .gz version of the Profiler pack. After downloading, unpack it on top of the Mule installation.
Enabling the Profiler Agent The Profiler agent exposes the YourKit Profiler to JMX to provide CPU and memory profiling. You configure the Profiler agent with the <management:yourkit-profiler> element. For more information, see Jmx Management.
Running the Profiler To run the profiler, you run Mule with the -profile switch plus any extra YourKit startup options with multiple parameters separated by commas, e.g. -profile onlylocal,onexit=memory. This integration pack will automatically take care of configuration differences for Java 1.4.x and 5.x/6.x.
Embedded Mule If you are running Mule embedded in a webapp, the Profiler configuration is completely delegated to the owning container. Launch YourKit Profiler, Tools -> Integrate with J2EE server... and follow the instructions. Typically, a server's launch script is modified to support profiling, and you then use this modified start script instead of the original.
Document generated by Confluence on Mar 11, 2009 14:57
Page 432
Resource Adapter This page last changed on Nov 12, 2008 by jackie.wheeler.
Mule JCA Resource Adapter The Mule JCA resource adapter enables a Mule instance to be deployed to a J2EE application server. It can be deployed to any JCA 1.5 compliant container. See Deployment Scenarios for links to information about specific application server configurations. You can download the resource adapter here.
EJB Configuration The resource adapter supports inbound and outbound communication.
Outbound Bean Configuration
<session> <description>A stateless session bean that sends a message over a Mule transport SenderEJB <ejb-name>SenderEJB org.mule.samples.ejb.SenderHome org.mule.samples.ejb.Sender <ejb-class>org.mule.samples.ejb.SenderBean <session-type>Stateless Container mule/connectionFactory org.mule.module.jca.MuleConnectionFactory Container Unshareable
Inbound Configuration The endpoint property must be a valid endpoint URI to receive Mule events.
<message-driven> <description>An MDB listening on a Tcp socket TcpReceiverMDB <ejb-name>TcpReceiverMDB <ejb-class>org.mule.samples.ejb.SimpleReceiverMessageBean <messaging-type>org.mule.api.lifecycle.Callable Container endpoint tcp://localhost:12345
Document generated by Confluence on Mar 11, 2009 14:57
Page 433
Suggested Reading This page last changed on Aug 19, 2008 by jackie.wheeler.
Suggested Reading ESB ESB Introduction Part 1 This first article in this series described the basic concepts and role of the Enterprise Service Bus (ESB). It focuses on describing scenarios and issues for ESB deployment to support a Service-Oriented Architecture (SOA). One or more of these scenarios might apply to the SOA and ESB needs of your organization. - by Rick Robinson ESB Introduction Part 2 In Part 2 of this series on the Enterprise Service Bus (EBS), the author describes and analyzes some commonly observed scenarios in which ESBs and other Service-Oriented Architecture (SOA) solutions are implemented. - by Rick Robinson ESB Introduction Part 3 In the third installment of this series, the author examines possible solutions for the various scenarios outlined in Part 2. The ideas on the role of the Bus as explained in Part 1 provide the foundation for the scenarios. - by Rick Robinson The ESB Learning Guide - everything you want to know about ESB is here.
Enterprise Integration Enterprise Integration Patterns: Designing, Building, and Deploying Messaging Solutions - by Gregor Hohpe, Bobby Woolf Provides a consistent vocabulary and visual notation framework to describe large-scale integration solutions across many technologies. It also explores in detail the advantages and limitations of asynchronous messaging architectures.
SEDA SEDA SEDA is an acronym for staged event-driven architecture, and decomposes a complex, event-driven application into a set of stages connected by queues. This design avoids the high overhead associated with thread-based concurrency models, and decouples event and thread scheduling from application logic. Mule uses ideas from SEDA to provide a highly scalable server. An Architecture for Highly Concurrent,Well-Conditioned Internet Services - (PDF) Dissertation by Matt Welsh that introduces SEDA
JBI The Sun JBI Site
Concurrency Java Concurrency in Practice by Brian Goetz Concurrent Programming in Java: Design Principles and Patterns by Doug Lea
Open Source Development Process Producing Open Source Software: How to Run a Successful Free Software Project by Karl Fogel
Document generated by Confluence on Mar 11, 2009 14:57
Page 434
The Cathedral and the Bazaar by Eric Raymond Quality Improvement in Volunteer Free and Open Source Software Projects: Exploring the Impact of Release Management by Martin Michlmayr
Open Source Java The Server Side
Document generated by Confluence on Mar 11, 2009 14:57
Page 435
Third-party Software in Mule This page last changed on Dec 01, 2008 by jackie.wheeler.
Third-party Software Mule products include the following third-party software as part of the source code, examples, or as dependencies. The license type for each third-party software product is indicated in parentheses.
Software
License
Software
License
Acegi
Apache 2.0
Graphviz
CPL 1.0
Antlr
BSD Style
GreenMail
LGPL 2.1
Apache Axis
Apache 2.0
Groovy
Apache 2.0
Apache Axis Jaxrpc
Apache2.0
Hibernate 3.2.2
LGPL 2.1
Apache Catalina
Apache 2.0
Hivemind-1.1.1
Apache 2.0
Apache Cocoon Project
Apache 2.0
Howl-logger-0.1.11
BSD
Http-Client
Apache 2.0
Apache Commons Attributes
Apache 2.0 iHarder Base64
Public Domain/ Permissive
Apache Commons Beanutils
Apache 2.0 IzPack
Apache 2.0
Apache Commons Codec
Apache 2.0
Jakarta Oro
Apache 1.1
Java Scripting API
Sun BCLA
Apache Commons Collections
Apache 2.0 Java Service Wrapper
Tanuki Software/Silver Egg Technology
Apache Commons DBUtils
Apache 2.0 Java UUID Generator
Apache 2.0
Apache Commons Digester
Apache 2.0
Javaassist
MPL 1.1
Apache Commons Discovery
Apache 2.0
JavaDoc for JNDI Container Implementation
BSD Style
Apache Commonslang
Apache 2.0
Jaxen-1.1.1
BSD style
Apache Commonslogging
Apache 2.0
JBoss Business Process Management – JBPM
LGPL 2.1
Apache Commons IO
Apache 2.0
JBoss Transactions
LGPL 2.1
Apache Commons Net
Apache 2.0
JDOM
BSD style license
Apache Derby
Apache 2.0
Jetty 5.1.12
Apache 1.1
Document generated by Confluence on Mar 11, 2009 14:57
Page 436
Apache FtpServer
Apache 2.0
JPEG Library (bundled with GraphViz)
IJG/JPEG Permissive license
Apache Geronimo
Apache 2.0
Apache Jakarta Commons Transaction Source
Apache 2.0
JUnit
CPL 1.0
Libpng (bundled with GraphViz)
Libpng OSI license
Apache Maven
Apache 2.0
Linguine Maps
LGPL 2.1
Apache Tomcat Utility
Apache 2.0
Log4j
Apache 2.0
Apache Xalan
Apache 2.0
Mockobjects
Apache 2.0
Apache XML Security
Apache 2.0
Mx4j 1.2
MX4J License 1.0
Apache Velocity
Apache 2.0
Mx4j-tools
MX4J License 1.0
Apache WebServices Commons
Apache 2.0
Nanocontainer
BSD Style
OGNL
Attribution
Apache Web Services Axis
Apache 2.0 OpenSAML
Apache 1.1
Apache Web Services Project (Wss4j)
Apache 2.0
Picocontainer
BSD
Quartz 1.6
Apache 2.0
Apache Xerces
Apache 2. Retrotranslator
BSD style
Apache XML Commons XML APIs
Apache 2.0 MIT Style
Apache Xpath
Apache 2.0
Simple Logging Facade for Java (SLF4J)
ASM – Bundled with CGLIB
BSD
Smack
Apache 2.0
Apache 2.0
Spring Framework / Modules JBPM
Apache 2.0
Axis-Saaj Project Axis/Web Services
Apache 2.0
StaX
Apache 2.0
Backport-utilconcurrent
Creative Commons Public Domain
Sun JNDI
Sun BCLA
Bouncy Castle License
TrueType Font Library (bundled with GraphViz)
GPL/LGPL
Bouncy Castle Java Cryptography APIs c3p0: JDBC DataSources/Resource Pools
LGPL 2.1
Truststore files
Unknown CPL 1.0
CAROL: Common Architecture for ObjectWeb
LGPL 2.1
Web Services Description Language for Java (wsdl4j) Woodstox
Apache 2.0
Commons-cli-1.0
Apache 1.1
xapool
LGPL 2.1
Cryptix OpenPGP
Cryptix General License
XMLUnit
BSD style
Commons-pool
Apache 2.0
Document generated by Confluence on Mar 11, 2009 14:57
XPP3
Page 437
CGLIB
Apache 2.0
Cryptix
Cryptix General License
Dom4j-1.4
BSD
DTDParser referenced by Linguine Maps
Apache Style
Expat Parser
MIT
FreeType Project, bundled with GraphViz
FreeType License
Document generated by Confluence on Mar 11, 2009 14:57
Indiana University Extreme! Lab Software License XStream
BSD
YourKit Java Profiler
Commercial
ZLIB (bundled with GraphViz)
Zlib license
Page 438
Transaction Management This page last changed on Mar 06, 2009 by jackie.wheeler.
Transaction Management [ Single-resource Transactions ] [ Multi-resource Transactions ] [ XA Transactions ] [ Transaction Manager Lookup ] [ Transaction Coordination ] Mule's transaction framework is agnostic to the underlying transaction manager. The transaction could be a JDBC transaction, XA transaction, or a JMS transaction or message acknowledgment. All transaction types can be handled the same way. Mule transactions are configured on synchronous endpoints, where an endpoint can be configured to start a new transaction or join an existing one. Transactions are configured on an endpoint using , which maps to the org.mule.transaction.MuleTransactionConfig class. This element defines what action an endpoint should take when it receives an event and the transaction factory to use to create transactions. If you have multiple inbound or outbound endpoints in a service and you specify a transaction for one of them, you must specify transactions for all of them. For example, if you have two outbound endpoints and you specify a transaction for the first one, you must also specify a transaction for the second one. For an excellent article on distributed transactions using both XA and non-XA approaches, see http:// www.javaworld.com/javaworld/jw-01-2009/jw-01-spring-transactions.html. The multi-resource transaction support described below maps to the Best Efforts 1PC pattern described in the article. For more details on the elements you configure for transactions, see Transactions Configuration Reference.
Single-resource Transactions Single-resource transactions (also called "local transactions") are transactions that are provided by the underlying resource, such as JDBC transactions and JMS transactions. These kind of transactions can be used to receive and/or send messages using a single resource only. An example configuration for a single-resource transaction might look like this:
<jms:endpoint name="In" queue="test.In" connector-ref="jmsConnector1" /> <jms:endpoint name="Out" queue="test.Out" connector-ref="jmsConnector1" /> ... <jms:transaction action="ALWAYS_BEGIN" /> ... <jms:transaction action="ALWAYS_BEGIN" />
This configuration defines a global JMS endpoint that receives on a "test.In" queue and another global JMS endpoint that sends on a "test.Out" queue. The action attribute tells Mule what to do for each message. In this case, a new transaction will be created for every message received. The outbound endpoint will use the resource enlisted in the current transaction, if one is running. In this case, it will use
Document generated by Confluence on Mar 11, 2009 14:57
Page 439
the same JMS session that has been used to receive the event. When the message has been routed from the inbound endpoint to the outbound endpoint, the transaction will be committed or rolled back. You can send multiple messages using the recipient list router, which will send all messages in the same transaction. You can set action values on the element as follows: • NONE - Never participate in a transaction. • ALWAYS_BEGIN - Always start a new transaction when receiving a message. If a previous transaction exists, it commits that transaction. • BEGIN_OR_JOIN - If a transaction is already in progress when an event is received, join the transaction, otherwise start a new transaction. • ALWAYS_JOIN - Always expects a transaction to be in progress when an event is received. If there is no transaction, an exception is thrown. • JOIN_IF_POSSIBLE - Will join the current transaction if one is available. Otherwise, no transaction is created.
Multi-resource Transactions Multi-resource transactions will be available in Mule Enterprise Edition version 2.2 If you are using Mule Enterprise Edition, you can use the <multi-transaction> element to enable a series of operations from multiple JMS resources to be grouped into a single transaction. Multi-resource transactions work without the overhead of XA. The trade-off is that XA reliability guarantees aren't provided, and your services must be ready to handle duplicates. This is very similar to a 1.5 phase commit concept. Multi-resource transactions are useful for creating transactional non-XA bridges. For example, if you want to bridge two different JMS connectors (such as WebSphere MQ and Active MQ), each of which is running local transactions instead of XA transactions, you could configure the multi-resource transaction as follows:
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:spring="http://www.springframework.org/schema/beans" xmlns:jms="http://www.mulesource.org/schema/mule/jms/2.2" xmlns:ee="http://www.mulesource.org/schema/mule/ee/core/2.2" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/springbeans-2.5.xsd http://www.mulesource.org/schema/mule/core/2.2 http://www.mulesource.org/schema/mule/core/2.2/ mule.xsd http://www.mulesource.org/schema/mule/ee/core/2.2 http://www.mulesource.org/schema/mule/ee/ core/2.2/mule-ee.xsd http://www.mulesource.org/schema/mule/jms/2.2 http://www.mulesource.org/schema/mule/jms/2.2/ mule-jms.xsd > <spring:bean id="mqQueueConnectionFactory" class="com.ibm.mq.jms.MQQueueConnectionFactory"> <spring:property name="queueManager" value="QM_myServer"/> <spring:property name="port" value="1417"/> <spring:property name="hostName" value="172.16.10.0"/> <spring:property name="transportType" value="1"/> <jms:websphere-connector name="jmsWSConnector" connectionFactory-ref="mqQueueConnectionFactory" specification="1.1" username="" password="" numberOfConsumers="16"/>
Document generated by Confluence on Mar 11, 2009 14:57
Page 440
<jms:activemq-connector name="jmsAMQConnector" specification="1.1"/> <model name="Multi-TX Test Model"> <service name="JMSService1"> <jms:inbound-endpoint queue="in" connector-ref="jmsWSConnector"> <ee:multi-transaction action="ALWAYS_BEGIN"/> <pass-through-router> <jms:outbound-endpoint queue="out" connector-ref="jmsAMQConnector" disableTemporaryReplyToDestinations="true"> <ee:multi-transaction action="ALWAYS_JOIN"/>
Because the inbound JMS endpoint has a multi-resource transaction configured on it, any outbound endpoints must also be configured with multi-resource transaction support to become part of the transaction.
XA Transactions You can use XA transactions if you want to enlist multiple managed resources within the same transaction and require 100% reliability. The inbound endpoints are configured in the same manner as for singleresource transactions, but the connectors need to be configured to use XA-enabled resources. If you run Mule outside an application server, you can use JBoss Transaction Manager to configure an embedded transaction manager. Currently, only three transports support XA transactions: • VM Transport • JDBC Transport • JMS Transport The following example of an XA transaction configuration uses a single transaction to read from a JMS queue and write to a database.
<service name="JmsToJdbc"> <jms:inbound-endpoint queue="my.queue" reuseSession="false"/> <xa-transaction action="ALWAYS_BEGIN" timeout="60000"/> <jdbc:outbound-endpoint address="writeTest" type="2"> <xa-transaction action="ALWAYS_JOIN"/>
Document generated by Confluence on Mar 11, 2009 14:57
Page 441
Because the inbound JMS endpoint has an XA transaction configured on it, any outbound endpoints must also be configured with XA transaction support to become part of the XA transaction. This requires that the transport type supports XA transactions. For this configuration to work, you will need to configure a JMS connector that uses a JMS XA Connection Factory and a JDBC connector that is configured to use an XA data source.
Setting the Polling Frequency When you configure an inbound JMS endpoint with XA transactions, the receiver polls every 100 ms. You can change the polling frequency by setting the pollingFrequency property as follows:
<jms:inbound-endpoint queue="my.queue" reuseSession="false"> <xa-transaction action="ALWAYS_BEGIN" timeout="60000"/> <properties> <spring:entry key="pollingFrequency" value="5000"/>
This property is only applicable if you are using the XaTransactedJmsMessageReceiver , which is the default receiver on inbound JMS endpoints that use XA transactions.
Transaction Manager Lookup Mule uses javax.transaction.TransactionManager for managing transaction spanning multiple resources (XA). If you need the SUSPEND semantics for your transactions (which is what EJB's RequiresNew transaction attribute value does), you must use the transaction manager. Conversely, the more typical javax.transaction.UserTransaction is just a thin handle to a transaction manager with limited (though in most cases sufficient) functionality that does not let you suspend the current transaction. Note: Depending on your application server vendor, the transaction manager might be available via JNDI or only through proprietary APIs. The following table summarizes some common Java EE servers:
Application Server
Remote
Embedded
Common Location
Lookup class
JBoss
java:/ org.mule.transaction.lookup.JBo TransactionManager
Weblogic
javax.transaction.TransactionManager org.mule.transaction.lookup.We
WebSphere
Proprietary API call
Resin
java:comp/ org.mule.transaction.lookup.Res TransactionManager
JRun
java:/ org.mule.transaction.lookup.JRu TransactionManager
Document generated by Confluence on Mar 11, 2009 14:57
org.mule.transaction.lookup.We
Page 442
Other
Specified via a jndiName property
org.mule.transaction.lookup.Ge
For example, to use Weblogic's transaction manager, you would configure Mule as follows:
Transaction Coordination Transaction demarcation is set on endpoints. The actual management of transactions is handled by the Mule Transaction Coordinator . Note that any transacted event flows will be synchronous. The Transaction Coordinator is a singleton manager that looks after all the transactions for a Mule instance and provides methods for binding and unbinding transaction and retrieving the current transaction state.
Document generated by Confluence on Mar 11, 2009 14:57
Page 443
Tuning Performance This page last changed on Nov 11, 2008 by jackie.wheeler.
Tuning Performance [ About Thread Pools ] [ About Threading Profiles ] [ About Pooling Profiles ] [ Calculating Threads ] [ Additional Performance Tuning Tips ] [ Threading Profile Configuration Reference ] [ Receiver Threading Profile ] [ Dispatcher Threading Profile ] [ Pooling Profile Configuration Reference ] [ Pooling Profile ] A Mule application is a collaboration of a set of services. Messages are processed by services in three stages: 1. Connector receiving stage 2. Service component processing stage 3. Connector dispatching stage Tuning performance in Mule involves analyzing and improving these three stages for each service. You can start by applying the same tuning approach to all services and then further customize the tuning for each service as needed.
About Thread Pools Each request that comes into Mule is processed on its own thread. A connector's receiver has a thread pool with a certain number of threads available to process requests on the inbound endpoints that use that connector. Keep in mind that Mule can send messages asynchronously or synchronously. By default, messages are asynchronous, which is the "fire-and-forget" style where a message is sent with no response. If you need a response back, you must configure the Mule service as synchronous. When a service is configured as asynchronous, a connector receiver and dispatcher are used, whereas a synchronous service uses only the connector receiver. If you are using synchronous processing, the same thread will be used to carry the message all the way through Mule, whereas if you are doing asynchronous processing, the receiver thread is used only to carry the message to the component, at which point the message is transferred to a component thread, and the receiver thread is released back into the receiver thread pool so it can carry another message. The following diagram illustrates these threads.
Document generated by Confluence on Mar 11, 2009 14:57
Page 444
After the component has finished processing an asynchronous message, it is transferred to a dispatcher thread and is sent on its way. Therefore, the receiver, component, and dispatcher all have separate thread pools that are in use during asynchronous processing, whereas only the receiver thread pool is in use for synchronous processing.
About Threading Profiles The threading profile specifies how the thread pools behave in Mule. You specify a separate threading profile for each receiver thread pool, component thread pool, and dispatcher thread pool. The most important setting of each is maxThreadsActive, which specifies how many threads are in the thread pool.
About Pooling Profiles Unlike singleton components, pooled components (see PooledJavaComponent ) each have a component pool, which contains multiple instances of the component to handle simultaneous incoming requests. A service's pooling profile configures its component pool. The most important setting is maxActive, which specifies the maximum number of instances of the component that Mule will create to handle simultaneous requests. Note that this number should be the same as the maxThreadsActive setting on the receiver thread pool, so that you have enough component instances available to handle the threads. You can use Mule HQ to monitor your component pools and see the maximum number of components you've used from the pool to help you tune the number of components and threads.
Calculating Threads To calculate the number of threads to set, you must take the following factors into consideration. • Concurrent User Requests: In general, the number of concurrent user requests is the total number of requests to be processed simultaneously at any given time by the Mule server. For a service, concurrent user requests is the number of requests a service inbound endpoint can process simultaneously. Concurrent user requests at the connector level is the total concurrent requests of all services that share the same connector. Typically, you get the total concurrent user requests from the business requirements. • Processing Time: Processing time is the average time Mule takes to process a user request from the time a connector receiver starts the execution until it finishes and then sends the response to the outbound endpoint by connector dispatcher or back to the caller by the connector receiver after a round trip. Typically, you determine the processing time from the unit tests. • Response Time: If a service runs in synchronous mode, the response time is the actual amount of time the end user is required to wait for the response to come back. If the service runs in asynchronous mode, it is the total time from when a request arrives in Mule until it is dispatched out of the service by the outbound dispatcher. In a thread pooling environment, when a request arrives, there is no guarantee that a thread will be immediately available. In this case, the request is put into an internal thread pool work queue to wait for the next available thread. Therefore, the response time is a function of the following: Response time = average of thread pool waiting time in work queue + average of processing time Your business requirements will dictate the actual response time required from the application. • Timeout Time: If your business requirements dictate a maximum time to wait for a response before timing out, it will be an important factor in your calculations below. After you have determined these requirements, you can calculate the adjustments you need to make to maxThreadsActive and maxBufferSize for the service and the receiver thread pool. In general, the formula is: Concurrent user requests = maxThreadsActive + maxBufferSize Where maxThreadsActive is the number of threads that run concurrently and maxBufferSize is the number of requests that can wait in the queue for threads to be released.
Document generated by Confluence on Mar 11, 2009 14:57
Page 445
Calculating the Service Threads Your business requirements dictate how many threads each service must be able to process concurrently. For example, one service might need to be able to process 50 requests at a time, while another might need to process 40 at a time. Typically, you use this requirement to set the maxThreadsActive attribute on the service (maxThreadsActive="40"). If you have requirements for timeout settings for synchronous processing, you must do some additional calculations for each service. 1. Run synchronous test cases to determine the response time. 2. Subtract the response time from the timeout time dictated by your business requirements. This is your maximum wait time (maximum wait time = timeout time - response time). 3. Divide the maximum wait time by the response time to get the number of batches that will be run sequentially to complete all concurrent requests within the maximum wait time (batches = maximum wait time / response time). Requests wait in the queue until the first batch is finished, and then the first batch's threads are released and used by the next batch. 4. Divide the concurrent user requests by the number of batches to get the thread size for the service's maxThreadsActive setting (where maxThreadsActive = concurrent user requests / processing batches). This is the total number of threads that can be run simultaneously for this service. 5. Set maxBufferSize to the concurrent user requests minus the maxThreadsActive setting (where maxBufferSize = concurrent user requests - maxThreadsActive). This is the number of requests that can wait in the queue for threads to become available. For example, assume a service must have the ability to process 200 concurrent user requests, your timeout setting is 10 seconds, and the response time is 2 seconds, making your maximum wait time 8 seconds (10 seconds timeout minus 2 seconds response time). Divide the maximum wait time (8 seconds) by the response time (2 seconds) to get the number of batches (4). Finally, divide the concurrent user requests requirement (200 requests) by the batches (4) to get the maxThreadsActive setting (50) for the service. Subtract this number (50) from the concurrent user requests (200) to get your maxBufferSize (150). In summary, the formulas for synchronous processing with timeout restrictions are: • • • •
Maximum wait time = timeout time - response time Batches = maximum wait time / response time maxThreadsActive = concurrent user requests / batches maxBufferSize = concurrent user requests - maxThreadsActive
Calculating the Receiver Threads A connector's receiver is shared by all services that specify the same connector on their inbound endpoint. The previous section described how to calculate the maxThreadsActive attribute for each service. To calculate the maxThreadsActive setting for the receiver, that is, how many threads you should assign to a connector's receiver thread pool, sum the maxThreadsActive setting for each service that uses that connector on their inbound endpoints: maxThreadsActive = # (service 1 maxThreadsActive, service 2 maxThreadsActive...service n maxThreadsActive) For example, if you have three components whose inbound endpoints use the VM connector, and your business requirements dictate that two of the services should handle 50 50 requests at a time and the third service should handle 40 requests at a time, set maxThreadsActive to 140 in the receiver threading profile for the VM connector.
Calculating the Component Threads and Instances In the component stage, the transformed message from the inbound endpoint is passed to the component thread. As you can see from the previous illustration, there are two pools involved here: a component thread is taken from component's thread pool, and a POJO instance is taken from the component object pool (if the component is configured as a pooled component instead of a singleton). Therefore, the number of component threads must match the number of component instances in the component pool. Otherwise, a bottle neck on either side will develop.
Document generated by Confluence on Mar 11, 2009 14:57
Page 446
If most of your components use asychronous processing, typically use the same number of component threads as you set for the receiver threads. If most of your components do synchronous processing, however, component threads won't be used as often, so this number can be much lower. Like the receiver thread pool, the component thread pool can be shared if multiple services use the same component. In this case, use the following formula: Component threads = # (service 1 + service 2 + ...+ service n)
Calculating the Dispatcher Threads Like component threads, dispatcher threads are used only for asynchronous processing. Typically, set the dispatcher threads to the same number as the component threads.
Other Considerations You can trade off queue sizes and maximum pool sizes. Using large queues and small pools minimizes CPU usage, OS resources, and context-switching overhead, but it can lead to artificially low throughput. If tasks frequently block (for example, if they are I/O bound), a system may be able to schedule time for more threads than you otherwise allow. Use of small queues generally requires larger pool sizes, which keeps CPUs busier but may encounter unacceptable scheduling overhead, which also decreases throughput.
Additional Performance Tuning Tips • In the log4j.properties file in your conf directory, set up logging to a file instead of the console, which will bypass the wrapper logging and speed up performance. To do this, create a new file appender (org.apache.log4j.FileAppender), specify the file and optionally the layout and other settings, and then change "console" to the file appender. For example:
log4j.rootCategory=INFO, mulelogfile log4j.appender.mulelogfile=org.apache.log4j.FileAppender log4j.appender.mulelogfile.layout=org.apache.log4j.PatternLayout log4j.appender.mulelogfile.layout.ConversionPattern=%-22d{dd/MMM/yyyy HH:mm:ss} - %m%n log4j.appender.mulelogfile.file=custommule.log
• If polling is enabled for a connector, one thread will be in use by polling, so you should increment your maxThreadsActive setting by one. Polling is available on connectors such as File, FTP, and STDIO that extend AbstractPollingMessageReceiver . • If you are using VM to pass a message between components, you can typically reduce the total number of threads because VM is so fast. • If you are processing very heavy loads, or if your endpoints have different simultaneous request requirements (for example, one endpoint requires the ability to process 20 simultaneous requests but another endpoint using the same connector requires 50), you might want to split up the connector so that you have one connector per endpoint. Thread pools in Mule use the JDK 1.4-compatible util.concurrent backport library, so all the variables defined on org.mule.config.ThreadingProfile are synonymous with ThreadPoolExecutor.
Threading Profile Configuration Reference Following are the elements you configure for threading profiles. You can create a threading profile at the , , or <service> level and reference it.
Document generated by Confluence on Mar 11, 2009 14:57
Page 447
Receiver Threading Profile The threading profile to use when a connector receives messages.
Attributes of
Name
Type
Required
maxThreadsActive
integer
no
The maximum number of threads that will be used.
maxThreadsIdle
integer
no
The maximum number of idle or inactive threads that can be in the pool before they are destroyed.
threadTTL
integer
no
Determines how long an inactive thread is kept in the pool before being discarded.
poolExhaustedAction WAIT/DISCARD/ no DISCARD_OLDEST/ ABORT/RUN
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
When the maximum pool size or queue size is bounded, this value determines how to handle incoming tasks. Possible values are: WAIT (wait until a thread becomes available; don't use this value if the minimum number of threads is zero, in which case a thread may never become available), DISCARD (throw away the current request and return), DISCARD_OLDEST (throw away the oldest request and return), ABORT (throw a RuntimeException), and RUN (the default; the thread making the execute request runs the task itself, which helps
Page 448
guard against lockup). threadWaitTimeout
integer
no
doThreading
boolean
no
maxBufferSize
integer
no
How long to wait in milliseconds when the pool exhausted action is WAIT. If the value is negative, it will wait indefinitely. true
Whether threading should be used (default is true). Determines how many requests are queued when the pool is at maximum usage capacity and the pool exhausted action is WAIT. The buffer is used as an overflow.
Dispatcher Threading Profile The threading profile to use when a connector dispatches messages.
Attributes of
Name
Type
Required
maxThreadsActive
integer
no
The maximum number of threads that will be used.
maxThreadsIdle
integer
no
The maximum number of idle or inactive threads that can be in the pool before they are destroyed.
threadTTL
integer
no
Determines how long an inactive thread is kept in the pool before being discarded.
poolExhaustedAction WAIT/DISCARD/ no DISCARD_OLDEST/ ABORT/RUN
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
When the maximum pool size or queue size is bounded, this value determines how to handle incoming tasks. Possible values are: WAIT
Page 449
(wait until a thread becomes available; don't use this value if the minimum number of threads is zero, in which case a thread may never become available), DISCARD (throw away the current request and return), DISCARD_OLDEST (throw away the oldest request and return), ABORT (throw a RuntimeException), and RUN (the default; the thread making the execute request runs the task itself, which helps guard against lockup). threadWaitTimeout
integer
no
doThreading
boolean
no
maxBufferSize
integer
no
How long to wait in milliseconds when the pool exhausted action is WAIT. If the value is negative, it will wait indefinitely. true
Whether threading should be used (default is true). Determines how many requests are queued when the pool is at maximum usage capacity and the pool exhausted action is WAIT. The buffer is used as an overflow.
Pooling Profile Configuration Reference Each service has its own pooling profile. You configure the pooling profile using the <pooling-profile> element on the <pooled-component> element.
Document generated by Confluence on Mar 11, 2009 14:57
Page 450
Pooling Profile Attributes of <pooling-profile...>
Name
Type
Required
maxActive
string
no
Controls the maximum number of Mule components that can be borrowed from a session at one time. When set to a negative value, there is no limit to the number of components that may be active at one time. When maxActive is exceeded, the pool is said to be exhausted.
maxIdle
string
no
Controls the maximum number of Mule components that can sit idle in the pool at any time. When set to a negative value, there is no limit to the number of Mule components that may be idle at one time.
initialisationPolicy
INITIALISE_NONE/ INITIALISE_ONE/ INITIALISE_ALL
no
Document generated by Confluence on Mar 11, 2009 14:57
Default
INITIALISE_ONE
Description
Determines how components in a pool should be initialized. The possible values are: INITIALISE_NONE (will not load any components into the pool on startup), INITIALISE_ONE (will load one initial component into the pool on startup), or INITIALISE_ALL (will load all components in the pool on startup)
Page 451
exhaustedAction
WHEN_EXHAUSTED_GROW/ no WHEN_EXHAUSTED_WAIT/ WHEN_EXHAUSTED_FAIL
maxWait
string
no
Document generated by Confluence on Mar 11, 2009 14:57
WHEN_EXHAUSTED_GROW Specifies the behavior of the Mule component pool when the pool is exhausted. Possible values are: "WHEN_EXHAUSTED_FAIL", which will throw a NoSuchElementException, "WHEN_EXHAUSTED_WAIT", which will block by invoking Object.wait(long) until a new or idle object is available, or WHEN_EXHAUSTED_GROW, which will create a new Mule instance and return it, essentially making maxActive meaningless. If a positive maxWait value is supplied, it will block for at most that many milliseconds, after which a NoSuchElementException will be thrown. If maxThreadWait is a negative value, it will block indefinitely. Specifies the number of milliseconds to wait for a pooled component to become available when the pool is exhausted and the exhaustedAction is set to WHEN_EXHAUSTED_BLOCK.
Page 452
Unit Testing This page last changed on Jan 07, 2009 by kevin.depew.
Unit Testing Mule provides a Test Compatibility Kit (TCK) of unit tests that you can use to test your simple extensions as well as your custom modules and transports. The unit tests are located in the tests.jar file, such as mule-core-2.0.2-tests.jar for Mule version 2.0.2. All unit tests inherit from org.mule.tck.AbstractMuleTestCase These unit tests are beneficial for the following reasons: • Components tested with a TCK test case ensure that the common behavior of the component is compatible with the Mule framework. • Using a TCK test case allows the developer to concentrate on writing tests for specific behavior of their component. • Where testing of a method in the Service Component API cannot be tested by the TCK test case, the test cases provides an abstract method for the test, ensuring the developer tests all areas of the component. • The TCK provides a default test model that is a simple set of test classes. The developer doesn't need to worry about writing new test classes for their test cases each time. • The abstract test cases in the TCK use JUnit's TestCase, so they are compatible with other test cases. Following is a description of some of the unit tests in the Mule TCK:
Testing Component
Description
AbstractMuleTestCase
A helper test case providing methods for creating test and mock object types. This is the base class for all other abstract TCK classes.
AbstractConnectorTestCase
Used to test the common behavior of a connector. This tests dispatching and sending events using mock objects.
AbstractMessageAdapterTestCase
Provides tests for all the standard methods defined in the MessageAdapter interface. It's usually enough to just extend this test case without writing any further tests.
AbstractMessageReceiverTestCase
Used to test the common behavior of a MessageReceiver. This tests receiving messages using mock objects.
AbstractComponentTestCase
This is the base class for unit tests that test custom component implementations. Concrete subclasses of this base class include DefaultJavaComponentTestCase, PooledJavaComponentTestCase, and SimpleCallableJavaComponentTestCase, each of which contains methods for testing that component type. For example, the DefaultJavaComponentTestCase includes methods for testing the creation, lifecycle, and disposal of a basic Java component.
AbstractTransformerTestCase
Used to test transformers. This class defines a number of tests that ensures that the transformer works in single scenarios as well as in round trip scenarios. There are many concrete sub-classes of this abstract class that
Document generated by Confluence on Mar 11, 2009 14:57
Page 453
test specific types of transformers, such as StringByteArrayTransformersTestCase. DefaultMuleContextTestCase
Tests the creation and disposal of the Mule context.
AbstractServiceTestCase
An abstract test case that provides methods for testing the starting, stopping, pausing, resuming, and disposing of services.
Document generated by Confluence on Mar 11, 2009 14:57
Page 454
Using IDEs This page last changed on Jul 02, 2008 by jackie.wheeler.
Using IDEs You can use an integrated development environment (IDE) such as Eclipse, IntelliJ, and Mule IDE to rapidly develop Mule applications. For more information on the Mule IDE, see the Mule IDE User Guide. Usually, you simply attach the src.zip file that comes with the Mule distribution to the Mule JARs in your project so you can browse the source code while developing your classes. If you want to build Mule from source, see the following topics in the Mule Developer's Guide: • Setting Up the Development Environment • Working with an IDE • Building from Source
Document generated by Confluence on Mar 11, 2009 14:57
Page 455
Using Mule HQ This page last changed on Feb 13, 2009 by jackie.wheeler.
Using Mule HQ [ Overview ] [ HQ Architecture ] [ Enabling Mule to Use Mule HQ ] [ Installing Mule HQ ] [ Starting and Stopping Mule HQ ] [ Logging in to Mule HQ ] [ Importing Mule ] [ Configuring Mule in Mule HQ ] [ Setting Up Availability Alerts ] [ Configuring Remote Agents Manually ] [ Monitoring and Controlling Your Resources ] [ Uninstalling Mule HQ ]
Overview Mule HQ provides a centralized way to manage all of your stand-alone Mule deployments as well as all of the disparate systems and services in your SOA infrastructure. For example, a typical stack that Mule HQ monitors might include Redhat Enterprise Linux, MySQL, JBoss Application Server, OpenMQ, and Mule. Mule HQ provides integrated log, configuration, and server event tracking. It can detect Mule servers and associated software and hardware, and report real-time and historical details of events. If you need to debug a problem with your deployment, you can turn on the Profiler and view the details of memory consumption at the message level. Mule HQ is available with Mule Enterprise Edition only. It can monitor both Community Edition and Enterprise Edition instances of Mule 1.x and 2.1 servers. Mule HQ supports stand-alone Mule deployments only and cannot monitor embedded Mule instances.
HQ Architecture Mule HQ is based on Hyperic HQ. This section describes the Hyperic HQ Server and Agent.
Hyperic HQ Server As HQ's central nervous system, the HQ Server coordinates all system functions, including: • • • • • •
Processing incoming monitoring data Detecting alert conditions and sending out alerts Managing inventory, including merging auto-discovery information into current inventory Enforcing security Maintaining HQ operational schedules (for control actions and auto-discovery scans) Processing user-driven actions initiated via the HQ GUI or command line interface
In large environments, the HQ Server can be clustered to enhance fault tolerance and to share the overall system load across multiple machines.
Document generated by Confluence on Mar 11, 2009 14:57
Page 456
Hyperic HQ Agent Acting as the sensory facilities of the HQ system, Agents are deployed throughout the network infrastructure to provide points-of-presence for discovering inventory, gathering data, controlling software, and other "in the trenches" tasks. The HQ Shell's Agent installer makes quick work of installing and managing all your HQ Agents - without ever having to visit each managed machine.
Enabling Mule to Use Mule HQ To use Mule with Mule HQ, you must enable the JMX support agent and (if installed) the Mule Profiler in your Mule configuration. Your Mule configuration files must be available to Mule HQ on a relative or absolute path. They cannot be embedded in a JAR file.
Configure the JMX Support Agent The default JMX support agent configures several JMX agents simultaneously. To add this to your configuration, you add the management namespace and the <management:jmx-default-config> element to your configuration file. For example, the following example includes the xmlns:management entry, the declaration of the XSD location (http://www.mulesource.org/schema/mule/management/2.1 http://www.mulesource.org/schema/mule/management/2.1/mule-management.xsd) and the <management...> entries:
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:spring="http://www.springframework.org/schema/beans" xmlns:management="http://www.mulesource.org/schema/mule/management/2.1" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd http://www.mulesource.org/schema/mule/core/2.1
Document generated by Confluence on Mar 11, 2009 14:57
Page 457
http://www.mulesource.org/schema/mule/core/2.1/mule.xsd http://www.mulesource.org/schema/mule/management/2.1 http://www.mulesource.org/schema/mule/management/2.1/mule-management.xsd"> <management:jmx-default-config port="1098"> <management:credentials> <spring:entry key="jsmith" value="foo"/> <spring:entry key="dthomas" value="bar"/> <spring:entry key="clee" value="pwd"/> ...
Note: you only specify the port if you don't want to use the default of 1099. You can also provide more advanced configuration, such as using the RMI registry agent and specifying the JMX server explicitly:
<management:rmi-server serverUri="rmi://localhost:9000"/> <management:jmx-server> <management:connector-server url="service:jmx:rmi:///jndi/rmi://localhost:9000/server"/> <management:credentials> <spring:entry key="user" value="pass"/>
For more information, see Jmx Management.
Enable the Profiler Pack The Mule Profiler pack allows you to profile your application (see Profiling Mule). After downloading and installing the Profiler pack, you add the following element to your Mule configuration file:
<management:yourkit-profiler />
You must also add the -profile attribute to the bash/cmd script. For example, if you are using Windows, you would edit stockquote.bat as follows:
IF '%Choice%'=='1' call "%MULE_BASE%\bin\mule.bat" -config ".\conf\stdio-config.xml,.\conf\stockquote-rest-config.xml" -builder spring -profile
If you are using a non-Windows operating system, you would edit it as follows:
if [ 1 = $i ] then exec "$MULE_BASE/bin/mule" -config "./conf/stdio-config.xml,./conf/stockquote-rest-config.xml" -builder spring -profile
The configuration file you specify in the batch file depends on which variation and Mule instance you want to use. The previous example specified the REST version of the Stock Quote example.
Document generated by Confluence on Mar 11, 2009 14:57
Page 458
Setting the Server ID When you run Mule, you must specify the -M-Dmule.serverId=MULE_SERVER_ID switch on the command line (where MULE_SERVER_ID is the name of your Mule server) or set it programatically by calling org.mule.config.DefaultMuleConfiguration.setId(). This will create the Mule.MULE_SERVER_ID JMX domain, which Mule HQ will use to detect the Mule instance. You'll set this same domain ID when you configure Mule in Mule HQ.
Verify the Configuration Verify that your configuration changes were applied by starting the Mule instance you just configured (be sure to specify the server ID as described in the previous section). For example, launch the stock quote example and select REST when prompted:
You should see an output similar to the one below at the end:
Document generated by Confluence on Mar 11, 2009 14:57
Page 459
Installing Mule HQ This section describes how to install the HQ Server and Agent. By default, Mule HQ uses its own internal database. To install Mule HQ with an external database, see Installing Mule HQ with an External Database.
Prerequisites Before you install Mule HQ, you must do the following: 1. If you have not already done so, contact MuleSource Sales to obtain a license (you can get a trial license for free). Mule HQ will not run without a license. 2. Log in as a non-root user and install Mule. Make sure that this non-root user account has Java in the environment variable PATH and has write permission to <MULE_BASE>/conf/wrapper files or <MULE_HOME>/conf/wrapper files, depending on whether MULE_BASE is set. If you already have Mule installed, ensure that your system is still using the supported platforms (e.g., a supported version of Java). 3. Configure your Mule instance to support Mule HQ (see Enabling Mule to Use Mule HQ). 4. On UNIX platforms, ensure that libXp.so.6 is installed. HQ Server requires this library to create charts and other graphics in the user interface. For more information on prerequisites, see the Installation Overview on the Hyperic site.
Install Mule HQ 1. On the computer where you want to install Mule HQ, log in as the same non-root user you used when you installed Mule, and then create a directory called MuleHQ, such as C:\Program Files \MuleHQ. 2. Download the Mule HQ distribution (mule-hq-installer) and decompress it to the Mule HQ directory. 3. In the Mule HQ directory, run setup.bat (on Windows) or setup.sh (on UNIX) at the command prompt. 4. Follow the instructions on the screen (see the example below for details) and enter the following values: • When prompted to choose which software to install, press 1 and 3 to install both the HQ server and agent. • For the HQ server installation path, specify the MuleHQ directory you created in step 1, such as C:\Program Files\MuleHQ. Example Installation This example illustrates what you see during installation. For simplicity, everything will be installed on the localhost. The values you enter during installation are marked in bold. Buildfile: C:\Temp\mule-hq-installer\installer-3.1.2-EE\bin\..\data\setup.xml Initializing Mule HQ 3.1.2-EE Installation... Loading taskdefs... Taskdefs loaded Choose which software to install: 1: Mule HQ Server 2: Mule HQ Shell 3: Mule HQ Agent You may enter multiple choices, separated by commas. 1,3 HQ server installation path [default 'C:\Program Files']: C:\Program Files\MuleHQ HQ agent installation path [default 'd:/server/MuleHQ']: Loading install configuration... Install configuration loaded. Preparing to install...
Document generated by Confluence on Mar 11, 2009 14:57
Page 460
Validating agent install configuration... Validating server install configuration... Checking server webapp port... Checking server secure webapp port... Checking server JRMP port... Checking server JNP port... Verifying admin user properties Validating server DB configuration... Installing the agent... Looking for previous installation Unpacking agent to: d:/server/MuleHQ/agent-3.1.2-EE... Installing the JRE ... Unpacking JRE x86-win32-jre.exe to: d:/server/MuleHQ/agent-3.1.2-EE... Setting permissions on agent binaries... Fixing line endings on text files... -------------------------------------------------------------------------------Installation Complete: Agent successfully installed to: d:/server/MuleHQ/agent-3.1.2-EE -------------------------------------------------------------------------------You can now start your HQ agent by running this command: d:\server\MuleHQ\agent-3.1.2-EE\hq-agent.exe start Installing the server... Unpacking server to: d:/server/MuleHQ/server-3.1.2-EE... Creating server configuration files... Copying binaries and libraries to server installation... Copying server configuration file... Copying server control file... Copying server binaries... Copying server libs... Setting up server database... Setting up JDBC driver... Copying database files... Configuring database... Starting repopulation of configuration table... Waiting for built-in database to start (on port 9432)... Starting built-in database... Preparing database... Vacuuming database... Waiting for server to stop... Stopping built-in database... Built-in database stopped. Installing the JRE ... Unpacking JRE x86-win32-jre.exe to: d:/server/MuleHQ/server-3.1.2-EE... Setting permissions on server binaries... Fixing line endings on text files... -------------------------------------------------------------------------------Installation Complete: Server successfully installed to: d:/server/MuleHQ/server-3.1.2-EE -------------------------------------------------------------------------------You should now install the HQ server as a Windows Service using this command: d:\server\MuleHQ\server-3.1.2-EE\bin\hq-server.exe -i You can then use the Service Control Manager (Control Panel->Services) to start the HQ server. Note that the first time the HQ server starts up it may take several minutes to initialize. Subsequent startups will be much faster. Once the HQ server reports that it has successfully started, you can log in to your HQ server at:
Document generated by Confluence on Mar 11, 2009 14:57
Page 461
[http://localhost:7080/] username: hqadmin password: hqadmin To change your password, log in to the HQ server, click the "Administration" link, choose "List Users", then click on the "hqadmin" user. Setup completed. A copy of the output shown above has been saved to: D:\Temp\mule-hq-installer\installer-3.1.2-EE\bin\../hq-install.log Press the Enter key to exit setup. Detailed HQ Installation Instructions For more detailed installation instructions, see the following Hyperic documentation: • Windows • Non-Windows
Install the HQ Server as a Windows Service You can install the HQ Server as a Windows Service so that you can leave the HQ Server running even after you log out of Windows. To install it as a service, navigate to the Mule HQ Server bin directory (such as C:\Program Files\MuleHQ\server-3.1.2-EE\bin) and enter the following command at the command prompt: hq-server.exe -i This command creates two services: Hyperic HQ Database and Hyperic HQ Server. You start the database service first and then the server.
Customize the JVM used by Mule HQ You can set the environment variable HQ_JAVA_HOME to use a Java VM other than the one that ships with Mule HQ.
Starting and Stopping Mule HQ The first time you start the HQ Server, it can take several minutes to initialize. Note that this happens only the first time you start the server; subsequent starts are much faster.
Starting Mule HQ To start Mule HQ, you start the database, then the server, and then the agent. Start the Database and Server Navigate to the Mule HQ Server bin directory and execute the following commands: db-start hq-server Note that there will be no console output from the first script. The second script should indicate that the core system was initialized and that it is configuring from URL: resource:log4j.xml. Leave this command window open while you are running Mule HQ. If you installed the HQ Server as Windows services, you can start and stop the services from the Services application in the Control Panel, or you can enter the following commands at the command prompt: net start "Hyperic HQ Database" net start "Hyperic HQ Server
Document generated by Confluence on Mar 11, 2009 14:57
Page 462
Start the Agent In a new command window, navigate to the agent directory (such as C:\Program Files\MuleHQ \agent-3.1.2-EE) and enter the following command at the command prompt: hq-agent You must now answer several questions at the prompt. If you are testing the setup, you can specify localhost for the server IP address and accept the defaults for everything else. For more information on the agent settings, see Mule HQ Agent Settings. If the connection fails, and you are using an evaluation version of Mule HQ, your license may have expired. Click here to contact MuleSource about purchasing a license.
Stopping Mule HQ To stop the server, log out of your Windows session, or enter the following command: hq-server stop If you installed the HQ Server as a Windows service, you can stop the service from the Services application, or by entering net stop "Hyperic HQ Server" at the command prompt.
Logging in to Mule HQ To log in to Mule HQ, do the following: 1. In a web browser, navigate to port 7080 of the server on which Mule HQ is installed, such as http://localhost:7080/ or http://hostname.network.com:7080/. The Mule HQ Login screen appears. If the login screen does not appear, and you are using an evaluation version of Mule HQ, your license may have expired. Click here to contact MuleSource about purchasing a license. 2. Enter the default Administrator Login (hqadmin)and Password (hqadmin). The Mule HQ Dashboard displays. Mule might be in the Auto-discovery list already. If it is not, continue to the next section to import Mule into HQ.
Importing Mule The Dashboard consists of several portlets that provide information about the HQ deployment. The first portlet is the Auto-Discovery portlet, which discovers platforms, servers, and services on your system and displays them here. After first starting Mule HQ, the portlet displays several entries (platform and servers) for the newly registered HQ Agent on the local machine and for any other resource it has found on the host so far. These resources need to be "imported" (added to the HQ inventory) so that the Agent can start collecting default metrics for them. You will know that the platform has been successfully imported when you see its hostname in the Recently Added portlet (at the left). You can manually import the platform, or use scripts to manage integration with Mule.
Importing the Platform Manually On the Dashboard, select the radio button next to your host (and next to any other platform and server entries in this portlet) and click Add to Inventory.
Using the Mule Integration Scripts Mule HQ provides scripts for managing integration with Mule from the command line or programmatically. To enable these scripts, copy the file commons-cli-1.1.jar from MULE_HOME\lib\boot to the following location under your Mule HQ server directory: hq-engine\server\default\deploy\hq.ear\lib
Document generated by Confluence on Mar 11, 2009 14:57
Page 463
To run these scripts, you enter the following command at the command prompt:
java -jar mule-sdk.jar <subcommand>
The following optional parameters constrain the subcommand to a specific Mule platform (otherwise, all Mule platforms are affected): • hq_host is the host where Mule HQ server is installed • hq_port is the port of Mule HQ server • hq_username, hq_password are credentials for the Mule HQ user The subcommand must be one of the following:
Command
Description
ai:approve
Automatically approves and configures pending Mule resources in the auto-discovery list.
ai:delete
Deletes the pending Mule resources from the auto-discovery list. In complex scenarios, you must call this before calling ai:rescan.
ai:rescan
Rescans Mule resources so that they will reappear in the auto-discovery list.
delete
Deletes all approved Mule platforms from Mule HQ.
ai:revert
Reverts all skipped Mule instances from the ignored state so that they can reappear in the auto-discovery list.
Viewing Imported Resources After importing a Mule instance manually or through the scripts, the Mule servers are added to Mule HQ.
Document generated by Confluence on Mar 11, 2009 14:57
Page 464
Document generated by Confluence on Mar 11, 2009 14:57
Page 465
All imported Mule servers appear on the Mule Center tab. After importing the Mule platform, if you want to run auto-discovery manually to discover recently added Mule instances, do the following: 1. At the top of the Mule HQ window, click Browse Resources. 2. On the Platforms tab, click the Mule platform to display its details. 3. Click Tools Menu in the upper-right corner, and then choose New Auto-Discovery.
Document generated by Confluence on Mar 11, 2009 14:57
Page 466
4. Select the Mule check box and specify your Mule home directory for the directories to scan. 5. Leave the defaults for everything else and click OK.
Document generated by Confluence on Mar 11, 2009 14:57
Page 467
Click the Dashboard to see the newly discovered resources that are ready for import.
Document generated by Confluence on Mar 11, 2009 14:57
Page 468
Configuring Mule in Mule HQ After you have imported Mule into Mule HQ, you might need to perform some additional configuration. To configure Mule: 1. On the Dashboard, click the Mule platform, click the Mule instance you want to configure, and click the Inventory tab. 2. Scroll down until you see the Configuration Properties group, click it to expand its contents, and then click Edit. 3. Enter the following settings: • Specify the domain as Mule followed by a period followed by the Mule server ID you specified when you ran Mule (see Setting the Server ID), such as Mule.MyMuleServer. This step is very important. If the domain was already imported through auto-discovery, you can leave it as is. • Specify the JMX URL used by your Mule instance. This URL is displayed on the startup screen when you start Mule under Agents Running. If you do not see the JMX Agent listed, you have not properly configured your Mule instance to work with Mule HQ--see Enabling Mule to Use Mule HQ above. • Leave the user name and password as empty values. • Enable the Auto-Discover Components, Connectors, and Other Services option. Make sure the metrics you want are collected often enough so you see the results faster. Otherwise, it defaults to 1 minute. 4. Click OK. For complete instructions on configuring resources in HQ, see Getting Started with HQ.
Setting Up Availability Alerts Mule HQ can alert you when availability is lost. To enable this feature, take the following steps:
Document generated by Confluence on Mar 11, 2009 14:57
Page 469
1. Navigate to the conf directory in your Mule HQ Server directory, and then open hq-server.conf for editing. 2. Configure your mail server and set up email addresses for all Mule HQ users you want to notify, then save and close the file. 3. In Mule HQ, click Mule, click the Alert tab, click New, and then specify a condition where the availability metric's value is less than 100%. 4. Save the alert definition and specify the users to be notified for this condition. For complete information on configuring alerts, click here.
Configuring Remote Agents Manually JBoss 4.2 does not provide or expose the JMX service URL. You can view Mule within JBoss by enabling a remote JMX connection. This approach makes JBoss visible through JConsole and enables some remote actions. However, this approach does not enable Mule HQ access. To work around this limitation, Mule can start a local RMI registry (the JBoss 4.x registry will not work, as it is not pure RMI) and connect via this lookup. To enable this approach, set the port attribute on the <jmx-default-config> element in Mule as shown in Configure the JMX Support Agent above. This ensures both the registry and JMX connector are coordinated properly and allows you to assign custom connection ports. You then specify the JMX ServiceURL in MuleHQ as: service:jmx:rmi:///jndi/rmi://localhost:1099/server Because Mule HQ will not automatically discover this Mule instance, you must add it manually in the Mule HQ application. You can specify a dummy server directory but specify the correct JMX URL and port. After loading Mule HQ Server, the new Mule instance is discovered along with its components, routers, and more. For complete information on configuring agents in Mule HQ, click here.
Monitoring and Controlling Your Resources Now that you have completed the installation and configuration, see the following topics for more information on using Mule HQ: • Monitoring Basics • Controlling Resources Following is a description of some of the key features for monitoring and controlling your resources in Mule HQ. As you monitor your components, note that statistics are not generated for BridgeComponents, such as the BridgeComponent in the Stock Quote example.
Stopping, Starting, and Restarting Mule from Mule HQ You can use the Stop, Start, and Restart control actions on the Control tab in Mule HQ to control a Mule server, component, endpoint, router, or connector.
Document generated by Confluence on Mar 11, 2009 14:57
Page 470
• The Stop command stops the Mule server and all related processes. • The Start command launches a new Mule server instance using the HQ Agent. The HQ Agent creates and executes a new command line using the configuration parameters stored in the inventory. • The Restart command send a "restart" signal to restart the JVM and re-read the configuration file. The Wrapper is not stopped, and external parameters like debug, profile, service, and the configuration file are unchanged. Therefore, Restart is not the same as using the Stop and Start commands.
Profiling Mule Mule is integrated with YourKit Java Profiler 7.0, the industry leader among profiling tools. If you installed Mule and Mule HQ with the profiling option, you can use the Profiling tab in Mule HQ to create a snapshot, start CPU profiling, and more. Captured snapshots are saved in ~/Snapshots/ on Linux.
If you did not install the Profiling kit with Mule or did not enable it, the Profiling tab indicates that the profiler is not installed or enabled. If you want to install it now, you can download the ZIP or GZ version of the mule-profiler-pack file here and follow the instructions here to install it.
Document generated by Confluence on Mar 11, 2009 14:57
Page 471
Patch Management The Mule Center tab in Mule HQ provides a list of all your Mule servers. It also allows you to install Mule patches to remote servers that have been distributed to you by MuleSource.
Viewing Mule Log Files You can view the Mule log files from remote servers in Mule HQ by clicking the Show Log link on the Indicators tab when viewing the details of a Mule server.
Uninstalling Mule HQ To uninstall Mule HQ, you run the hq-server and hq-agent scripts with the -u parameter. For example, on Windows you would run:
hq-server.exe -u
Document generated by Confluence on Mar 11, 2009 14:57
Page 472
hq-agent.exe -u
For complete information on uninstalling HQ, see Uninstalling Hyperic HQ on the Hyperic site.
Document generated by Confluence on Mar 11, 2009 14:57
Page 473
Installing Mule HQ with an External Database This page last changed on Dec 10, 2008 by jackie.wheeler.
Installing Mule HQ with an External Database By default, Mule HQ uses its own internal database. This section describes how to install Mule HQ with a standalone PostgreSQL, Oracle, or MySQL database. To install, navigate to the Mule HQ directory, and then run one of the following commands to perform a quick install, which prompts you for the database connection information and uses defaults for all other settings:
PostgreSQL UNIX:
setup.sh -postgresql
Windows:
setup.bat -postgresql
Oracle UNIX:
setup.sh -oracle
Windows:
setup.bat -oracle
MySQL UNIX:
setup.sh -mysql
Windows:
setup.bat -mysql
Notes PostgreSQL 8.0 During installation, Mule HQ creates a language in the PostgreSQL database, but Mule HQ cannot create the language automatically in PostgreSQL 8.0. Therefore, to use version 8.0, you must run the following command on the Mule HQ database before starting the Mule HQ Server. createlang plpgsql [MULEHQ:DATABASE NAME] The createlang executable is located in the bin directory of your PostgreSQL installation.
MySQL 5.0 MySQL 5.0 or higher is not yet supported by Hyperic HQ and is currently in Beta. Support is expected for Hyperic HQ 3.2. For advanced database preparation, see the Database Preparation Guide
Document generated by Confluence on Mar 11, 2009 14:57
Page 474
Mule HQ Agent Settings This page last changed on May 29, 2008 by jackie.wheeler.
Mule HQ Agent Settings When you run the Mule HQ Agent, it prompts you for connection information to your HQ Server. [MULEHQ: Running agent setup ] What is the HQ server IP address: 172.30.46.145 Should Agent communications to HQ always be secure [MULEHQ:default=yes]: yes What is the HQ server port [MULEHQ:default=7080]: 7080 - Testing secure connection ... Success What is your HQ login [MULEHQ:default=hqadmin]: hqadmin What is your HQ password: **Not echoing value** What IP should HQ use to contact the agent [MULEHQ:default=172.30.46.145]: 172.30.46.145 What port should HQ use to contact the agent [MULEHQ:default=2144]: 2144 - Received temporary auth token from agent - Registering agent with HQ - HQ gave us the following agent token 1192444751142-7096515327909319777-6396758454203270452 - Informing agent of new HQ server - Validating - Successfully setup agent
To make the Agent deployment process easier, you can specify these settings in the agent.properties file located in the agent root directory. The file looks like this:
agent.setup.camIP=172.30.46.145 agent.setup.camPort=7080 agent.setup.camSSLPort=7443 agent.setup.camSecure=yes agent.setup.camLogin=hqadmin agent.setup.camPword=hqadmin agent.setup.agentIP=*default* agent.setup.agentPort=*default*
where values of camIP, camLogin and camPword parameters should be replaced with your HQ Server IP, user name, and password. By setting these values in the file, you will no longer need to interactively answer questions when you first start up the Mule HQ Agent. Additionally, the MuleServerDetector uses an Internet connection to get some DTDs. If you use an external HTTP proxy for your Internet connection, you must add the following value to the agent.javaOpts property:
-Dhttp.proxyHost= -Dhttp.proxyPort=
For more information on agent properties see the HQ Agent Configuration page on the Hyperic site.
Document generated by Confluence on Mar 11, 2009 14:57
Page 475
Using Mule Modules This page last changed on Nov 05, 2008 by jackie.wheeler.
Using Mule Modules Modules are similar to transports in that they provide pluggable functionality, configured via dedicated schema, but they differ in that there is no underlying transport to send or receive data. Following is a list of the default Mule modules.
Acegi Module
Security via Acegi.
Client Module
MuleClient and the remote dispatcher, giving simple access to the Mule server.
JAAS Module
Security via JAAS.
JBoss Transaction Manager
JBoss transaction support.
Management Module
Mule agents for server management using JMX.
OGNL Module
Provides a filter using OGNL expressions. For details, see Using OGNL Expressions.
PGP Module
Security via PGP.
Scripting Module
Interface between Mule and scripting languages (currently Groovy).
Spring Extras Module
Extensions for using the Spring framework with Mule.
SXC Module
A very fast streaming XPath router and filter.
XML Module
XML based utilities (mainly filters and routers).
Document generated by Confluence on Mar 11, 2009 14:57
Page 476
Acegi Module This page last changed on Feb 20, 2009 by jackie.wheeler.
Acegi Module This module provides Acegi-based security and delegates authorization to some other provider.
Security Manager Child Elements of <security-manager...>
Name
Cardinality
Description
delegate-security-provider
0..1
An Acegi-based security provider that delegates authorization to some other provider.
Delegate Security Provider An Acegi-based security provider that delegates authorization to some other provider.
Attributes of <delegate-security-provider...>
Name
Type
Required
delegate-ref
name (no spaces)
no
Default
Description
Child Elements of <delegate-security-provider...>
Name
Cardinality
security-property
0..*
Description
Http Security Filter This appears to authenticate users via information in standard HTTP headers.
Attributes of
Name
Type
Required
realm
string
no
securityProviders
string
no
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
The delegatesecurity-provider to use for authenticating. Use this element
Page 477
in case you have multiple security managers defined in your configuration.
Document generated by Confluence on Mar 11, 2009 14:57
Page 478
JAAS Module This page last changed on Feb 20, 2009 by jackie.wheeler.
JAAS Module This module provides security via JAAS.
Security Manager This is the security provider type that is used to configure JAAS related functionality.
Child Elements of <security-manager...>
Name
Cardinality
Description
security-provider
0..1
This is the security provider type that is used to configure JAAS related functionality.
password-encryption-strategy
0..*
Security Provider This is the security provider type that is used to configure JAAS related functionality.
Attributes of <security-provider...>
Name
Type
Required
loginContextName
string
no
credentials
string
no
loginConfig
string
no
loginModule
string
no
Default
Description
Jaas Security Filter Authenticates users via JAAS.
Document generated by Confluence on Mar 11, 2009 14:57
Page 479
JBoss Transaction Manager This page last changed on Jul 31, 2008 by jackie.wheeler.
JBoss Transaction Manager This module enables Mule to use the JBoss transaction manager (previously Arjuna) to configure XA transactions. Developers can configure one Transaction Manger per Mule instance. For more information, see JBoss Transactions.
Transaction Manager To configure an instance of the JBoss transaction manager within Mule, add this element to your Mule XML config file. You can configure arbitrary properties on the transaction manager that will be passed on to the underlying transaction manager. For example:
<jbossts:transaction-manager> <property key="test" value="TEST"/>
You can then declare XA transactions on endpoints supporting XA transactions, and all those transactions will be managed by the JBoss transaction manager.
Document generated by Confluence on Mar 11, 2009 14:57
Page 480
Scripting Module This page last changed on Mar 04, 2009 by jackie.wheeler.
Scripting Module [ Script Configuration Builder ] [ Component ] [ Script ] [ Transformer ] [ Groovy Refreshable ] [ Lang ] The scripting module provides facilities for using scripting languages in Mule. Any scripting languages that supports JSR-223 can be used inside Mule. Scripts can be used as implementations of service components or transformers. Also, scripts can be used for expression evaluations, meaning message routing can be controlled using script evaluations on the current message. You can even configure Mule instances from scripts.
Script Configuration Builder The ScriptConfigurationBuilder allows developers to create a Mule instance from a JSR-223 compliant script. To load the manager from Groovy:
ConfigurationBuilder builder = new ScriptConfigurationBuilder("groovy", "../conf/mule-config.groovy"); MuleContext muleContext = new DefaultMuleContextFactory().createMuleContext(builder);
Or to start the server from the command line:
mule -M-Dorg.mule.script.engine=groovy -builder org.mule.module.scripting.builders.ScriptConfigurationBuilder -config ../conf/mule-config.groovy
For more information about configuring a Mule instance from code or script see Configuration Overview.
Component Defines a script component backed by a JSR-223 compliant script engine such as Groovy, JavaScript, or Ruby. Scripting allows you to either directly embed your script inside the XML config or reference a script using Spring's dynamic language support: http://static.springframework.org/spring/docs/2.5.x/reference/ dynamic-language.html.
Attributes of
Name
Type
Required
script-ref
name (no spaces)
no
Default
Description A reference to a script object bean, that is, a <script:script ...> definition.
Child Elements of
Name
Cardinality
Document generated by Confluence on Mar 11, 2009 14:57
Description
Page 481
script
0..1
A script to be executed by a JSR-223 compliant script engine such as Groovy, JavaScript(Rhino), Python, Ruby, or Beanshell.
java-interface-binding
0..*
A binding associates a Mule endpoint with an injected Java interface (this is like using Spring to inject a bean, but instead of calling a method on the bean a message is sent to an endpoint). Script bindings will only work with Java-based scripting languages. Right now there is no validation on when languages support Java bindinngs because there are so many scripting languages.
The following example demonstrates how to configure a Groovy script component with an in-line script:
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:script="http://www.mulesource.org/schema/mule/scripting/2.2" xmlns:vm="http://www.mulesource.org/schema/mule/vm/2.2" xsi:schemaLocation=" http://www.mulesource.org/schema/mule/core/2.2 http://www.mulesource.org/schema/mule/core/2.2/ mule.xsd http://www.mulesource.org/schema/mule/scripting/2.2 http://www.mulesource.org/schema/mule/ scripting/2.2/mule-scripting.xsd http://www.mulesource.org/schema/mule/vm/2.2 http://www.mulesource.org/schema/mule/vm/2.2/ mule-vm.xsd"> <script:script name="myScript" engine="groovy"> return "$payload Received" <model> <service name="inlineScript"> <script:component> <script:script engine="groovy"> return "$payload Received" <pass-through-router> ...
The following example demonstrates how to orchestrate message flows using bindings. The example calls out to two different services and passes the results on to the outbound router.
Document generated by Confluence on Mar 11, 2009 14:57
Page 482
Click here to expand...
<service name="scriptWithBindings"> <script:component> <script:script engine="groovy"> msg = CalloutService.doSomething(payload) return CalloutService.doSomethingElse(msg) <script:java-interface-binding interface="org.mule.components.script.CalloutService" method="doSomething"> <script:java-interface-binding interface="org.mule.components.script.CalloutService" method="doSomethingElse"> <pass-through-router> <service name="Callout1"> <service name="Callout2">
Script Represents a script that can be used as a component for a service or a transformer. The script text can be pulled in from a script file or can be embedded inside this element. A script can be executed by any JSR-223 compliant script engine such as Groovy, JavaScript(Rhino), Python, Ruby, or Beanshell.
Attributes of <script...>
Name
Type
Required
name
string
no
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description The name used to identify this script object. This is used when you want to reference this script object from a component or transformer.
Page 483
engine
string
no
The name of the script engine being used. All scripting languages that support JSR-223 have a script engine name such as groovy, ruby, python, etc. If this value is not set, but a script file is configured, Mule will attempt to load the correct script engine according to the script file's extension.
file
string
no
The script file to load for this object. The file can be on the classpath or local file system.
Child Elements of <script...>
Name
Cardinality
Description
text
0..1
Used for embedding script code inside the XML. This is useful for simple scripts where you are just mocking up a quick application.
Script Context Bindings When run inside Mule, scripts have a number of objects available to them in the script context:
Name
Description
log
A logger that can be used to write to Mule's log file.
muleContext
A reference to the MuleContext object.
eventContext
A reference to the event context. This allows you to dispatch events progammatically from your script.
message
The current message.
originalPayload
The payload of the current message before any transforms.
Document generated by Confluence on Mar 11, 2009 14:57
Page 484
payload
The transformed payload of the current message if a transformer is configured on the service. Otherwise this is the same value as originalPayload.
src
Same as payload, kept for backward compatability.
service
A reference to the current service object.
id
The current message ID.
result
A placeholder object where the result of the script can be written. Usually it's better to just return a value from the script unless the script method doesn't have a return value.
message properties
Any message properties can be used as variables for the script.
Transformer Runs a script to perform transformation on the current message.
Child Elements of
Name
Cardinality
Description
script
0..1
A script to be executed by a JSR-223 compliant script engine such as Groovy, JavaScript(Rhino), Python, Ruby, or Beanshell.
To use Groovy as an example, the following transformer configuration will convert a comma-separated string of values to a java.util.List.
<script:transformer name="stringReplaceWithParams"> <script:script engine="groovy"> <property key="oldStr" value="l"/> <property key="newStr" value="x"/> <script:text> return payload.toString().replaceAll("$oldStr", "$newStr")
Groovy Refreshable A wrapper for a component object that allows the underlying object to be reloaded at runtime. This makes it possible to hot-deploy new component logic without restarting.
Document generated by Confluence on Mar 11, 2009 14:57
Page 485
Attributes of
Name
Type
Required
Default
Description
name
string
no
The name for this refreshable groovy bean wrapper.
refreshableBeanref
name (no spaces)
no
The reference to a groovy.lang.Groovy object to use for this component.
methodName
string
no
The entrypoint method to invoke when a message is received for the object.
Lang This element allows the http://www.springframework.org/schema/lang namespace to be embedded. Within this element developers can include the Spring lang namespace.
Document generated by Confluence on Mar 11, 2009 14:57
Page 486
Spring Extras Module This page last changed on Nov 25, 2008 by jackie.wheeler.
Spring Extras Module This module provides extensions for using the Spring framework with Mule, such as using the Spring container to build components managed by Mule.
Package
Description
org.mule.module.spring.events
A Spring EventMulticaster that allows any Spring bean to send and receive Mule events through the ApplicationContext and event listeners.
org.mule.module.spring.i18n
Spring messages that can be localized.
org.mule.module.spring.remoting
Classes for using Spring remoting. For more information, see the Spring Remoting example.
org.mule.module.spring.transaction
Provides classes for a transaction factory and transaction manager factory.
Document generated by Confluence on Mar 11, 2009 14:57
Page 487
SXC Module This page last changed on Nov 17, 2008 by jackie.wheeler.
SXC Module The SXC module contains an outbound router and a filter that use the SXC project for streaming XPath routing. SXC allows listening for XPath expressions as the document is being parsed. As soon as an expression is found, an event is fired, and parsing is stopped. This allows for much more efficient XPath evaluation. XPath evaluators such as Jaxen work with a DOM model, so even when working with lazy-loading DOMs, such as AXIOM, there is more overhead than in just reading directly off the XML stream. SXC supports a limited subset of XPath expressions. For details, see the SXC documentation. To request support for a missing XPath feature, please file a SXC JIRA.
Using the SXC Outbound Router and Filter SXC requires a special filtering outbound router, inside of which you configure the SXC filter and any other filters that do not work on the XML payload itself (such as AndFilter, OrFilter, and MessagePropertyFilter). For example, this configuration routes a message based on an XML attribute:
<sxc:filtering-router> <sxc:filter pattern="//purchaseOrder[@country]"/> <sxc:namespace prefix="test" uri="http://foo"/>
Following is another example of a filter that looks for messages where the billing address is within the United States:
<sxc:filtering-router> ... <sxc:filter pattern="/customer/billingaddress/country[text()='US']"/> ...
Document generated by Confluence on Mar 11, 2009 14:57
Page 488
XML Module This page last changed on Feb 23, 2009 by jackie.wheeler.
XML Module [ XML Formats ] [ Transformers ] [ Filters ] [ Splitters ] The XML module contains several tools to help you read, transform, and write XML. In addition to the functionality described on this page, you can also use the SXC Module, which enables efficient XPath XML routing.
XML Formats Mule understands a wide variety of XML Java representations: • • • • • • •
org.w3c.dom.Document, org.w3c.dom.Element org.dom4j.Document javax.xml.transform.Source InputStream, String, byte[] OutputHandler XMLStreamReader org.mule.module.xml.transformer.DelayedResult
Any transformer that accepts XML as an input will also understand these types.
Transformers There are several standard transformers that process XML inside Mule.
Transformer
Description
XmlToObject <-> ObjectToXml
Converts XML to a Java object and back again using XStream.
XSLT
Transforms XML payloads using XSL.
DomToXml <-> XmlToDom
Converts DOM objects to XML and back again.
XmlToXMLStreamReader
Converts XML from a message payload to a StAX XMLStreamReader.
XPath Extractor
Queries and extracts object graphs using XPath expressions using JAXP.
JXPath Extractor
Queries and extracts object graphs using XPath expressions using JXPath.
XmlPrettyPrinter
Allows you to output the XML with controlled formatting, including trimming white space and specifying the indent.
Efficient Transformations with DelayedResult Mule contains a special XML output format called DelayedResult. This format allows very efficient XML transformations by delaying any XML serialization until an OutputStream is available. For example, here is an XSLT transformer set up to use DelayedResult:
Document generated by Confluence on Mar 11, 2009 14:57
Page 489
<mxml:xslt-transformer name="transform-in" xsl-file="xslt/transform.xslt" returnClass="org.mule.module.xml.transformer.DelayedResult"/>
If the result of this transformation were being sent to an HTTP client, the HTTP client would ask Mule for an OutputHandler and pass in the OutputStream to it. Only then would Mule perform the transformation, writing the output directly to the OutputStream. If DelayedResult were not used, the XML result would first be written to an in-memory buffer before being written to the OutputStream. This will cause your XML processing to be slower.
Filters The XML module contains various XPath filters. For general details on how to use filters, see Using Filters.
XPath Filter The XPath filter uses the JAXP libraries to filter XPath expressions. This filter is available as of Mule 2.2. The following configuration routes messages to the "vm://echo" endpoint when the value of "/ e:purchaseOrder/e:shipTo/@country" is "US".
<mule-xml:xpath-filter pattern="/e:purchaseOrder/e:shipTo/@country" expectedValue="US"> <mule-xml:namespace prefix="e" uri="http://www.example.com"/> ....
Schema Validation Filter The schema validation filter uses the JAXP libraries to validate your message against a schema. This filter is available as of Mule 2.2. The following configuration will validate your message against a schema called schema.xsd.
<mule-xml:schema-validation-filter schemaLocations="com/myapp/schemas/schema.xsd com/myapp/ schemas/anotherSchema.xsd"/>
Jaxen Filter The Jaxen filter uses the Jaxen library to filter messages based on XPath expressions. The following configuration routes messages to the "vm://echo" endpoint when the value of "/ e:purchaseOrder/e:shipTo/@country" is "US".
Document generated by Confluence on Mar 11, 2009 14:57
Page 490
<mule-xml:jaxen-filter pattern="/e:purchaseOrder/e:shipTo/@country" expectedValue="US"> <mule-xml:namespace prefix="e" uri="http://www.example.com"/> ....
JXPath Filter The JXPath filter is very similar to the Jaxen filter. It is still used for historical purposes (it existed before the Jaxen filter).
<mule-xml:jxpath-filter pattern="/e:purchaseOrder/e:shipTo/@country" expectedValue="US"> <mule-xml:namespace prefix="e" uri="http://www.example.com"/> ....
Splitters The XML module contains two splitters, a filter-based splitter and a round-robin splitter. For more information on these splitters, see Using Message Routers.
Document generated by Confluence on Mar 11, 2009 14:57
Page 491
DomToXml Transformer This page last changed on Nov 11, 2008 by jackie.wheeler.
DOM/XML Transformers Mule contains several transformers that convert between a W3C DOM object and its serialized representation. The DomToXml transformer converts DOM objects to XML, the XmlToDom transformer converts XML strings to DOM objects, and the DomToOutputHandler transformer converts from a DOM to an OutputHandler serialization. These transformers support the standard transformer attributes plus the following:
Dom To Xml Transformer Converts an XML payload (Document, XML stream, Source, etc.) to a serialized String representation.
Attributes of <dom-to-xml-transformer...>
Name
Type
Required
outputEncoding
string
no
Default
Description The encoding to use for the resulting XML/ Text.
Dom To Output Handler Transformer Converts an XML payload (Document, XML stream, Source, etc.) to an OutputHandler for efficient serialization.
Attributes of <dom-to-output-handler-transformer...>
Name
Type
Required
outputEncoding
string
no
Default
Description The encoding to use for the resulting XML/ Text.
Xml To Dom Transformer Transforms an XML message payload to an org.w3c.dom.Document.
Attributes of <xml-to-dom-transformer...>
Name
Type
Required
outputEncoding
string
no
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description The encoding to use for the resulting XML/ Text.
Page 492
Example To use the DOM/XML transformers, you add them to your Mule XML configuration as follows:
<xm:dom-to-xml-transformer name="DomToXml"/> <xm:xml-to-dom-transformer name="xmlToDom" returnClass="org.w3c.dom.Document" /> <xm:xml-to-output-handler-transformer name="xmlToOutputHandler" />
You can then reference them by name from endpoints:
... ...
Document generated by Confluence on Mar 11, 2009 14:57
Page 493
JXPath Extractor Transformer This page last changed on Feb 09, 2009 by jackie.wheeler.
JXPath Extractor Transformer The JXPath extractor transformer evaluates an XPath expression against the current message and returns the result. By default, a single result will be returned. If multiple values are expected, set the singleResult property to false, which will return a list of values. This property is available for strings only (not XML nodes). You configure the JXPath extractor transformer as follows:
<jxpath-extractor-transformer name="invoice" expression="/book/title" singleResult="false"/>
Document generated by Confluence on Mar 11, 2009 14:57
Page 494
XmlObject Transformers This page last changed on Feb 03, 2009 by jackie.wheeler.
XML-Object Transformers [ Object to XML ] [ XML to Object ] [ Testing the Transformers ] This pair of transformers converts XML code to serialized objects and back again. For serialization of Java XML objects, see DomToXml Transformer.
Object to XML The Object to XML transformer converts any object to XML using XStream. You configure this transformer using the element. It takes the standard transformer attributes plus one additional attribute, acceptUMOMessage, which specifies whether to serialize the whole message to XML and not just its payload. This is useful with transports such as TCP where message headers are not supported and would otherwise be lost. In Mule 2.2, the acceptUMOMessage attribute is named acceptMuleMessage. For example:
<xml:object-to-xml-transformer name="ObjectToXml" acceptUMOMessage="true"/>
You can then reference this transformer from an endpoint:
XML to Object The XML to Object transformer converts XML created by the Object to XML transformer in to a Java object graph using XStream. You configure this transformer using the <xml-to-object-transformer> element. It takes the standard transformer attributes. For example:
<xm:xml-to-object-transformer name="XmlToObject" />
Testing the Transformers The transformers can be tested using functional tests. For example, the following functional test uses FunctionalTestCase, which is part of Mule's Test support, to test the Object to XML transformer.
public class MuleEndpointConfigurationTestCase extends FunctionalTestCase { protected String getConfigResources() {
Document generated by Confluence on Mar 11, 2009 14:57
Page 495
return "org/mule/test/integration/test-endpoints-config.xml"; } ... public void testComponent4Endpoints() throws Exception { // test inbound Service service = muleContext.getRegistry().lookupService("TestComponent4"); assertNotNull(service); assertNotNull(service.getInboundRouter().getEndpoints()); assertEquals(1, service.getInboundRouter().getEndpoints().size()); ImmutableEndpoint endpoint = (ImmutableEndpoint)service.getInboundRouter().getEndpoints().get(0); assertNotNull(endpoint); assertEquals(VMConnector.VM, endpoint.getConnector().getProtocol().toLowerCase()); assertEquals("queue4", endpoint.getEndpointURI().getAddress()); assertFalse(endpoint.getTransformers().isEmpty()); assertTrue(endpoint.getTransformers().get(0) instanceof ObjectToXml); assertTrue(endpoint instanceof InboundEndpoint); } ... }
Document generated by Confluence on Mar 11, 2009 14:57
Page 496
XmlToXMLStreamReader Transformer This page last changed on Nov 04, 2008 by jackie.wheeler.
XmlToXMLStreamReader Transformer The XmlToXMLStreamReader transformer converts XML representations to a StAX XMLStreamReader. XMLStreamReaders allow XML to be parsed as a series of events that are "pulled" from the stream. It is very efficient. This transformer supports the following input formats: • • • • • • • • •
javax.xml.transform.Source.class org.xml.sax.InputSource.class org.dom4j.Document.class org.w3c.dom.Document.class org.w3c.dom.Element.class org.mule.module.xml.transformer.DelayedResult.class String byte[] InputStream
Examples To use the transformer, you must declare a custom transformer element:
<custom-transformer name="XmlToXSR" class="org.mule.module.xml.transformer.XmlToXMLStreamReader"/>
You can also create a "reversible" XMLStreamReader:
<custom-transformer name="XmlToXSR" class="org.mule.module.xml.transformer.XmlToXMLStreamReader"> <property key="reversible" value="true"/>
This allows you to cache XML events and replay them:
MuleMessage message = ...; ReversibleXMLStreamReader xsr = (ReversibleXMLStreamReader) message.getPayload(); // start caching events xsr.setTracking(true); // parse.... while (...) { xsr.next(); } // Go back to the beginning of the XML document xsr.reset(); .... // Don't cache events any more xsr.setTracking(false);
Document generated by Confluence on Mar 11, 2009 14:57
Page 497
XPath Extractor Transformer This page last changed on Feb 09, 2009 by jackie.wheeler.
XPath Extractor Transformer New in Mule 2.2, the XPath extractor transformer evaluates an XPath expression against the current message and returns the result using the JAXP libraries. By default, a string result of the XPath expression is returned. The transformer can be configured to return other types of results such as a Node, NodeSet, Boolean, or Number. You configure the XPath transformer as follows:
<xpath-extractor-transformer name="title" expression="/book/title" resultType="NODESET"/>
Document generated by Confluence on Mar 11, 2009 14:57
Page 498
XSLT Transformer This page last changed on Mar 06, 2009 by jackie.wheeler.
<xslt-transformer ...> The XSLT transformer uses XSLT to transform the message payload. Transformation objects are pooled for better performance. You can set transformation context properties on the transformer and can pull these properties from the message using Expression Evaluators. This works in a very similar way to the XQuery Transformer on MuleForge.
Attributes
Name
Type
outputEncoding
Required
Default
Description
string
no
The encoding to use for the resulting XML/ Text.
maxIdleTransformers
integer
no
Transformers are pooled for better throughput, since performing and XSL transformation can be expensive. This attribute controls how many instances will remain idle in the transformer pool.
maxActiveTransformers
integer
no
The total number of XSLT transformers that will get pooled at any given time.
string
no
The full path to the XSL template file to use when performing the transformation. This can be a path on the local file system or on the classpath. This attribute is not required if the <xslt-text> element has been set.
name (no spaces)
no
The URI resolver to use when validating the XSL output. If not set, a default resolver will be used that checks for
xsl-file
uriResolver
Document generated by Confluence on Mar 11, 2009 14:57
Page 499
resources on the local file system and classpath. transformerFactoryClass name (no spaces)
no
The fully qualified class name of the {{javax.xml.TransformerFactory instance to use. If not specified, the default JDK factory {{TransformerFactory.newInsta will be used.
Child Elements
Name
Cardinality
Description
xslt-text
0..1
The inline XSLT script definition. This is not required if the {{xsltfile}} attribute is set.
context-property
0..*
A property that wil be made available to the transform context. Expression Evaluators can be used to grab these properties from the message at runtime.
Example The following example demonstrates how to configure an inline XSLT transformer pulling parameters from the current message. To use the XSLT transformer, you add it to your Mule XML configuration as follows:
<mulexml:xslt-transformer name="xslt"> <mulexml:xslt-text> <xsl:stylesheet version="2.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> <xsl:output method="xml"/> <xsl:param name="title"/> <xsl:param name="rating"/> <xsl:template match="catalog"> <xsl:element name="cd-listings"> <xsl:attribute name="title"> <xsl:value-of select="$title"/> <xsl:attribute name="rating"> <xsl:value-of select="$rating"/> <xsl:apply-templates/> <xsl:template match="cd"> <xsl:element name="cd-title"> <xsl:value-of select = "title" />
Document generated by Confluence on Mar 11, 2009 14:57
Page 500
<mulexml:context-property key="title" value="#[header:ListTitle]"/> <mulexml:context-property key="rating" value="#[header:ListRating]"/>
This example configures a transformer using inline XSLT expressions. It also defines two context parameters:
<mulexml:context-property key="title" value="#[header:ListTitle]"/> <mulexml:context-property key="rating" value="#[header:ListRating]"/>
These parameters are pulled from the current message and made available in the XSLT context so that they can be referenced in your XSLT statements. You can use any valid expression. In this example, the header evaluator is used to pull a header from the current message. Your configured XSLT transformer can be referenced by an endpoint. In the following example, the result is written to System.out. The test data looks like this:
Empire Burlesque <artist>Bob Dylan USA Columbia <price>10.90 1985 Hide your heart <artist>Bonnie Tyler UK CBS Records <price>9.90 1988
The result written to System.out looks like this:
Empire Burlesque Hide your heart
The full configuration for this example is shown below. Click here to expand...
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:mule="http://www.mulesource.org/schema/mule/core/2.2" xmlns:mulexml="http://www.mulesource.org/schema/mule/xml/2.2" xmlns:vm="http://www.mulesource.org/schema/mule/vm/2.2" xmlns:stdio="http://www.mulesource.org/schema/mule/stdio/2.2" xmlns:spring="http://www.springframework.org/schema/beans"
Document generated by Confluence on Mar 11, 2009 14:57
Page 501
xsi:schemaLocation=" http://www.mulesource.org/schema/mule/core/2.2 http://www.mulesource.org/schema/mule/core/2.2/ mule.xsd http://www.mulesource.org/schema/mule/vm/2.2 http://www.mulesource.org/schema/mule/vm/2.2/ mule-vm.xsd http://www.mulesource.org/schema/mule/stdio/2.2 http://www.mulesource.org/schema/mule/stdio/2.2/ mule-stdio.xsd http://www.mulesource.org/schema/mule/xml/2.2 http://www.mulesource.org/schema/mule/xml/2.2/ mule-xml.xsd http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/springbeans-2.5.xsd"> <mulexml:xslt-transformer name="xslt"> <mulexml:xslt-text> <xsl:stylesheet version="2.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> <xsl:output method="xml"/> <xsl:param name="title"/> <xsl:param name="rating"/> <xsl:template match="catalog"> <xsl:element name="cd-listings"> <xsl:attribute name="title"> <xsl:value-of select="$title"/> <xsl:attribute name="rating"> <xsl:value-of select="$rating"/> <xsl:apply-templates/> <xsl:template match="cd"> <xsl:element name="cd-title"> <xsl:value-of select = "title" /> <mulexml:context-property key="title" value="#[header:ListTitle]"/> <mulexml:context-property key="rating" value="#[header:ListRating]"/> <model name="main"> <service name="Echo"> <echo-component/> <pass-through-router> <stdio:outbound-endpoint system="OUT"/>
Testing the Transformer This transformer can be tested using the following functional test. Note that it uses FunctionalTestCase, which is part of Mule's Test support. Click here to expand...
Document generated by Confluence on Mar 11, 2009 14:57
Page 502
public class XSLTWikiDocsTestCase extends FunctionalTestCase { protected String getConfigResources() { return "org/mule/test/integration/xml/xslt-functional-test.xml"; } public void testMessageTransform() throws Exception { //We're using Xml Unit to compare results //Ignore whitespace and comments XMLUnit.setIgnoreWhitespace(true); XMLUnit.setIgnoreComments(true); //Read in src and result data String srcData = IOUtils.getResourceAsString( "org/mule/test/integration/xml/cd-catalog.xml", getClass()); String resultData = IOUtils.getResourceAsString( "org/mule/test/integration/xml/cd-catalog-result-with-params.xml", getClass()); //Create a new Mule Client MuleClient client = new MuleClient(); //These are the message roperties that will get passed into the XQuery context Map props = new HashMap(); props.put("ListTitle", "MyList"); props.put("ListRating", new Integer(6)); //Invoke the service MuleMessage message = client.send("vm://test.in", srcData, props); assertNotNull(message); assertNull(message.getExceptionPayload()); //Compare results assertTrue(XMLUnit.compareXML(message.getPayloadAsString(), resultData).similar()); } }
Document generated by Confluence on Mar 11, 2009 14:57
Page 503
Using Mule with Spring This page last changed on Nov 21, 2008 by tcarlson.
Using Mule with Spring Mule and Spring can integrate on different levels. You can can choose as much or little Mule in your Spring application or Spring in your Mule application. The following pages describe in detail how you can use Mule and Spring together. • XML Configuration The default way to configure Mule is via a Spring 2.0 XML file. • Spring Application Contexts Describes different options for how Mule creates and manages Spring Application Contexts. • Using Spring Beans as Service Components How to configure Spring beans as service components in Mule. • Sending and Receiving Mule Events in Spring A really easy way for your beans to send and receive Mule events via the Spring Application Context without any code changes. • Spring Remoting An example of accessing Mule from an external application using Spring remoting. Additionally, there are two Spring-related projects in the Developer Sandbox.
Document generated by Confluence on Mar 11, 2009 14:57
Page 504
Sending and Receiving Mule Events in Spring This page last changed on Aug 01, 2008 by jackie.wheeler.
Sending and Receiving Mule Events in Spring You can configure Spring beans to publish events to Mule and configure Spring event listeners to receive Mule events. This page describes how to set up the configuration.
Spring Events Overview Spring provides a simple mechanism for sending and receiving events between beans. To receive an event, a bean implements ApplicationListener, which has a single method:
public void onEvent(ApplicationEvent event);
To publish events to listeners, you call the publishEvent() method on the ApplicationContext. This will publish the same event to every listener in the context. You can also plug in custom event handlers to the application context.
Mule Events in Spring To start receiving Mule events, you create a bean based on MuleEventMulticaster in your Mule configuration file. This class is an Application Event Multicaster that enables Spring beans to send and receive Mule events. You also add one or more endpoints on which to receive events:
xmlns:spring="http://www.springframework.org/schema/beans" ... <spring:beans> <spring:bean id="applicationEventMulticaster" class="org.mule.module.spring.events.MuleEventMulticaster"> <spring:property name="subscriptions"> <spring:list> <spring:value>jms://my.queue <spring:value>pop3://ross:[email protected]
With this configuration, any emails received for [email protected] or any JMS messages sent to my.queue will be received by all Spring event listeners. Note that the MuleEventMulticaster does not interfere with normal Spring event behavior. If a non-Mule applicationEvent is sent via the ApplicationContext, all beans registered to receive events will still get the event. The inbound endpoints can be any valid Mule Endpoint, so you can receive JMS messages, SOAP requests, files, HTTP and servlet requests, TCP, multicast, and more.
Adding Bean Subscriptions You can have beans subscribe only to relevant events. The MuleSubscriptionEventListener includes two methods for getting and setting an array of endpoints on which the bean will receive events.
package org.mule.module.spring.events; public class TestSubscriptionEventBean extends TestMuleEventBean implements MuleSubscriptionEventListener
Document generated by Confluence on Mar 11, 2009 14:57
Page 505
{ private String[] subscriptions; public void setSubscriptions(String[] subscriptions) { this.subscriptions = subscriptions; } public String[] getSubscriptions() { return subscriptions; } }
You configure this bean like any other bean:
xmlns:spring="http://www.springframework.org/schema/beans" ... <spring:beans> <spring:bean id="subscriptionBean" class="org.mule.module.spring.events.TestSubscriptionEventBean"> <spring:property name="subscriptions"> <spring:list> <spring:value>vm://event.*
Publishing Events to Mule Publishing events is just as easy as receiving them. You use the standard publishEvent() method on the application context. Your bean can get a reference to the application context by implementing ApplicationContextAware or by querying MuleApplicationEvent .
//Create a new MuleEvent. Object message = new String("This is a test message"); MuleApplicationEvent muleEvent = new MuleApplicationEvent( message, "jms://processed.queue"); //Call publishEvent on the application context, and Mule does the rest applicationContext.publishEvent(muleEvent);
For more information on publishing events, see the Error Handler Example.
Document generated by Confluence on Mar 11, 2009 14:57
Page 506
Spring Application Contexts This page last changed on Mar 05, 2009 by jackie.wheeler.
Spring Application Contexts [ Single Application Context ] [ Multiple Application Contexts ] [ Using an Existing Application Context ] [ Using an Existing Application Context as Parent ] This page describes the options available for controlling how Mule creates and manages Spring application contexts for your application.
Single Application Context By default, Mule will combine all resource files into a single ApplicationContext, whether they are "pure" Spring files or Mule configuration files. For example, the following code will create a single application context consisting of the objects in spring-beans.xml plus the objects in mule-config.xml:
MuleContext muleContext = new DefaultMuleContextFactory().createMuleContext(); ConfigurationBuilder builder = new SpringXmlConfigurationBuilder("spring-beans.xml, mule-config.xml"); builder.configure(muleContext); muleContext.start();
Or, in a more abbreviated form:
MuleContext muleContext = new DefaultMuleContextFactory().createMuleContext( new SpringXmlConfigurationBuilder("spring-beans.xml, mule-config.xml")); muleContext.start();
Multiple Application Contexts (Since 2.1.0) You can instruct Mule to create a separate application context for each Mule configuration file. The following code will create two application contexts, one for each configuration resource:
MuleContext muleContext = new DefaultMuleContextFactory().createMuleContext(); ConfigurationBuilder builder1 = new SpringXmlConfigurationBuilder("spring-beans.xml"); builder1.configure(muleContext); ConfigurationBuilder builder2 = new SpringXmlConfigurationBuilder("mule-config.xml"); builder2.configure(muleContext); muleContext.start();
Using an Existing Application Context (Since 2.1.2) If you already have an application context, you can instruct Mule to use it as follows:
Document generated by Confluence on Mar 11, 2009 14:57
Page 507
ApplicationContext myAppContext = getMyAppContextFromSomewhereElse(); MuleContext muleContext = new DefaultMuleContextFactory().createMuleContext(); ConfigurationBuilder builder1 = new SpringConfigurationBuilder(myAppContext); builder1.configure(muleContext); ConfigurationBuilder builder2 = new SpringXmlConfigurationBuilder("mule-config.xml"); builder2.configure(muleContext); muleContext.start();
Using an Existing Application Context as Parent (Since 2.1.2) You can designate an existing application context as a parent context for Mule, so that the Mule configuration can refer to and/or override beans in the application context:
ApplicationContext myAppContext = getMyAppContextFromSomewhereElse(); MuleContext muleContext = new DefaultMuleContextFactory().createMuleContext(); ConfigurationBuilder builder = new SpringXmlConfigurationBuilder("mule-config.xml"); builder.setParentContext(myAppContext); builder.configure(muleContext); muleContext.start();
As of Mule 2.2, the MuleXmlBuilderContextListener class checks to see if an application context (WebApplicationContext) has already been created by Spring, and if there is one, Mule uses it as the parent automatically.
Document generated by Confluence on Mar 11, 2009 14:57
Page 508
Using Spring Beans as Service Components This page last changed on Oct 10, 2008 by jackie.wheeler.
Using Spring Beans as Service Components [ Defining the Beans ] [ Configuring the Beans ] [ Configuring the Component ] [ Using JNDI and EJB Session Beans ] You can construct service components from Spring beans that you define in a separate Spring context file or right in the Mule configuration file. This pages provides an example using two beans; a RestaurantWaiter bean that receives and logs orders and then passes them to the KitchenService bean, which receives the orders.
Defining the Beans The Java code for the beans look like this:
public class RestaurantWaiter { private KitchenService kitchen = null; public void takeOrder(Order order) { //log order //notify kitchen this.kitchen.submitOrder(order); } public void setKitchenService(KitchenService kitchen) { this.kitchen = kitchen; } public KitchenService getKitchenService() { return kitchen; } }
Configuring the Beans First, you configure the beans in your Spring application context:
<property name="kitchenService">
We now have beans called restaurantWaiter and kitchenService that will be created by Spring. Notice the resturantWaiter bean scope is set to prototype (by default, all beans in Spring are singletons unless specified otherwise). This is important because Mule will pool your components, and telling Spring not to create a singleton ensures that each pooled instance will be a unique instance.
Document generated by Confluence on Mar 11, 2009 14:57
Page 509
If you want to configure the beans right in your Mule configuration file instead of in a separate Spring context file, you could specify them like this:
xmlns:spring="http://www.springframework.org/schema/beans" ... <spring:beans> <spring:bean id="restaurantWaiter" scope="prototype" class="com.foo.RestaurantWaiter"> <spring:property name="kitchenService"> <spring:ref local="kitchenService"/> <spring:bean id="kitchenService" class="com.foo.KitchenService"/>
Configuring the Component After you have configured the beans, you can create your reference to restaurantWaiter in the component. For example, the following configuration creates a component that will enable restaurantWaiter to receive events from VM. This example assumes the beans are in a separate file, so if you configured them right in the Mule configuration file, you do not need the <spring:import> tag.
xmlns:vm="http://www.mulesource.org/schema/mule/vm/2.0" xmlns:spring="http://www.springframework.org/schema/beans" ... <spring:import resource="conf/applicationContext.xml"/> ... <service name="Restaurant Waiter"> <pooled-component> <spring-object bean="restaurantWaiter"/>
When the Mule server starts, each of the <service> elements are loaded, and the bean you specified in the <spring-object> tag is created. When an event is received on vm://orders.queue, an Order object is passed to the takeOrder() method on the RestaurantWaiter, which then logs the order and passes it to the KitchenService. For more information on component configuration, see Configuring Components. For more information on the elements you use to configure components, see Component Configuration Reference.
Using JNDI and EJB Session Beans If you define JNDI and EJB session beans in Spring using the generic element, you configure them exactly as any other Spring bean in Mule. However, if you use the <jee> elements to define them in Spring (<jee:jndi-lookup>, <jee:local-slsb>, and <jee:remote-slsb>), you must include the jee namespace and schema locations in your Mule configuration file as follows:
xmlns:jee="http://www.springframework.org/schema/jee" xsi:schemaLocation=" ... http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee-2.5.xsd" ... <jee:remote-slsb id="creditAgencyEJB" jndi-name="local/CreditAgency"
Document generated by Confluence on Mar 11, 2009 14:57
Page 510
business-interface="org.mule.example.loanbroker.credit.CreditAgency"> <jee:environment> java.naming.factory.initial=org.openejb.client.LocalInitialContextFactory java.naming.provider.url=rmi://localhost:1099 openejb.base=${openejb.base} openejb.configuration=${openejb.configuration} logging.conf=${logging.conf} openejb.nobanner=${openejb.nobanner} ... <mule:service name="CreditAgencyService"> <mule:inbound> <mule:inbound-endpoint ref="CreditAgency" /> <mule:component> <mule:spring-object bean="creditAgencyEJB" /> ...
For more information, see Enterprise Java Beans (EJB) integration and the jee schema reference on the Spring site.
Document generated by Confluence on Mar 11, 2009 14:57
Page 511
Using the Mule Client This page last changed on Feb 26, 2009 by jackie.wheeler.
Using the Mule Client [ Using Send and Dispatch ] [ Configuring the Mule Client ] [ MuleClient as a Web Services Client ] [ Performing an Event Request Call ] [ Associating Properties with the Message ] [ When Not to Use the Mule Client ] [ Handling Message Collections ] [ Future Results ] [ Using the Remote Dispatcher ] [ Sending Messages to Components Directly ] In most Mule applications, messages are triggered by an external occurrence such as a message being received on a queue or a file being copied to a directory. However, if you want to send and receive messages programmatically, you can create a Mule client. The Mule client is a simple interface for Java clients to send and receive messages from a Mule server and other applications. The client serves the following functions: • Sending and receiving messages to and from a local or remote Mule server • Communicating with other applications using any Mule transport • Making requests to a Mule server behind a firewall using the RemoteDispatcher The Mule client can be used as a web services client to make SOAP requests using popular SOAP implementations such as Apache CXF. It can also send messages directly to a service component and bypass the transports layer completely, which is useful for testing your service components or when triggering an event from a script or JSP page. The Mule client can be used with any of the Mule transports, making it a universal client for many types of transports such as JDBC, JMS, FILE, POP3, XMPP, HTTP, etc. The following sections describe how to use the MuleClient in various scenarios.
Using Send and Dispatch The Mule client allows the user to send and receive messages programmatically. For example, to send a JMS message to any application or Mule component listening on my.queue, you can use the dispatch() method. The dispatch() method provides the ability to "fire and forget" messages over an endpoint.
MuleClient client = new MuleClient(); client.dispatch("jms://my.queue", "Message Payload" null);
To make a regular synchronous call to a service and receive a result, you can use the send() method:
MuleClient client = new MuleClient(); MuleMessage result = client.send("tcp://localhost:3456", "Message Payload", null);
The client send() and dispatch() methods expect the following arguments: 1. The Mule URL endpoint: any valid Mule Endpoint used to determine the transport, endpoint, and other information about delivery of the message. This can also be an endpoint name stored in configuration. 2. The message payload: any object carried by the message. 3. Properties: any properties or meta-data to associate with the message being sent Don't use physical endpoints in your code
Document generated by Confluence on Mar 11, 2009 14:57
Page 512
For clarity, the examples on this page use a physical endpoint URI, such as jms://myQueue. However, it is much better practice to define all your endpoints inside a Mule configuration file using the <endpoint> tag and then reference those endpoint names in your code.
Configuring the Mule Client If you are using the Mule client in the same classloader (e.g., a Web App or Mule stand-alone), the client will have access to the server configuration. For example, if you had some endpoints defined in your server configuration file:
This endpoint will be accessible by the Mule client:
MuleClient client = new MuleClient(); client.dispatch("serviceEndpoint", dataObject, null);
Essentially, the Mule client will have the same configuration information as the Mule server, since they will both have access to the same registry. If you are running the Mule client in stand-alone mode, you can still configure it using its own Mule XML configuration file(s). You pass in these files when the client is created:
MuleClient client = new MuleClient("http-client-config.xml, shared-client-config.xml"); client.getMuleContext().start();
Note that you must start the local Mule context used by the client. You can also create your own Mule context and pass it into the client:
//Create a MuleContextFactory MuleContextFactory muleContextFactory = new DefaultMuleContextFactory(); //create the configuration builder and optionally pass in one or more of these ConfigurationBuilder builder = new SpringConfigurationBuilder("http-client-config.xml, shared-client-config.xml")); //The actual context builder to use MuleContextBuilder contextBuilder = new DefaultMuleContextBuilder(); //Create the context MuleContext context = muleContextFactory.createMuleContext(builder, contextBuilder); //Start the context context.start(); //Create the client with the context MuleClient client = new MuleClient(context);
MuleClient as a Web Services Client The Mule client can be used as a web services client to make SOAP requests using popular SOAP implementations such as Apache Axis or CXF.
Document generated by Confluence on Mar 11, 2009 14:57
Page 513
MuleClient client = new MuleClient(); //Arguments for the addPerson WS method String[] args = new String[]{"Ross", "Mason"}; //Call the web service client.dispatch("axis:http://localhost:38004/PersonService?method=addPerson", args, null); //Call another method to look up the newly added person MuleMessage result = client.send ("axis:http://localhost:38004/PersonService?method=getPerson", "Ross", null); //A person object is returned, and all type mapping is handled for you Person person (Person)result.getPayload(); System.out.println(person.toString());
The Mule SOAP Transport supports Apache Axis and CXF. For more information about Mule Axis support, see Axis Web Services and Mule.
Performing an Event Request Call Making a request to an endpoint is useful when using a transport that has a store of events that you want to request rather then have a listener on the resource. To make a request for a message, use the request() method:
MuleClient client = new MuleClient(); MuleMessage result = client.request("pop3://ross:[email protected]", 5000);
This code will attempt to receive a message from a mailbox called ross on mail.my.org and will return after five seconds if no message was received. Calling request() works for all Mule supported transports, but it is more usual to make event request calls where there is a store to be queried such as a queue, file directory, or some other repository.
Associating Properties with the Message The previous examples set the properties argument to null. Properties can be arbitrary, such as to pass around custom metadata with your messages, or they can be transport-specific. The following example demonstrates an asynchronous request/response using JMS and the JMS-specific JMSReplyTo property. When the JMSReplyTo is set, it is stated in the JMS spec that a receiver of the message should send back any results to the destination defined in the JMSReplyTo header. Mule does this for you.
//create the client instance MuleClient client = new MuleClient(); //create properties to associate with the message Map props = new HashMap(); //Set the JMSReplyTo property, which is where the response message will be sent props.put("JMSReplyTo", "replyTo.queue"); //dispatch the message asynchronously client.dispatch("jms://test.queue", "Test Client Dispatch message", props);
Document generated by Confluence on Mar 11, 2009 14:57
Page 514
//Receive the return message on the replyTo.queue MuleMessage message = client.request("jms://replyTo.queue", 5000); //This is the message sent back from the first component to process our message System.out.println(message.getPayload());
When Not to Use the Mule Client It's generally not good practice to make calls using the Mule client from your service objects or within extensions to Mule such as routers or transformers. When you need to dispatch or request events in Mule, you should use the current org.mule.api.MuleEventContext and call the send/dispatch/request methods on the context instead. To gain access to the MuleEventContext inside your services, you can implement the org.mule.api.lifecycle.Callable interface. If you need to make an event request from a transformer, filter, or interceptor, you should reconsider your design strategy for that event flow.
Handling Message Collections Since Mule 2.1, some outbound routers such as the Message Splitter, Multicaster, and Recipient List may return more that one result message in the following cases: • There is more than one endpoint configured on the router • More than one of the endpoints has the synchronous=true attribute set To handle situations where multiple results occur, Mule has introduced a new message type org.mule.api.MuleMessageCollection . This type of message contains all message results in the order they were received. Note that org.mule.api.MuleMessageCollection extends org.mule.api.MuleMessage , so the interface is similar. If there are multiple results, the MuleMessage.getPayload() method returns a java.util.List containing the payloads of each of the returned messages. When using the Mule client, you can cast the message return type to get access to all MuleMessage objects.
MuleClient client = new MuleClient(); MuleMessage result = client.send("myEndpoint", "some data", null); if(result instanceof MuleMessageCollection) { MuleMessageCollection resultsCollection = (MuleMessageCollection)result; System.out.println("Number of messages: " + resultsCollection.size()); MuleMessage[] messages = resultsCollection.getMessagesAsArray(); }
Future Results The Mule client allows you to make synchronous calls without blocking by using the sendAsync() method, which returns a FutureMessageResult that can be queried later.
MuleClient client = new MuleClient(); FutureMessageResult result = client.sendAsync("http://localhost:8881", "Message Payload", null); //Do some more stuff here
Document generated by Confluence on Mar 11, 2009 14:57
Page 515
if(result.isready()) { Object payload = result.getMessage().getPayload(); }
The FutureMessageResult returned is a placeholder for the real result message when the call returns. By using a future result, you can continue with other tasks while the remote call executes. Calling getMessage() will block until the call returns. Optionally, you can specify a timeout of how long to wait (as shown in the example). You can also check if the call has returned using result.isReady().
Using the Remote Dispatcher The Mule client can connect to, send, and receive messages from a remote Mule server through a firewall using a remote dispatcher. This should only be used when the remote service being invoked does not expose an endpoint accessible by the Mule client. Note that there is performance overhead when using the remote dispatcher, because all requests and responses are serialized, sent to the server, and deserialized before the real invocation is made from within the firewall. To use the remote dispatcher, you enable it on the server instance by configuring the remote dispatcher agent. You can ensure that the server can handle both asynchronous and synchronous calls by setting the synchronous attribute to true. You can also set the responseTimeout setting, although often it is better to control it at the MuleClient call level, as each call might have a different timeout requirement.
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:client="http://www.mulesource.org/schema/mule/client/2.2" xsi:schemaLocation=" http://www.mulesource.org/schema/mule/client/2.2 http://www.mulesource.org/schema/mule/ client/2.2/mule-client.xsd http://www.mulesource.org/schema/mule/core/2.2 http://www.mulesource.org/schema/mule/core/2.2/ mule.xsd"> ... ...
On the client side, you can now communicate with the remote server via the remote dispatcher agent. For example:
MuleClient client = new MuleClient(); RemoteDispatcher dispatcher = client.getRemoteDispatcher("http://localhost:81");
MuleMessage result = dispatcher.sendToRemoteComponent("StockManager", "give me the price of XXX", null); StockQuote sq = (StockQuote)result.getPayload();
The Mule client executes the StockManager component on a remote Mule server, returning the result to the client. Mule handles all the call marshalling. The first null argument is an optional string of commaseparated transformers to use on the result message. The second null argument contains properties associated with the request. If you do not want to wait for the result to be returned from the remote server, you can use the sendAsyncToRemoteComponent() method, which returns a FutureMessageResult:
Document generated by Confluence on Mar 11, 2009 14:57
Page 516
MuleClient client = new MuleClient(); RemoteDispatcher dispatcher = client.getRemoteDispatcher("tcp://localhost:60504"); FutureMessageResult result = dispatcher.sendAsyncToRemoteComponent("StockManager", null, "give me the price of XXX", null); //do some other stuff StockQuote sq = (StockQuote)result.getMessage(1000).getPayload();
Specifying the Wire Format You can specify the wire format to use for dispatching messages by configuring one of the following: • <xml-wire-format>: uses the XML-Object transformers • <serialization-wire-format>: uses the ByteArray-Serializable transformers • <custom-wire-format>: set the class attribute to the class file of the transformer you want to use. If you do not set the wire format, the serialization format is used. For more information on transformers, see Using Transformers. For example:
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:client="http://www.mulesource.org/schema/mule/client/2.2" xsi:schemaLocation=" http://www.mulesource.org/schema/mule/client/2.2 http://www.mulesource.org/schema/mule/ client/2.2/mule-client.xsd http://www.mulesource.org/schema/mule/core/2.2 http://www.mulesource.org/schema/mule/core/2.2/ mule.xsd"> ... ...
Sending Messages to Components Directly The Mule client provides a convenient way to send a message directly to a component without needing to use a transport when the Mule server is running in the same classloader as the client. This approach can be very useful in testing as well as triggering messages from a JSP page or JavaScript. For example, to dispatch a message directly to your stock quote component called StockManager, you would do the following:
MuleClient client = new MuleClient(); MuleMessage result = client.sendDirect("StockManager", null, "give me the price of XXX", null); StockQuote sq = (StockQuote)result.getPayload();
Document generated by Confluence on Mar 11, 2009 14:57
Page 517
Note that the call is sendDirect, which tells the Mule client to go directly to the component and not through a transport. You can specify a comma-separated list of transformers to use in the second argument of this call.
Document generated by Confluence on Mar 11, 2009 14:57
Page 518
Using the Mule RESTpack This page last changed on Oct 10, 2008 by jackie.wheeler.
Using the Mule RESTpack [ Understanding REST ] [ Architecting RESTful Applications ] [ Mule REST Connectors ] The Mule RESTpack is geared toward helping you build RESTful applications with Mule. REST is a very powerful concept that enables scalable, decentralized growth.
Understanding REST REST can be confusing. For an introduction to its advantages, disadvantages, and notes on using it, see Making Sense of REST.
Architecting RESTful Applications Mule is well suited for building RESTful applications, as it can easily bridge between the web and nearly anything else in your enterprise. For more information on architecture considerations when using REST with Mule, see Architecting RESTful HTTP applications.
Mule REST Connectors The Mule RESTpack uses a series of connectors for building RESTful services. This section describes each connector and links to more information on downloading and using them.
HTTP Connector The Mule HTTP Transport contains most of the basic HTTP functionality that the connectors in the RESTpack build on, including: • Client and Server HTTP transport • Support for running over a Servlet • Support for polling resources via the PollingHttpMessageReceiver The Mule HTTP transport is included with your Mule installation.
Apache Abdera Connector The Mule Abdera connector makes it possible to integrate easily with Atom feeds and Atom Publishing Protocol servers via the Apache Abdera project. The connector supports consuming Atom feeds, publishing of Atom entries and server side AtomPub service. To download and learn about using the Mule Abdera connector, go to the MuleForge Abdera page.
Jersey JAX-RS Connector Jersey is the open source JAX-RS (JSR 311) reference implementation for building RESTful web services via simple annotations. The Mule Jersey connector enables developers to embed these JAX-RS services inside of Mule. To download and learn about using the Mule Jersey connector, go to the MuleForge Jersey page.
Restlet Connector Restlet is an open source REST framework, providing a powerful abstraction for building and consuming RESTful services. The Mule Restlet connector facilitates the deployment and consumption of RESTful
Document generated by Confluence on Mar 11, 2009 14:57
Page 519
services using the Restlet APIs inside of Mule. In addition, the transport exploits Restlet's simple URL routing engine to provide RESTful routing of messages to Mule services. To download and learn about using the Restlet connector, go to the MuleForge Restlet page.
Document generated by Confluence on Mar 11, 2009 14:57
Page 520
Architecting RESTful HTTP applications This page last changed on Oct 10, 2008 by jackie.wheeler.
Architecting RESTful HTTP Applications [ Modeling services and data ] [ Reliability ] [ Security ]
Modeling services and data An important step in achieving the benefits REST has to offer is modeling your services and data correctly. It is very different from the typical RPC (Remote Procedure Call) mindset that most people are used to. It is however similar to object-oriented programming. Imagine that each resource is an object. You can then perform the following operations on this object:
Operation
Description
Get()
Get a representation of the resource. This is a safe operation. It does not change the state of the resource.
Post(Representation)
Perform an unsafe operation that changes the state of the server and puts a new resources somewhere or modifies an existing resource.
Put(Representation)
Store a new representation of the resource.
Delete()
Delete the resource
Head()
Get metadata about the resource. This is a safe operation. It does not change the state of the resource
Options()
Get information about which operations are available to be used on the resource. This is a safe operation. It does not change the state of the resource.
Modeling your application can be broken down into roughly four steps: 1. Decompose your application into resources whose state you wish to access and modify. 2. Define the applicable operations of each resource 3. Give each resource a URI 4. Decide how to represent each resource
Decompose the application into resources Anything inside your application can be a resource. So how do you decide what resources to create? Typically you'll want to make a piece of your application a resource if: 1. You wish to link to that specific piece of data 2. You wish to modify or delete the data the resource represents The prototypical example is often a CRUD based application. For instance, you may have a database of orders which need to be fulfilled. If this was to be broken down into resources, you may have a "/orders" URI for listing the contents of the orders database. You would also have an individual resource for each order (i.e. "/order/1") which could be accessed, modified or deleted.
Document generated by Confluence on Mar 11, 2009 14:57
Page 521
Give Each Resource a URI Define the applicable methods of each resource After (or while) breaking down your application into resources, you must determine which HTTP methods you wish to support. It is very important that you respect the semantics of each HTTP method. GET, HEAD, and OPTIONS are safe. PUT and DELETE are idempotent. POST is unsafe and may have sideeffects. See the section on reliability for an explanation of how to apply these methods to build a robust service.
Decide how to represent each resource There are many different data types you can choose to represent your resource. Many times you will not have to think about what data type to use as it will be obvious. For instance, if you store an image of a product in the database - the typical way to serve that would be return an image type, i.e. "image/jpeg". A structured data type such as XML would make no sense. For structured data, the choices are more complex. There is XML, specific formats of XML such as Atom, JSON, XHTML, CSV, etc. On top of this, you may wish to multiple different representations of the resource as well. The most common formats for structured data are XML, Atom, JSON and XHTML. The table below gives a quick summary of these formats and when you may wish to consider applying them. XML XML is the universal data format. Every system can understand it. It also has advanced tools for modeling, parsing and querying such as XML schema, XPath, and XQuery. It is typically slower than other formats as it is verbose, but can perform well for most applications. Atom Atom is a standard XML format for syndication. An Atom feed contains a series of entries. Each entry has a place for a title, last update time, summary, content, authors, and more. It also allows extensions for proprietary fields. Atom inherits all the benefits of XML, but introduces another very important property - it is universally understood. If a user or machine understands Atom, it automatically understands your application to some degree. JSON JSON stands for JavaScript Object Notation. One of its great advantages is that it is itself JavaScript. This means that it becomes trivial to parse and use JSON inside a JavaScript application - especially when compared to navigating XML. It is also extremely simple. It does not have the concept of namespaces nor does it have modeling tools XML schema. XHTML Over the recent years Microformats have arise as a very powerful alternative to XML based data. Microformats create a standard XHTML representation for data which allows it to both be parsed reliably by machines and be used inside a web browser. Consider using a data format whenever possible as it often allows you to tackle two birds with one stone.
Reliability An important part of distributed system design is dealing with problems that occur in between the client and the server it is talking to. Some examples of this include proxies going down or connections being dropped. HTTP does not have an inbuilt mechanism for achieving reliable deliveries of messages. Instead, reliability is typically achieved through idempotent operations. An idempotent operation is one that can be repeated over and over and still yield the same result. In the case of HTTP, this means that a message can be sent again and again until confirmation is received. Even if the message is received twice, the ultimate result, changing the resource state, will be the same. Let us say that you want to update a resource which represents a customer - maybe they've changed their address. In this case you would want to PUT the new representation to this resource which contains
Document generated by Confluence on Mar 11, 2009 14:57
Page 522
the new address. If a connection drops and an error occurs, you can simply try putting the message again as the operation is idempotent. The same concept can be applied to the DELETE operation. The DELETE request can simply be repeated it succeeds. Creating new resources is trickier to do reliably in a RESTful manner. Typically resources are created with a POST message. A simple example might go like this: you create a new order by POSTing the representation to the "/orders" resource. You would then be redirected to the new resource. What happens if the connection drops here though? You are not sure if the new order resource has been created. If you simply retry the POST you could end up with two orders, which would be less than idea. The trick is to use a two step process. First, the client must do a POST to the "/orders" resource with no data. The server will then respond with a Location header which contains a new URL that the order can be PUT to. TODO: put code example in confluence Now reliability can be achieved by simply repeating each step until it succeeds. If the POST fails and the client submits the POST again, the worst that can happen is the creation of a URL that is not used. These URLs can either be ignored or they can be expired. If the PUT fails, it can simply be retried. There is a limitation of the above approach for reliability though - message ordering is not preserved. To preserve message ordering, you will have to develop application specific extensions or move to a technology like HTTPR or WS-ReliableMessaging.
Security There are many options to provide security to your application depending on your requirements.
Authentication HTTP has built in support for authentication. The "basic" and "digest" mechanisms are the most commonly used authentication mechanisms. Basic authentication passes a username and password in plain text to the server. Because of this, it should only be used over an SSL connection. Digest authentication sends the username as plain text and an MD5 checksum of the password. Another option for authentication is to use client side certificates with SSL. If the server has a copy of the client's public key, it can verify that the messages were in encrypted with that key, and hence from the client.
Privacy The most often used mechanism for message privacy is SSL. It is efficient and widely supported. Other alternatives include the message level security mechanisms mentioned below.
Limitations of SSL There are two primary limitations of using SSL. First, it does not work well with intermediaries. Imagine a situation where a gateway handles the SSL processing. In this case, your application will receive none of the SSL information. This means you cannot use SSL certificates to verify who the client/server is and that there may be unsecured routes along the network. Second, there is limited ability for other authentication tokens, such as SAML.
Message level security If you need message level security XML Signature/Encryption is one of your few options. This does constrain you to use an XML data format though. Another option that has been discussed is S/MIME. This has many disadvantages to it though which are discussed here.
Document generated by Confluence on Mar 11, 2009 14:57
Page 523
Making Sense of REST This page last changed on Oct 10, 2008 by jackie.wheeler.
Making Sense of REST [ Advantages of RESTful Architectures and Implementations ] [ Disadvantages of RESTful Architectures and Implementations ] [ Notes on Building Your Application with WS-* or RESTful HTTP ] REST is the formalized architecture of HTTP based on the concepts of resources, links, and a uniform interface. REST can be a somewhat confusing subject. Even the very acronym itself, which stands for "Representation State Transfer", is a little obtuse. Luckily, there are some great resources out there. One of the best resources out there is RESTful Web Services by Leonard Richardson and Sam Ruby. It explains REST as well as many of the practical issues surrounding the issue of building RESTful web services in great detail. You can find it at your local bookstore, Amazon, or online at O'Reilly's Safari website. For a good online (and free) introduction, Stefan Tilkov has written two excellent articles: A Brief Introduction to REST and Addressing Doubts about REST. And of course, there is the authoritative, but dense, thesis by Roy T. Fielding You should familiarize yourself with the concepts of REST before continuing to read this page.
Advantages of RESTful Architectures and Implementations Following is a discussion of some key benefits of RESTful architectures and implementations. Note that while many of these items are benefits of the REST architectural style, many are related to HTTP, which is a specific implementation of the REST concepts.
REST Is the Architecture of the Web RESTful applications can be easily integrated in the web to great benefit. Your resources can be linked to and from web pages. You can take advantage of Microformats to handle both UI and data related issues. You can also take advantage of the existing web infrastructure and ecosystem: proxies, caches, browsers/ clients, load balancers, web standards, and more.
Increased Scalability The web is the largest distributed system in the world. This is enabled by the inherent constraints in RESTful architectures. For example, RESTful interactions are stateless. The server does not have to worry about managing state between requests, as all state is kept on the client. Also, caching semantics are built into the protocol. You can enable caching on any RESTful application without any special knowledge since all interactions are based on the uniform interface.
Evolvability All resources are identified by URIs. URIs provide a simple way to deal with the evolution of a system as they can be used to partition servers and manage versioning. All one needs is a proxy to do redirects based on the URI. Because there is no need to inspect the actual HTTP message payload, the performance impact of this is negligible. RESTful systems are based on hypermedia, so they provide links between different resources. Clients are responsible for navigating the hypertext links. For instance, they browse to an order resource. They may then browse to different items in the order via a link. If you need to direct a client to a different server or move a server, simply change the link. Because the client knows the entry point link, it can still navigate to the various items as your system evolves.
Document generated by Confluence on Mar 11, 2009 14:57
Page 524
Disadvantages of RESTful Architectures and Implementations This section describes the disadvantages to the REST approach.
Not Applicable to Many Message-oriented Situations RESTful systems are fundamentally client-server based and are ill-suited to a number of messageoriented scenarios. Publish-subscribe scenarios are one example. As there is no mechanism inside HTTP for asynchronous responses, you often have to set up a second HTTP server if you want to receive asynchronous replies.
Performance HTTP is fundamentally a text-based protocol and is not geared toward performance. While it is not slow, there are other protocols that may be more suitable for situations that are very performance-sensitive.
Transactions HTTP does not include the concept of transactions. It is possible to model a transaction as an HTTP resource, but it will not be as efficient as protocols such as JMS. It is also not appropriate to use transactions with HTTP in many cases, as it can potentially consume many resources across multiple servers if transactions are long lived.
Notes on Building Your Application with WS-* or RESTful HTTP WS-* represents common names for the set of standards that encompass SOAP, WSDL, WS-Addressing, WS-Security, WS-ReliableMessaging, WS-Policy, and many others. One cannot compare WS-* and REST directly, as WS-* is a set of technology standards and REST is an architectural style. However, you can compare the actual pieces of software that help you build RESTful systems and traditional web services.
Go Beyond XML SOAP/WSDL web services are XML based. To create messages that encapsulate binary data, you must use standards such as MTOM that wrap the XML in a MIME message, which often ends up being extra work. With HTTP, resources can be any media.
Transport Neutrality One of the great benefits of SOAP is that it is transport neutral. If this is a requirement for your application, RESTful services are probably not the way to go.
Reliability The RESTful and WS-* approaches to reliability differ tremendously. The WS-* approach is based on WS-ReliableMessaging (WS-RM). WS-RM implements a TCP-like system of acknowledgments: messages are sent from server A to server B, and server B then sends acknowledgments back. If server A never receives an acknowledgment for a message, it eventually resends it. WS-ReliableMessaging implementations (not the protocol) can also ensure messages are delivered in the correct order. RESTful systems typically achieve reliability through idempotent operations. See the section on RESTful reliability for more information.
Security The RESTful and WS-* approaches to security also differ greatly. WS-* advocates a layered approach. It creates WS-Security for encryption and authorization, it uses WS-Trust for token exchange, and it uses WS-SecureConversation to create more efficient security tokens for encrypted communication. These
Document generated by Confluence on Mar 11, 2009 14:57
Page 525
approaches make sense if you need message-oriented, transport-neutral systems. However, many WS-* systems make use of the underlying transport security (such as SSL) for its simplicity and performance. RESTful systems can achieve security through both the transport layer (SSL) and a variety of messagelevel mechanisms. Support for different security scenarios is arguably one of the reasons to choose WS* instead of REST for some specific (but rare) scenarios. See the section on RESTful security for more information on how to build secure RESTful services.
Document generated by Confluence on Mar 11, 2009 14:57
Page 526
Using Transformers This page last changed on Mar 09, 2009 by jackie.wheeler.
Using Transformers [ Configuring Transformers ] [ Inbound, Outbound, and Response Configurations ] [ Chaining Transformers ] [ Transformation Best Practices ] [ Available Transformers ] Transformers convert message payloads as they are transported between services. Mule provides many standard transformers, which you configure using predefined elements and attributes in your Mule XML configuration file. You can also configure custom transformers using the <custom-transformer> element, in which you specify the fully qualified class name of the custom transformer class. For more information on creating and configuring a custom transformer, see Creating Custom Transformers. Standard transformers are easier to use than custom transformers. You don't need to know the Java name of the transformer, and all properties are explicitly declared in a Mule configuration schema. Following is an example of declaring the standard Append String transformer, which appends string text to the original message payload:
If the original message payload was the string "foo", the transformer above would convert the string to "foo ... that's good to know!". The Available Transformers section of this page describes all the standard transformers provided with Mule. Additionally, many transports and modules have their own transformers, such as the ObjectToJMSMessage transformer for the JMS transport.
Configuring Transformers You can configure a transformer locally or globally. You configure a local transformer right on the endpoint where you want to apply it, whereas you configure a global transformer before the <model> element in your Mule configuration properties so you can then refer to the transformer in multiple places. For example, the following code defines two global transformers, which are referenced from two different services:
<xm:xml-to-object-transformer name="XMLToExceptionBean" returnClass="org.mule.example.errorhandler.ExceptionBean"/> <custom-transformer name="ExceptionBeanToErrorMessage" class="org.mule.example.errorhandler.ExceptionBeanToErrorMessage" returnClass="org.mule.example.errorhandler.ErrorMessage"/> ... <model name="errorhandler-test"> <service name="Error Manager"> ... ... <service name="Business Error Manager">
Document generated by Confluence on Mar 11, 2009 14:57
Page 527
...
This example uses the transformer-refs attribute on the endpoint to specify the transformers to use. This is a fast way of specifying global transformers, but if you want to enter a local transformer or a mix of local and global transformers, you must use the element instead. For example, if only one of the transformers were defined globally, you would refer to the global transformer and configure the local transformer as follows:
<service name="Error Manager"> ...
Inbound, Outbound, and Response Configurations The above examples illustrate configuring inbound transformers, which are applied to the message after it is received on the inbound endpoint and before it is passed to the service's component. You specify inbound transformers under the element. You can also specify an outbound transformer in exactly the same way but on element routers, in which case the message is transformed after it has been processed by the service's component but before it has been sent to the outbound endpoint specified by that router. For example:
...
Lastly, you can specify a response transformer, which converts response message payloads on their way from the service back to the caller. To configure a response transformer, you use the responseTransformers-refs attribute on the router, or you can use the element. For example:
Document generated by Confluence on Mar 11, 2009 14:57
Page 528
<some-component/>
In this example, the response message from "some-component" is transformed using the "myAppender" transformer before being returned to the caller. For more information on response messages and the messaging styles supported by Mule, see Mule Messaging Styles.
Chaining Transformers You can chain transformers together so that the output from one transformer becomes the input for the next. To chain transformers, you create a space-separated list of transformers in the transformer-refs or responseTransformer-refs attributes or by creating multiple elements as shown above. For example, this chain ultimately converts from a ByteArray to InputStream:
transformer-refs="ByteArrayToString StringToObject ObjectToInputStream"
You could also configure this as follows:
Note that if you specify transformer chains, any default transformers or discoverable transformers are not applied. If you want to use those transformers, you must specify them explicitly with the other chained transformers.
Transformation Best Practices Mule has an efficient transformation mechanism. Transformers are applied to inbound or outbound endpoints, and the data is transformed just before it is sent from a service or just before it is received by another service. Transformers can be concatenated, so it is simple to perform multiple transformations on data in transit. There is no one standard approach for how and where transformations should occur. Some maintain that because transformation should always be applied on inbound/outbound data, transformations should be available as part of the enterprise service bus instead of inside the service components. This approach matches the concepts of Aspect Oriented Programming (AOP). Others conclude that it is far more efficient to encode the transformation logic into the service components themselves. In the second case, however, there is no distinction between code that is related to a business process and code that is generic enough to be reused, which contradicts the philosophy of an ESB. While there is no industry best practice, MuleSource recommends that developers examine their transformation logic to see if it will always be used (AOP) or if it is specific to a business process. In general, if it will always be used, you should use a transformer, and if it is specific to a single business process, it should be part of the service component. Note the following cases where you should not configure a transformer: • Default transformers: some transports have default transformers that are called by default, but only if you don't configure explicit transformations. • Discoverable transformers: some transformers can be discovered and used automatically based on the type of message. You do not configure these transformers explicitly. These include custom transformers that have been defined as discoverable. For more information, see Creating Custom Transformers.
Document generated by Confluence on Mar 11, 2009 14:57
Page 529
References: http://msdn2.microsoft.com/en-us/library/aa480061.aspx http://blogs.ittoolbox.com/eai/ applications/archives/transformation-in-a-soa-12186
Available Transformers Following are the transformers available with Mule. Some transformers are specific to a transport or module. For more information, see Available Transports and Using Mule Modules. For a complete reference to the elements and attributes for the standard Mule transformers, see Transformers Configuration Reference.
Basic The basic transformers are in the org.mule.transformer.simple package. They do not require any special configuration. For details on these transformers, see Transformers Configuration Reference.
Transformer
Description
BeanBuilderTransformer
(As of Mule 2.2) Constructs simple bean objects by defining the object and then setting a number of expressions used to populate the bean properties. For example:
ByteArrayToHexString <-> HexStringToByteArray
A pair of transformers that convert between byte arrays and hex strings.
ByteArrayToMuleMessage <-> MuleMessageToByteArray
A pair of transformers that convert between byte arrays and Mule messages.
ByteArrayToObject <-> ObjectToByteArray
A pair of transformers that convert between byte arrays and objects. If the byte array is not serialized, ByteArrayToObject returns a String created from the bytes as the returnType on the transformer.
ByteArrayToSerializable <-> SerializableToByteArray
A pair of transformers that serialize and deserialize objects.
ExpressionTransformer
Evaluates one or more expressions on the current message and return the results as an Array. For details, see Using Expressions.
MessagePropertiesTransformer
A configurable message transformer that allows users to add, overwrite, and delete properties on the current message.
Document generated by Confluence on Mar 11, 2009 14:57
Page 530
ObjectArrayToString <-> StringToObjectArray
A pair of transformers that convert between object arrays and strings. Use the configuration elements and <string-to-byte-array-transformer>.
ObjectToInputStream
Converts serializable objects to an input stream but treats java.lang.String differently by converting to bytes using the String.getBytes() method.
ObjectToOutputHandler
Converts a byte array into a String.
ObjectToString
Returns human-readable output for various kinds of objects. Useful for debugging.
StringAppendTransformer
Appends a string to an existing string.
StringToObjectArray
Converts a string to an object array. Use the configuration element <string-to-byte-arraytransformer>.
XML The XML transformers are in the org.mule.module.xml.transformer package. They provide the ability to transform between different XML formats, use XSLT, and convert to POJOs from XML. For information, see XML Module.
Scripting The Scripting transformer transforms objects using scripting, such as JavaScript or Groovy scripts. This transformer is in the org.mule.module.scripting.transformer package.
Encryption The encryption transformers are in the org.mule.transformer.encryption package.
Transformer
Description
Encryption <-> Decryption
A pair of transformers that use a configured EncryptionStrategy implementation to encrypt and decrypt data.
Compression The compression transformers are in the org.mule.transformer.compression package. They do not require any special configuration.
Transformer
Description
GZipCompressTransformer <-> GZipUncompressTransformer
A pair of transformers that compress and uncompress data.
Encoding The encoding transformers are in the org.mule.transformer.codec package. They do not require any special configuration.
Document generated by Confluence on Mar 11, 2009 14:57
Page 531
Transformer
Description
Base64Encoder <-> Base64Decoder
A pair of transformers that convert to and from Base 64 encoding.
XMLEntityEncoder <-> XMLEntityDecoder
A pair of transformers that convert to and from XML entity encoding.
Document generated by Confluence on Mar 11, 2009 14:57
Page 532
Creating Custom Transformers This page last changed on Mar 04, 2009 by jackie.wheeler.
Creating Custom Transformers [ Transformer Classes ] [ Registering Source and Return Types ] [ Using Transformer Lifecycle Methods ] [ Creating Discoverable Transformers ] [ Registering the Transformer ] [ Examples ] A custom transformer is a user-defined transformer class that implements org.mule.api.transformer.Transformer . Your class can extend AbstractTransformer or AbstractMessageAwareTransformer , depending on your needs. This page describes how to create a custom transformer in more detail. Mule also provides several standard transformers, including XML transformers (such as XML to Object, XSLT, and DOM to XML), encryption transformers that encrypt and decrypt data, compression transformers that compress and decompress data, and more. For a list of the standard transformers in Mule, see Using Transformers.
Transformer Classes AbstractTransformer allows you to access and transform the source payload and to specify the encoding to use (if required). It defines methods for controlling the object types this transformer supports and validates the expected return type, leaving you to implement a single doTransform() method.
import org.mule.transform.AbstractTransformer; public class OrderToHtmlTransformer implements AbstractTransformer { public Object doTransform(Object src, String encoding) throws TransformerException }
If you need to transform the message header and attachments, you can use AbstractMessageAwareTransformer instead to change them directly on the message passed in. In this case, you return the transformed message payload by overriding the method transform(MuleMessage message, String encoding). You can use message.getProperty(Object key) to retrieve the properties or message.setProperty(Object key, Object value) to set properties on the transformed message. For example:
import org.mule.transform.AbstractMessageAwareTransformer; public class OrderToHtmlTransformer implements AbstractMessageAwareTransformer { public Object transform(MuleMessage message, String encoding) throws TransformerException }
Registering Source and Return Types You can specify which source types a transformer can accept and which type it will return. This allows Mule to validate the incoming message before invoking the transformer and to validate the output before sending the message on. If you create a discoverable transformer, you must set the source and return types.
Document generated by Confluence on Mar 11, 2009 14:57
Page 533
For example, for the Order bean to HTML transformer, you would specify in the constructor that the transformer converts only message payloads of type Order:
public class OrderToHtmlTransformer implements AbstractMessageAwareTransformer { public OrderToHtmlTransformer() { registerSourceType(Order.class); setReturnClass(String.class); setName("OrderToHTML"); }
Because the source type is specified, you don't need to do any type checking in your transform() method. However, if you add more than one source type, you do need to check for each type in your transform() method. Notice that the above code sets the name of the transformer. Usually, you set the transformer name in the XML configuration when the transformer is declared. If no name is set, Mule generates a name based on the first source type and return class, such as "OrderToString" if the above example did not specify the name.
Using Transformer Lifecycle Methods All objects in Mule have lifecycles associated with them. For transformers, there are two lifecycle methods that are most useful. By default AbstractMessageAwareTransfromer and AbstractTransformer both implement the org.mule.api.lifecycle.Initialisable interface. After all bean properties are set on the transformer (if any), the doInitialise() method is called. This is useful for transformers to do any initialization or validation work. For example, if a transformer requires that an external file be loaded before the transformer can operate, you would load the file via the doInitialise() method. If you want your transformer to clear up resources when the transformer is no longer needed, your transformer must implement org.mule.api.lifecycle.Disposable and implement the dispose() method.
Creating Discoverable Transformers Mule can perform automatic transformations. For example, when you call the getPayload() method on a MuleMessage and pass in the required type as follows:
Document doc = (Document)muleMessage.getPayload(org.dom4j.Document.class);
Mule looks at the current payload type and tries to find a transformer that can convert it to an org.dom4j.Document object. Mule provides several standard transformers for switching between common types such as strings, byte[], InputStream, and more. Also, transports usually have transformers for specific message types such as JMSMessage or HttpRequest. When creating a custom transformer, you can set its priority higher than the standard transformers so that it takes precedence. To make a transformer discoverable, it must implement org.mule.api.transformer.DiscoverableTransformer . This interface introduces two methods, getPriorityWeighting() and setPriorityWeighting(int weighting). Weighting resolves conflicts when two or more transformers match the search criteria. The weighting is a number between 1 and 10, with 10 being the highest priority. As a rule, Mule transformers have a priority of 1 and should always have a lower priority than any custom transformers. For example, to make the OrderToHtmlTransformer discoverable, you would define it as follows:
public class OrderToHtmlTransformer implements AbstractMessageAwareTransformer , DiscoverableTransformer
Document generated by Confluence on Mar 11, 2009 14:57
Page 534
{ private int weighting = DiscoverableTransformer. DEFAULT_PRIORITY_WEIGHTING + 1; int getPriorityWeighting() { return weighting; } void setPriorityWeighting(int weighting) { this.weighting = weighting; } }
This transformer converts from an Order object to a String, which the standard ObjectToString transformer also does, but ObjectToHtml will be used because it has a higher priority weighting. You could test this as follows:
MuleMessage message = new DefaultMuleMessage(new Order(...)); String html = (String)muleMessage.getPayload(java.lang.String.class);
Registering the Transformer After creating a transformer, you must register it so that Mule can discover it at runtime. You can register the transformer simply by configuring it using the <custom-transformer> element in your Mule configuration file. Alternatively, if you want your transformer to be loaded automatically by Mule when your module (JAR) is on the class path, you add a registry-bootstrap.properties file to your JAR under the /META-INF/ services/org/mule/config directory. The contents of registry-bootstrap.properties should look something like this:
orderToHtml=com.foo.OrderToHtml
When Mule starts, it will discover this bootstrap file before loading any configuration and will install any objects listed in the file into the local registry. For more information, see Bootstrapping the Registry.
Examples To create an HTML message that includes the transactionId from the message header, you would extend AbstractMessageAwareTransformer and write the transform() method as follows:
public Object transform(MuleMessage message, String encoding) throws TransformerException { Order order = (Order)message.getPayload(); StringBuffer html = new StringBuffer(); html.append(""); html.append(""); html.append(""); html.append("Dear ").append(order.getCustomer().getName()).append(" "); html.append("Thank you for your order. Your transaction reference is: <strong>"); html.append(message.getProperty("transactionId").append(""); html.append("(""); return html.toString();
Document generated by Confluence on Mar 11, 2009 14:57
Page 535
}
The Hello World example defines a custom transformer called StdinToNameString, which removes line breaks and newlines from the string:
package org.mule.example.hello; import org.mule.api.transformer.TransformerException; import org.mule.transformer.AbstractTransformer; public class StdinToNameString extends AbstractTransformer { public StdinToNameString() { super(); this.registerSourceType(String.class); this.setReturnClass(NameString.class); } public Object doTransform(Object src, String encoding) throws TransformerException { NameString nameString = new NameString(); String name = (String) src; nameString.setName(name.replaceAll("\r", "").replaceAll("\n", "").trim()); return nameString; } }
The transformer is then configured like this:
<custom-transformer name="StdinToNameString" class="org.mule.example.hello.StdinToNameString" /> ... <service name="GreeterUMO"> <stdio:inbound-endpoint system="IN" transformer-refs="StdinToNameString" /> ...
Document generated by Confluence on Mar 11, 2009 14:57
Page 536
Transformers Configuration Reference This page last changed on Feb 20, 2009 by jackie.wheeler.
Transformers Configuration Reference [ Transformer ] [ Auto Transformer ] [ Custom Transformer ] [ Message Properties Transformer ] [ No Action Transformer ] [ Base64 Encoder Transformer ] [ Base64 Decoder Transformer ] [ Xml Entity Encoder Transformer ] [ Xml Entity Decoder Transformer ] [ Gzip Compress Transformer ] [ Gzip Uncompress Transformer ] [ Byte Array To Hex String Transformer ] [ Hex String To Byte Array Transformer ] [ Byte Array To Object Transformer ] [ Object To Byte Array Transformer ] [ Object To String Transformer ] [ Object To Xml Transformer ] [ Byte Array To Serializable Transformer ] [ Serializable To Byte Array Transformer ] [ Byte Array To String Transformer ] [ String To Byte Array Transformer ] [ Append String Transformer ] [ Encrypt Transformer ] [ Decrypt Transformer ] [ Expression Transformer ] [ Xpath Extractor Transformer ] This page provides details on configuring the standard transformers. Note that many transports and modules provide their own transformers as well.
Transformer A reference to a transformer defined elsewhere.
Attributes of
Name
Type
Required
name
name (no spaces)
no
Identifies the transformer so that other elements can reference it. Required if the transformer is defined at the global level.
returnClass
class name
no
The class of the message generated by the transformer. This is used if transformers are autoselected (which is somewhat incomplete at the moment).
ignoreBadInput
boolean
no
Many transformers only accept certain classes. Such transformers are never called with inappropriate input (whatever the value of this attribute). If a transformer
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 537
forms part of a chain and cannot accept the current message class, this flag controls whether the remaining part of the chain is evaluated. If true, the next transformer is called. If false the chain ends, keeping the result generated up to that point. ref
name (no spaces)
no
The name of the transformer to use.
Auto Transformer A transformer that uses the transform discovery mechanism to convert the message payload. This transformer works much better when transforming custom object types rather than Java types, because there is less chance for ambiguity.
Attributes of
Name
Type
Required
name
name (no spaces)
no
Identifies the transformer so that other elements can reference it. Required if the transformer is defined at the global level.
returnClass
class name
no
The class of the message generated by the transformer. This is used if transformers are autoselected (which is somewhat incomplete at the moment).
ignoreBadInput
boolean
no
Many transformers only accept certain classes. Such transformers are never called with inappropriate input (whatever the value of this
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 538
attribute). If a transformer forms part of a chain and cannot accept the current message class, this flag controls whether the remaining part of the chain is evaluated. If true, the next transformer is called. If false the chain ends, keeping the result generated up to that point.
Custom Transformer A user-implemented transformer.
Attributes of <custom-transformer...>
Name
Type
Required
name
name (no spaces)
no
Identifies the transformer so that other elements can reference it. Required if the transformer is defined at the global level.
returnClass
class name
no
The class of the message generated by the transformer. This is used if transformers are autoselected (which is somewhat incomplete at the moment).
ignoreBadInput
boolean
no
Many transformers only accept certain classes. Such transformers are never called with inappropriate input (whatever the value of this attribute). If a transformer forms part of a chain and cannot
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 539
accept the current message class, this flag controls whether the remaining part of the chain is evaluated. If true, the next transformer is called. If false the chain ends, keeping the result generated up to that point. class
class name
no
An implementation of the Transformer interface.
Child Elements of <custom-transformer...>
Name
Cardinality
spring:property
0..*
Description
Message Properties Transformer A transformer that can add or delete message properties.
Attributes of <message-properties-transformer...>
Name
Type
Required
name
name (no spaces)
no
Identifies the transformer so that other elements can reference it. Required if the transformer is defined at the global level.
returnClass
class name
no
The class of the message generated by the transformer. This is used if transformers are autoselected (which is somewhat incomplete at the moment).
ignoreBadInput
boolean
no
Many transformers only accept
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 540
certain classes. Such transformers are never called with inappropriate input (whatever the value of this attribute). If a transformer forms part of a chain and cannot accept the current message class, this flag controls whether the remaining part of the chain is evaluated. If true, the next transformer is called. If false the chain ends, keeping the result generated up to that point. overwrite
boolean
no
true
If false, a property is not added if the message already contains a property with that name.
Child Elements of <message-properties-transformer...>
Name
Cardinality
Description
delete-message-property
0..*
Delete a message property.
add-message-property
0..*
Add a message property.
rename-message-property
0..*
Rename a message property.
add-message-properties
0..1
Add a set of message properties.
No Action Transformer A transformer that has no effect.
Attributes of <no-action-transformer...>
Name
Type
Required
name
name (no spaces)
no
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description Identifies the transformer so that other elements can reference it. Required if the
Page 541
transformer is defined at the global level. returnClass
class name
no
The class of the message generated by the transformer. This is used if transformers are autoselected (which is somewhat incomplete at the moment).
ignoreBadInput
boolean
no
Many transformers only accept certain classes. Such transformers are never called with inappropriate input (whatever the value of this attribute). If a transformer forms part of a chain and cannot accept the current message class, this flag controls whether the remaining part of the chain is evaluated. If true, the next transformer is called. If false the chain ends, keeping the result generated up to that point.
Base64 Encoder Transformer A transformer that base64 encodes a string or byte array message.
Attributes of
Name
Type
Required
name
name (no spaces)
no
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description Identifies the transformer so that other elements can reference it. Required if the transformer is defined at the global level.
Page 542
returnClass
class name
no
The class of the message generated by the transformer. This is used if transformers are autoselected (which is somewhat incomplete at the moment).
ignoreBadInput
boolean
no
Many transformers only accept certain classes. Such transformers are never called with inappropriate input (whatever the value of this attribute). If a transformer forms part of a chain and cannot accept the current message class, this flag controls whether the remaining part of the chain is evaluated. If true, the next transformer is called. If false the chain ends, keeping the result generated up to that point.
Base64 Decoder Transformer A transformer that base64 decodes a message to give an array of bytes.
Attributes of
Name
Type
Required
name
name (no spaces)
no
Identifies the transformer so that other elements can reference it. Required if the transformer is defined at the global level.
returnClass
class name
no
The class of the message generated by
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 543
the transformer. This is used if transformers are autoselected (which is somewhat incomplete at the moment). ignoreBadInput
boolean
no
Many transformers only accept certain classes. Such transformers are never called with inappropriate input (whatever the value of this attribute). If a transformer forms part of a chain and cannot accept the current message class, this flag controls whether the remaining part of the chain is evaluated. If true, the next transformer is called. If false the chain ends, keeping the result generated up to that point.
Xml Entity Encoder Transformer A transformer that encodes a string using XML entities.
Attributes of <xml-entity-encoder-transformer...>
Name
Type
Required
name
name (no spaces)
no
Identifies the transformer so that other elements can reference it. Required if the transformer is defined at the global level.
returnClass
class name
no
The class of the message generated by the transformer. This is used if transformers
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 544
are autoselected (which is somewhat incomplete at the moment). ignoreBadInput
boolean
no
Many transformers only accept certain classes. Such transformers are never called with inappropriate input (whatever the value of this attribute). If a transformer forms part of a chain and cannot accept the current message class, this flag controls whether the remaining part of the chain is evaluated. If true, the next transformer is called. If false the chain ends, keeping the result generated up to that point.
Xml Entity Decoder Transformer A transformer that decodes a string containing XML entities.
Attributes of <xml-entity-decoder-transformer...>
Name
Type
Required
name
name (no spaces)
no
Identifies the transformer so that other elements can reference it. Required if the transformer is defined at the global level.
returnClass
class name
no
The class of the message generated by the transformer. This is used if transformers are autoselected (which is somewhat
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 545
incomplete at the moment). ignoreBadInput
boolean
no
Many transformers only accept certain classes. Such transformers are never called with inappropriate input (whatever the value of this attribute). If a transformer forms part of a chain and cannot accept the current message class, this flag controls whether the remaining part of the chain is evaluated. If true, the next transformer is called. If false the chain ends, keeping the result generated up to that point.
Gzip Compress Transformer A transformer that compresses a byte array using gzip.
Attributes of
Name
Type
Required
name
name (no spaces)
no
Identifies the transformer so that other elements can reference it. Required if the transformer is defined at the global level.
returnClass
class name
no
The class of the message generated by the transformer. This is used if transformers are autoselected (which is somewhat incomplete at the moment).
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 546
ignoreBadInput
boolean
no
Many transformers only accept certain classes. Such transformers are never called with inappropriate input (whatever the value of this attribute). If a transformer forms part of a chain and cannot accept the current message class, this flag controls whether the remaining part of the chain is evaluated. If true, the next transformer is called. If false the chain ends, keeping the result generated up to that point.
Gzip Uncompress Transformer A transformer that uncompresses a byte array using gzip.
Attributes of
Name
Type
Required
name
name (no spaces)
no
Identifies the transformer so that other elements can reference it. Required if the transformer is defined at the global level.
returnClass
class name
no
The class of the message generated by the transformer. This is used if transformers are autoselected (which is somewhat incomplete at the moment).
ignoreBadInput
boolean
no
Many transformers only accept certain classes.
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 547
Such transformers are never called with inappropriate input (whatever the value of this attribute). If a transformer forms part of a chain and cannot accept the current message class, this flag controls whether the remaining part of the chain is evaluated. If true, the next transformer is called. If false the chain ends, keeping the result generated up to that point.
Byte Array To Hex String Transformer A transformer that converts a byte array to a string of hexadecimal digits.
Attributes of
Name
Type
Required
name
name (no spaces)
no
Identifies the transformer so that other elements can reference it. Required if the transformer is defined at the global level.
returnClass
class name
no
The class of the message generated by the transformer. This is used if transformers are autoselected (which is somewhat incomplete at the moment).
ignoreBadInput
boolean
no
Many transformers only accept certain classes. Such transformers are never called with inappropriate
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 548
input (whatever the value of this attribute). If a transformer forms part of a chain and cannot accept the current message class, this flag controls whether the remaining part of the chain is evaluated. If true, the next transformer is called. If false the chain ends, keeping the result generated up to that point.
Hex String To Byte Array Transformer A transformer that converts a string of hexadecimal digits to a byte array.
Attributes of
Name
Type
Required
name
name (no spaces)
no
Identifies the transformer so that other elements can reference it. Required if the transformer is defined at the global level.
returnClass
class name
no
The class of the message generated by the transformer. This is used if transformers are autoselected (which is somewhat incomplete at the moment).
ignoreBadInput
boolean
no
Many transformers only accept certain classes. Such transformers are never called with inappropriate input (whatever the value of this attribute). If
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 549
a transformer forms part of a chain and cannot accept the current message class, this flag controls whether the remaining part of the chain is evaluated. If true, the next transformer is called. If false the chain ends, keeping the result generated up to that point.
Byte Array To Object Transformer A transformer that converts a byte array to an object (either deserializing or converting to a string).
Attributes of
Name
Type
Required
name
name (no spaces)
no
Identifies the transformer so that other elements can reference it. Required if the transformer is defined at the global level.
returnClass
class name
no
The class of the message generated by the transformer. This is used if transformers are autoselected (which is somewhat incomplete at the moment).
ignoreBadInput
boolean
no
Many transformers only accept certain classes. Such transformers are never called with inappropriate input (whatever the value of this attribute). If a transformer forms part of a chain and cannot
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 550
accept the current message class, this flag controls whether the remaining part of the chain is evaluated. If true, the next transformer is called. If false the chain ends, keeping the result generated up to that point.
Object To Byte Array Transformer A transformer that serializes all objects except strings (which are converted using getBytes()).
Attributes of
Name
Type
Required
name
name (no spaces)
no
Identifies the transformer so that other elements can reference it. Required if the transformer is defined at the global level.
returnClass
class name
no
The class of the message generated by the transformer. This is used if transformers are autoselected (which is somewhat incomplete at the moment).
ignoreBadInput
boolean
no
Many transformers only accept certain classes. Such transformers are never called with inappropriate input (whatever the value of this attribute). If a transformer forms part of a chain and cannot accept the current message class, this flag controls
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 551
whether the remaining part of the chain is evaluated. If true, the next transformer is called. If false the chain ends, keeping the result generated up to that point.
Object To String Transformer A transformer that gives a human-readable description of various types (useful for debugging).
Attributes of
Name
Type
Required
name
name (no spaces)
no
Identifies the transformer so that other elements can reference it. Required if the transformer is defined at the global level.
returnClass
class name
no
The class of the message generated by the transformer. This is used if transformers are autoselected (which is somewhat incomplete at the moment).
ignoreBadInput
boolean
no
Many transformers only accept certain classes. Such transformers are never called with inappropriate input (whatever the value of this attribute). If a transformer forms part of a chain and cannot accept the current message class, this flag controls whether the remaining part of the chain is
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 552
evaluated. If true, the next transformer is called. If false the chain ends, keeping the result generated up to that point.
Object To Xml Transformer Converts a Java object to an XML representation using XStream.
Attributes of
Name
Type
acceptMuleMessage boolean
Required
Default
Description
no
false
Whether the transformer will serialize the payload or the entire MuleMessage including not only its payload, but also its properties, correlation ID, etc.
Byte Array To Serializable Transformer A transformer that converts a byte array to an object (deserializing the object).
Attributes of
Name
Type
Required
name
name (no spaces)
no
Identifies the transformer so that other elements can reference it. Required if the transformer is defined at the global level.
returnClass
class name
no
The class of the message generated by the transformer. This is used if transformers are autoselected (which is somewhat incomplete at the moment).
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 553
ignoreBadInput
boolean
no
Many transformers only accept certain classes. Such transformers are never called with inappropriate input (whatever the value of this attribute). If a transformer forms part of a chain and cannot accept the current message class, this flag controls whether the remaining part of the chain is evaluated. If true, the next transformer is called. If false the chain ends, keeping the result generated up to that point.
Serializable To Byte Array Transformer A transformer that converts an object to a byte array (serializing the object).
Attributes of <serializable-to-byte-array-transformer...>
Name
Type
Required
name
name (no spaces)
no
Identifies the transformer so that other elements can reference it. Required if the transformer is defined at the global level.
returnClass
class name
no
The class of the message generated by the transformer. This is used if transformers are autoselected (which is somewhat incomplete at the moment).
ignoreBadInput
boolean
no
Many transformers only accept certain classes.
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 554
Such transformers are never called with inappropriate input (whatever the value of this attribute). If a transformer forms part of a chain and cannot accept the current message class, this flag controls whether the remaining part of the chain is evaluated. If true, the next transformer is called. If false the chain ends, keeping the result generated up to that point.
Byte Array To String Transformer A transformer that converts a byte array to a string.
Attributes of
Name
Type
Required
name
name (no spaces)
no
Identifies the transformer so that other elements can reference it. Required if the transformer is defined at the global level.
returnClass
class name
no
The class of the message generated by the transformer. This is used if transformers are autoselected (which is somewhat incomplete at the moment).
ignoreBadInput
boolean
no
Many transformers only accept certain classes. Such transformers are never called with inappropriate input (whatever
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 555
the value of this attribute). If a transformer forms part of a chain and cannot accept the current message class, this flag controls whether the remaining part of the chain is evaluated. If true, the next transformer is called. If false the chain ends, keeping the result generated up to that point.
String To Byte Array Transformer A transformer that converts a string to a byte array.
Attributes of <string-to-byte-array-transformer...>
Name
Type
Required
name
name (no spaces)
no
Identifies the transformer so that other elements can reference it. Required if the transformer is defined at the global level.
returnClass
class name
no
The class of the message generated by the transformer. This is used if transformers are autoselected (which is somewhat incomplete at the moment).
ignoreBadInput
boolean
no
Many transformers only accept certain classes. Such transformers are never called with inappropriate input (whatever the value of this attribute). If a transformer forms part of a
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 556
chain and cannot accept the current message class, this flag controls whether the remaining part of the chain is evaluated. If true, the next transformer is called. If false the chain ends, keeping the result generated up to that point.
Append String Transformer A transformer that appends a string to a string payload.
Attributes of
Name
Type
Required
name
name (no spaces)
no
Identifies the transformer so that other elements can reference it. Required if the transformer is defined at the global level.
returnClass
class name
no
The class of the message generated by the transformer. This is used if transformers are autoselected (which is somewhat incomplete at the moment).
ignoreBadInput
boolean
no
Many transformers only accept certain classes. Such transformers are never called with inappropriate input (whatever the value of this attribute). If a transformer forms part of a chain and cannot accept the current message class, this flag controls
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 557
whether the remaining part of the chain is evaluated. If true, the next transformer is called. If false the chain ends, keeping the result generated up to that point. message
string
no
The string to append.
Encrypt Transformer A transformer that encrypts a message.
Attributes of <encrypt-transformer...>
Name
Type
Required
name
name (no spaces)
no
Identifies the transformer so that other elements can reference it. Required if the transformer is defined at the global level.
returnClass
class name
no
The class of the message generated by the transformer. This is used if transformers are autoselected (which is somewhat incomplete at the moment).
ignoreBadInput
boolean
no
Many transformers only accept certain classes. Such transformers are never called with inappropriate input (whatever the value of this attribute). If a transformer forms part of a chain and cannot accept the current message class, this flag controls
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 558
whether the remaining part of the chain is evaluated. If true, the next transformer is called. If false the chain ends, keeping the result generated up to that point. strategy-ref
name (no spaces)
no
The name of the encryption strategy to use. This should be configured using the passwordencryptionstrategy element, inside a securitymanager element at the top level.
Decrypt Transformer A transformer that decrypts a message.
Attributes of <decrypt-transformer...>
Name
Type
Required
name
name (no spaces)
no
Identifies the transformer so that other elements can reference it. Required if the transformer is defined at the global level.
returnClass
class name
no
The class of the message generated by the transformer. This is used if transformers are autoselected (which is somewhat incomplete at the moment).
ignoreBadInput
boolean
no
Many transformers only accept certain classes. Such transformers are never called with inappropriate input (whatever
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 559
the value of this attribute). If a transformer forms part of a chain and cannot accept the current message class, this flag controls whether the remaining part of the chain is evaluated. If true, the next transformer is called. If false the chain ends, keeping the result generated up to that point. strategy-ref
name (no spaces)
no
The name of the encryption strategy to use. This should be configured using the passwordencryptionstrategy element, inside a securitymanager element at the top level.
Expression Transformer A transformer that evaluates one or more expressions on the current message. Each expression equates to a parameter in the return message. The return message for two or more expressions will be an Object[].
Attributes of <expression-transformer...>
Name
Type
Required
name
name (no spaces)
no
Identifies the transformer so that other elements can reference it. Required if the transformer is defined at the global level.
returnClass
class name
no
The class of the message generated by the transformer. This is used if transformers are autoselected (which is somewhat
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 560
incomplete at the moment). ignoreBadInput
boolean
no
Many transformers only accept certain classes. Such transformers are never called with inappropriate input (whatever the value of this attribute). If a transformer forms part of a chain and cannot accept the current message class, this flag controls whether the remaining part of the chain is evaluated. If true, the next transformer is called. If false the chain ends, keeping the result generated up to that point.
returnSourceIfNull
boolean
no
If all expressions return null on this transformer, this flag will cause the source payload to be returned without modification.
Child Elements of <expression-transformer...>
Name
Cardinality
Description
return-argument
0..1
A list of expressions, each of which is evaluated and equates to an element in the result message. If just one 'returnargument' is configured, the result will be the evaluation of that expression rather than an object array.
Xpath Extractor Transformer The XPathExtractor is a simple transformer that evaluates an XPath expression using the JAXP libraries against the given bean and returns the result. By default, a String of the result will be returned. To return a Node, NodeSet, Boolean or Number result, the resultType attribute can be set.
Document generated by Confluence on Mar 11, 2009 14:57
Page 561
Attributes of <xpath-extractor-transformer...>
Name
Type
Required
Default
Description
expression
string
no
The XPath expression.
resultType
xpathResultType
no
The XPath result type (e.g. STRING or NODE).
Child Elements of <xpath-extractor-transformer...>
Name
Cardinality
Description
namespace
0..*
A namespace declaration, expressed as prefix and uri attributes. The prefix can then be used inside the expression.
Document generated by Confluence on Mar 11, 2009 14:57
Page 562
XmlPrettyPrinter Transformer This page last changed on Oct 06, 2008 by jackie.wheeler.
Xml Prettyprinter Transformer Formats an XML string using the Pretty Printer functionality in org.dom4j.io.OutputFormat.
Attributes of <xml-prettyprinter-transformer...>
Name
Type
Required
encoding
string
no
The encoding format to use, such as UTF-8.
expandEmptyElements boolean
no
Whether to expand empty elements from to .
indentEnabled
boolean
no
Whether to enable indenting of the XML code. If true, the indent string and size are used.
indentString
string
no
The string to use as the indent, usually an empty space.
indentSize
integer
no
The number of indent strings to use for each indent, such as "2" if indentString is set to an empty space and you want to use two empty spaces for each indent.
lineSeparator
string
no
The string to use for new lines, typically "\n".
newLineAfterNTags
integer
no
If the newlines attribute is true, the number of closing tags after which a newline separator is inserted. For example, setting this to "5" will cause a newline to be inserted after the output of
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 563
five closing tags (including single tags). newlines
boolean
no
Whether newlines should be printed. If false, the XML is printed all on one line.
omitEncoding
boolean
no
Whether the XML declaration line includes the encoding of the document. It is common to suppress this in protocols such as SOAP.
padText
boolean
no
Whether to ensure that text immediately preceded by or followed by an element will be "padded" with a single space. This is useful when you set trimText to true and want to ensure that "the quick brown fox" does not become "the quickbrownfox".
suppressDeclaration boolean
no
Whether to suppress the XML declaration line. It is common to suppress this in protocols such as SOAP.
trimText
boolean
no
Whether to trim white space in the XML.
XHTML
boolean
no
Whether to use the XHTML standard, which is like HTML but passes an XML parser with real, closed tags, and outputs CDATA sections with CDATA delimiters.
Document generated by Confluence on Mar 11, 2009 14:57
Page 564
Using Web Services This page last changed on Feb 03, 2009 by jackie.wheeler.
Using Web Services The following topics describe how to use web services with Mule. Using Axis with Mule - Links to several topics describing Axis support in Mule. Building a CXF Web Service - Describes how to build a CXF web service and use it in Mule. Using the Mule Client - Describes the Mule Client, which can be used as a SOAP client. Proxying Web Services - Describes how to use Mule as a web service gateway/proxy in various scenarios. Supported Web Service Standards - Web service standards supported by Mule and CXF. Web Service Wrapper - Describes how to use the WebServiceWrapperComponent class to send the result of a web service call to another endpoint. RESTpack - Provides support for building RESTful services inside Mule. You can also use the REST service wrapper (a specialized Mule service component) in the HTTP transport to proxy REST-style requests to external REST/HTTP services. This wrapper component acts as a REST client and is appropriate if you do not have strict REST requirements. Echo Example - A simple example of exposing a Mule service as a web service using Axis. Using .NET Web Services with Mule - Tips for using .NET web services with Mule.
Document generated by Confluence on Mar 11, 2009 14:57
Page 565
Axis This page last changed on Oct 13, 2008 by jackie.wheeler.
Using Axis with Mule The following topics describe how to configure Mule and Apache Axis. • Axis Web Services and Mule - Introduction to exposing Mule services over Axis and invoking SOAP services. • Configuring Axis - Controlling WSDL generation, named parameters, Advanced Service configuration, and more. • Axis Transport - Basic configuration of the Axis transport. • Axis SOAP Transports - Using Axis over JMS, VM, SMTP, and other Mule transports. • Axis SOAP Styles - Configuring services for Doc/Lit, Message or RPC style invocations.
Document generated by Confluence on Mar 11, 2009 14:57
Page 566
Axis SOAP Styles This page last changed on Oct 14, 2008 by jackie.wheeler.
Axis SOAP Styles By default, Mule Axis support uses RPC/Encoded for SOAP messages. However, because of compatibility issues on other platforms, it has become increasingly popular to use Document/Literal/Wrapped style services. This page describes how to use Doc/Lit, Doc/Lit/Wrapped, and Message style services using Axis in Mule. For an overview of the pros and cons of each style/use combination, see http:// www-128.ibm.com/developerworks/webservices/library/ws-whichwsdl/. The client examples below show how to invoke an Axis web service hosted in Tomcat using the Mule client. The example behaves exactly the same way if the service is hosted in Mule unless explicitly noted otherwise. These tests were run against Tomcat 5.5.12 and Axis 1.3.1. Each test uses the Calculator service as used in the Axis User Guide.
Document Literal Wrapped This is the preferred approach to Document Literal style services. "Wrapped" simply means that the parameters are wrapped in an element whose name is the name of the operation to invoke.
Client Example This example is very similar to the Doc/Lit example, except that we set the message style to 'wrapped/ literal', and there is no need to add any server configuration, as the method name is stored in the message.
String URL = "axis:http://localhost:8080/axis/Calculator.jws?method=add"; MuleClient client = new MuleClient(); Map props = new HashMap(); props.put("style", "wrapped"); props.put("use", "literal"); MuleMessage result = client.send(URL, new Object[]{new Integer(3), new Integer(3)}, props); assertEquals(result.getPayload(), new Integer(6));
The SOAP request for this call looks like this:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http:// www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soapenv:Body> 3 3
In the next example, we can see how to change the namespace of the method as well as naming the parameters. This is very useful when calling services from other platforms.
Document generated by Confluence on Mar 11, 2009 14:57
Page 567
Doc/Lit/Wrapped with Named Parameters If you're invoking external services, the Axis-generated names for parameters and namespaces do not work. You can easily change these in Mule as follows:
Client Example
String URL = "axis:http://localhost:8080/axis/Calculator.jws"; MuleClient client = new MuleClient(); SoapMethod method = new SoapMethod(new QName("http://muleumo.org/Calc", "add")); method.addNamedParameter(new QName("Number1"), NamedParameter.XSD_INT, "in"); method.addNamedParameter(new QName("Number2"), NamedParameter.XSD_INT, "in"); method.setReturnType(NamedParameter.XSD_INT); Map props = new HashMap(); props.put("style", "wrapped"); props.put("use", "literal"); props.put("method", method); MuleMessage result = client.send(URL, new Object[]{new Integer(3), new Integer(3)}, props); assertEquals(result.getPayload(), new Integer(6));
Note that we do not pass the method name in the query string of the URL. Instead, we create a SoapMethod object and add it to the parameters passed to the client call. The SOAP request now looks like this:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http:// www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soapenv:Body> 3 3
Using the Mule Configuration Instead of hard-coding the namespaces and parameter names, you can specify them in an endpoint configuration in the Mule configuration file and reference the endpoint from your Mule client. The configuration file will look like this:
Document generated by Confluence on Mar 11, 2009 14:57
Page 568
This endpoint configuration can be used by the Mule client or on a component outbound router. The client code is now much simpler:
MuleClient client = new MuleClient("org/mule/test/integration/providers/soap/axis/soap-client-endpointconfig.xml"); Muleessage result = client.send("calculatorAddEndpoint", new Object[]{new Integer(3), new Integer(3)}, null); assertEquals(result.getPayload(), new Integer(6));
Notice the URL for the MuleClient call contains the name of the service endpoint, not the physical location of the resource.
Document Literal Mule hosted Web services using Axis cannot be invoked using Doc/Lit. Use Doc/Lit/Wrapped instead. Users can still invoke remote web services using Doc/Lit as shown in the example below.
Client Example For this example, we must tell the Mule client to use 'document/literal' for the message style, and we pass this information into the call on the Mule client. This requires some configuration on the Axis server. The biggest limitation of Doc/Lit is that operation/method name is not passed with the message.
String URL = "axis:http://localhost:8080/axis/Calculator.jws?method=add"; MuleClient client = new MuleClient(); Map props = new HashMap(); props.put("style", "document"); props.put("use", "literal"); MuleMessage result = client.send(URL, new Object[]{new Integer(3), new Integer(3)}, props); assertEquals(result.getPayload(), new Integer(6));
The SOAP request for this call looks like this:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http:// www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soapenv:Body> 3 3
Using Doc/Lit with Axis might appear to work even when you don't add operation info to the Axis server configuration. This happens when there is a single parameter for the service and the parameter name is the same as the operation/method name you want to invoke. For more information, see Axis Operations.
RPC Encoded Because Axis uses RPC/Encoded by default, there is no need to pass any additional configuration information. The client call looks like this:
Document generated by Confluence on Mar 11, 2009 14:57
Page 569
String URL = "axis:http://localhost:8080/axis/Calculator.jws?method=add"; MuleClient client = new MuleClient(); MuleMessage result = client.send(URL, new Object[]{new Integer(4), new Integer(3)}, null); assertEquals(result.getPayload(), new Integer(7));
The SOAP request for this call looks like this:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http:// www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soapenv:Body> <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/ encoding/" xsi:type="soapenc:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">4 <multiRef id="id1" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/ encoding/" xsi:type="soapenc:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">3
Document generated by Confluence on Mar 11, 2009 14:57
Page 570
Axis SOAP Transports This page last changed on Oct 15, 2008 by jackie.wheeler.
Axis SOAP Transports [ SOAP Over JMS ] [ SOAP Over VM ] [ Binding to a Servlet Container ] [ Using Other Mule Transports ] Mule transports can deliver SOAP requests between Axis clients and Axis services hosted by Mule. This means you can easily use JMS, VM, SMTP, or even XMPP (Jabber) to send SOAP requests. This page describes how to configure these transports.
SOAP Over JMS First, if you do not want to use the default JMS connector, configure the connector you do want to use in your Mule XML configuration:
<jms:activemq-connector name="jmsConnector"/>
Next, create the service. In this example, we will create a service that listens to a queue called echoComponent. The method parameter specifies the operation to invoke. The SOAPAction property specifies the name of the queue again, which is required if your service name and queue name are not identical.
<model name="echoSample"> <service name="echoService"> <echo-component/>
You can also add any other JMS endpoint options, such as transactions. See the JMS Transport documentation for a full description.
SOAP Over VM The VM transport also supports SOAP, which can be useful for testing or prototyping. You configure the endpoints the same as JMS SOAP endpoints. For example:
<model name="test"> <service name="mycomponent"> <singleton-object class="org.mule.tck.testmodels.services.TestServiceComponent"/>
Document generated by Confluence on Mar 11, 2009 14:57
Page 571
<service name="mycomponent2"> <singleton-object class="org.mule.tck.testmodels.services.TestServiceComponent"/>
Binding to a Servlet Container If you embed Mule in a webapp, you might want to bind Axis services to the servlet container port rather than open another port for Mule SOAP services, but you may not be able to do this because of firewall restrictions. In this scenario, you can use the Servlet Transport and Axis instead of HTTP. To use this transport, you must add MuleReceiverServlet to your web.xml file:
<servlet> <servlet-name>muleServlet <servlet-class>org.mule.transport.servlet.MuleReceiverServlet <servlet-mapping> <servlet-name>muleServlet /mule/services/*
Next, you add a servlet endpoint to your component:
<servlet:connector name="servlet" servletUrl="http://localhost:62088/services"/> <model name="test"> <service name="mycomponent">
Note that you set the host, port, and path on the connector, not the endpoint, using the servletUrl property.
Using Other Mule Transports You can send and receive SOAP requests using other transports simply by configuring the endpoint according to the endpoint scheme and then prepending the axis: scheme. For client endpoints, you also set the the method parameter.
//Client
Document generated by Confluence on Mar 11, 2009 14:57
Page 572
axis:xmpp://mule1:[email protected]/axis?method=echo¶m=hello //Server axis:xmpp://mule1:[email protected]/axis
Document generated by Confluence on Mar 11, 2009 14:57
Page 573
Axis Transport This page last changed on Feb 20, 2009 by jackie.wheeler.
Axis Transport The Axis transport allows Mule-managed components to be published as Axis services and allows components to invoke web services using Axis client calls. The Javadocs for the AxisConnector can be found at org.mule.transport.soap.axis.AxisConnector .
Programmatic Configuration If you want to programmatically configure your Axis service you can implement the org.mule.transport.soap.axis.AxisInitialisable interface. This will pass the SOAPService object to your component where it can be manipulated.
Connector The Axis connector consumes and provides web services via Axis. It supports all the common connector attributes and properties as well as the following additional attributes:
Attributes of
Name
Type
Required
axis-ref
string
no
Bean reference to the Axis server.
clientConfig
string
no
Configuration file to use when building the Axis client.
clientProvider-ref
string
no
Bean reference to the client provider to use for creating the Axis client.
doAutoTypes
boolean
no
Use this property to configure whether the Axis server should automatically map types. This property only takes effect if you do not provide your own Axis server via the axis-ref property.
serverConfig
string
no
Configuration file to use when building the Axis server.
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 574
serverProvider-ref
string
treatMapAsNamedParams boolean
no
Bean reference to the server provider that should be used to create the Axis server.
no
The Axis connector treats a Map as a container for named parameters and unpacks them from the map. If your exposed service needs to take a Map as a parameter, set this property to false to prevent the connector from unpacking the Map.
Child Elements of
Name
Cardinality
bean-type
0..*
supported-scheme
0..*
Description
Inbound Endpoint Attributes of
Name
Type
Required
wsdlFile
string
no
clientConfig
string
no
soapAction
string
no
SOAPAction
string
no
serviceNamespace
string
no
style
styleType
no
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description The location of a WSDL document to use for this service if you do not want the WSDL document autogenerated.
Specifies the SOAP binding
Page 575
style: RPC (default), DOCUMENT, MESSAGE, or WRAPPED. use
useType
no
Specifies the SOAP binding use: ENCODED (default) or LITERAL.
For example:
<service name="Calculator">
Escape Your Credentials If you use a URI-style endpoint and you include the user name and password, escape any characters that are illegal for URIs, such as the @ character. For example, if the user name is [email protected], you should enter it as user%40myco.com.
Outbound Endpoint Attributes of
Name
Type
Required
clientConfig
string
no
soapAction
string
no
SOAPAction
string
no
serviceNamespace
string
no
style
styleType
no
Specifies the SOAP binding style: RPC (default), DOCUMENT, MESSAGE, or WRAPPED.
use
useType
no
Specifies the SOAP binding use: ENCODED
Document generated by Confluence on Mar 11, 2009 14:57
Default
Description
Page 576
(default) or LITERAL.
Wrapper Component The WebServiceWrapperComponent class allows you to send the result of a web service call to another endpoint. For example:
Attributes of <wrapper-component...>
Name
Type
Required
Default
Description
address
string
no
Specifies the URL of the web service to call.
addressFromMessageboolean
no
Specifies that the URL of the web service will be obtained from the message itself.
style
styleType
no
Specifies the SOAP binding style: RPC (default), DOCUMENT, MESSAGE, or WRAPPED.
use
useType
no
Specifies the SOAP binding use: ENCODED (default) or LITERAL.
Child Elements of <wrapper-component...>
Name
Cardinality
Description
soap-method
0..*
Allows you to specify a SOAP method and optionally parameters and a return. The parameter mode can be IN, OUT, or INOUT.
Document generated by Confluence on Mar 11, 2009 14:57
Page 577
Axis Web Services and Mule This page last changed on Oct 13, 2008 by [email protected].
Axis Web Services and Mule [ Exposing Web Services ] [ Invoking Web Services ] [ Axis Without a Servlet Container ] [ Configuring the Axis Server ] [ SOAP Over Other Transports ]
Exposing Web Services You can expose service components as Axis services and invoke them from Mule. To expose a service component as an Axis service, you simply import the Axis namespace and then set the component's inbound endpoint to an Axis URL. Note that web services expect methods to be exposed through interfaces implemented by their respective components. Otherwise, you will receive configuration errors when Mule starts.
<service name="echoService"> <echo-component/>
When Mule starts, the service will be available on http://localhost:81/services/echoService. The Echo component class (org.mule.components.simple.EchoComponent) implements the EchoService interface, which has a single method called echo that accepts a single parameter string. Note: Mule 2.0 supports Axis 1.4.
Invoking Web Services You can invoke web services from Mule programmatically using the Mule Client or as part of the event flow of a Mule service. This section describes these approaches in detail.
Invoking Services Using the Mule Client To invoke the Echo service using the Mule Client, use the following code:
public static void main(String[] args) { MuleClient client = new MuleClient(); MuleMessage result = client.send ("axis:http://localhost:81/services/echoService?method=echo", "Hello!", null); System.out.println("Message Echoed is: " + result.getPayload()); client.close(); }
Invoking Web Services from a Mule Service To invoke the Echo service from a service, you add an outbound endpoint to your service configuration. The following example shows a service that receives an event on vm://test.component, does some work on the event, and then invokes the Echo service.
Document generated by Confluence on Mar 11, 2009 14:57
Page 578
<service name="test">
The org.foo.TestComponent class looks like this:
public class TestComponent implements Callable { public Object onCall(MuleEventContext context) throws Exception { Object payload = context.getMessage().getPayload(); //Do some work on the payload and return a string that will be //used by the outbound endpoint to invoke the echo service //... return payload.toString(); } }
If the Web service you are invoking takes more than one parameter, you can return an array of parameters in your component. When an event is published to vm://test.component, the onCall method is called with the current event. After the onCall method executes, Mule invokes the outbound endpoint for TestComponent with what is returned from onCall. Note that the vm://test.component endpoint has a parameter synchronous=true. This tells Mule to invoke requests from that endpoint in a single thread, making it a request/response style request. Thus the result of invoking the Echo service (by invoking TestComponent) will be returned to the callee who dispatched the event on vm://test.component. When the TestEchoService is run, you will see the following output:
Message Echoed is: Hello!
Note the following: • There is no need for a servlet container, because Mule is the container (see below). • You don't need to specify a deployment WSDD for your service. You simply specify an endpoint for the service, and the rest is done for you. • The MuleClient call will work just as well if the service you are invoking is hosted by an Axis instance running on Tomcat or any other servlet engine. • The Axis JAR and associated JARs that ship with the Mule distribution must be on your classpath. Exposing Services
Document generated by Confluence on Mar 11, 2009 14:57
Page 579
All service operations are exposed through interfaces implemented by your component. Therefore, your component must implement at least one service interface, which is generally good practice anyway.
Axis Without a Servlet Container When you use Axis with Mule, there is no need for a separate servlet container. When you create an Axis endpoint, Mule takes the following actions: • Creates an Axis component in Mule, which is analogous to the AxisServlet. There is only one Axis component per Mule instance. • Creates an HTTP connector for the endpoint address and registers it as a receiver for the Axis component. Cannot resolve external resource into attachment. Most web services are a lot more complex than the first example, so the following sections will tell you how to configure the Axis instance and your services in more detail.
Configuring the Axis Server In the previous example, a default Axis connector is created when the Axis endpoint is processed by Mule. The Axis connector uses a default server configuration file called mule-axis-server-config.wsdd. You can override this configuration by setting the serverConfig property on the connector to a different configuration file, which will allow you to add additional handlers, global configuration, and more.
If you use a custom server configuration, you must add the following handlers in the global configuration:
<requestFlow>
If you are configuring Mule from a container such as Spring, you can set the Axis server as a bean property (axisServer) on the connector and the serverConfig property is ignored. You can list the Axis services in the same way you list services when Axis is hosted in a servlet container. To list services, simply point your browser at the host and port of the axis endpoint: http://localhost:81/
To view Axis version information, go to: http://localhost:81/Version?method=getVersion
To view the WSDL for the service, go to: http://localhost:81/Version?wsdl
Note that the Axis JWS feature is not supported by Mule.
Document generated by Confluence on Mar 11, 2009 14:57
Page 580
SOAP Over Other Transports You can configure Axis to send/receive soap requests over other transports such as JMS and SMTP. For more information, see Axis SOAP Transports. For more information about customizing Axis behavior, naming parameters, message style options, and more, see Configuring Axis.
Document generated by Confluence on Mar 11, 2009 14:57
Page 581
Configuring Axis This page last changed on Oct 20, 2008 by jackie.wheeler.
Configuring Axis Table of Contents Click here to expand... • Configuring Axis ° Controlling Exposed Methods • ° Map as Parameter ° Setting SOAP Document Style ° Customizing the SOAP Action Format ° Setting Named Parameters ° Controlling Namespaces ° Controlling WSDL Generation ° Type Mappings ° Service Initialization Callback
Controlling Exposed Methods To restrict the exposure of a service's methods add additional soap-service elements. These allow you to specify interfaces that the service implements and that should be exposed.
You can also specify one or more methods to expose in a comma-separated list, using the allowedMethods attribute.
<service name="myService">
Map as Parameter The AxisConnector treats a Map as container for named parameters, which eventually will be unpacked. This becomes a problem if your exposed service needs to take a Map as a parameter, because the actual Map will never reach the service intact. To configure the connector not to unpack Maps so that they can be passed as parameters, use the treatMapAsNamedParams attribute:
Document generated by Confluence on Mar 11, 2009 14:57
Page 582
Setting SOAP Document Style To control the style and use of a service, the style and use properties can be set on Axis endpoints. For example, to make your inbound endpoint Document/Literal/Wrapped, do the following:
The style attribute can be 'RPC' (default), 'DOCUMENT', 'MESSAGE', or 'WRAPPED'. The use attribute can be either 'ENCODED' (default) or 'LITERAL'. For more information about service styles and Mule, see Axis SOAP Styles. Also see the Axis web site for further reference.
Customizing the SOAP Action Format By default, Mule uses the Axis endpoint as the SOAP Action when making WS calls. This approach works for Axis clients but might not work with .NET clients. The SOAP Action can be different for different SOAP implementations, so you must be able to customize how the SOAP Action is formatted. You can set the soapAction attribute on the outbound endpoint making the SOAP request:
The above example sets the SOAP Action on the request to http://localhost:38011/echo. If you are Using the Mule Client, you can set the SOAP Action as a property when making the call. The SOAP Action can be a static value, or you can use template variables such as the method variable used above. The set of variables that can be used are listed below.
Variable
Description
Example
method
The service method name being invoked
echo
methodNamespace
The service method name being invoked
echo
address
The full SOAP endpoint
http://localhost:38011/ mule/echoService? method=echo
scheme
The request scheme being used
http
host
The hostname from the SOAP endpoint
localhost
Document generated by Confluence on Mar 11, 2009 14:57
Page 583
port
The port from the SOAP endpoint
38011
path
The path info from the SOAP endpoint
/mule/echoService
hostInfo
The scheme, host and port combined
http://localhost:38011
serviceName
The name of the service being invoked
echoService
Any other properties on the event or the endpoint can be referenced by name in the soapAction expression.
Setting Named Parameters Some web service clients require that all method parameters of a call should be named. You can do this in Mule in two ways. In the Mule XML configuration, you can set the SOAP method parameters for a service on the endpoint using the soap-method element.
Within the soap-method element, you can define soap-parameter elements, which control that parameter's mode, name, and type. The parameter attribute is the name of the parameter. The type attribute is an XSD string such as int, long, map, etc. The attribute mode can be in, out, or inout. The return type is also an XSD type string. The soap-return element controls the type of the parameter the method returns.
Controlling Namespaces Namespaces for elements can be controlled at the method and parameter level. To declare a namespace on the method with a prefix of 'foo' and a URI of 'http://mycompany.com/foo', you would use the following code:
The syntax for the qname is: qname{[MULE:prefix]:[MULE:localname]:[MULE:namespace]}
Document generated by Confluence on Mar 11, 2009 14:57
Page 584
You can supply just a localname, a localname and namespace, or a prefix, localname, and namespace. The qname syntax can be used with <soap-parameter> elements as well. For example:
To set the method parameter name using the Mule client, you create a SoapMethod object and set it on the properties when making the call. The example below shows how to do this.
MuleClient client = new MuleClient(); Map props = new HashMap(); //create the soap method passing in the method name and return type SoapMethod soapMethod = new SoapMethod("echo", NamedParameter.XSD_STRING); //add one or more parameters soapMethod.addNamedParameter("value", NamedParameter.XSD_STRING, ParameterMode.IN); //set the soap method as a property and pass the properties //when making the call props.put(MuleProperties.MULE_SOAP_METHOD, soapMethod); MuleMessage result = client.send("axis:http://localhost:38011/mule/echoService?method=echo", "Hello", props);
Note that you can use the qname notation for setting method and parameter names using the Mule client.
Controlling WSDL Generation The service namespace (also called the target namespace) for your service can be controlled by setting the serviceNamespace property on the inbound endpoint:
You can also set the wsdlFile property to the location of a WSDL document to use for this service if you do not want an auto-generated WSDL document.
Optionally, you can control the values used in Axis WSDL generation by setting WSDL-specific Axis options. The options you can set are:
Option Name
Description
wsdlPortType
Sets the wsdl:portType name attribute. the Axis default is $Proxy0
wsdlServiceElement
Sets the wsdl:service name attribute. the Axis default is $Proxy0Service
Document generated by Confluence on Mar 11, 2009 14:57
Page 585
wsdlTargetNamespace
Sets the wsdl:definitions targetNamespace attribute. The Axis default is http:// plus package name of the service class in reverse.
wsdlServicePort
Sets the wsdl:port name attribute of the wsdl:service element. The default is the name of the Mule component exposed by this service endpoint.
wsdlInputSchema wsdlSoapActionMode extraClasses To change the wsdlServiceElement name attribute to MyService in the generated WSDL for a service, use the following:
<properties> <spring:entry key="axisOptions"> <spring:map> <spring:entry key="wsdlServiceElement" value="MyService"/>
Type Mappings Note that as of Axis 1.2-RC3, it is no longer necessary to configure type mappings, as bean serialization is handled automatically by Axis. If you are using an older version of Axis, you might need to configure type mappings. Mule enables default type mappings for object serialization between SOAP calls. This means that serialization and deserialization of call parameters and return objects is mostly handled automatically by Axis. This works for most Java types including primitives, Numbers, Strings, Arrays and Collections. It also works for JavaBeans whose attributes comprise these types. However, it does not work where you have a bean that has another bean as an attribute; Axis will complain that it doesn't know how to handle the bean attribute. Mule handles this by allowing you to specify a list of beanTypes that Axis needs to understand to manage your service. For example, assume you have a PersonService service that will get a Person object when passed the person's name. The Person object contains an Address object. The configuration will look like this:
<property key="beanTypes"> <spring:list> <spring:value>org.foo.Address
Document generated by Confluence on Mar 11, 2009 14:57
Page 586
It is important to note that only custom types should be listed. If any standard types are present, like java.util.ArrayList, Axis may produce serialization errors. For convenience, the beanTypes property can be set on an Axis connector configuration so that all services that use the connector will have the types registered in the TypeRegistry for the service.
<spring:property name="beanTypes"> <spring:list> <spring:value>org.foo.Address
By default, an Axis connector is created if one doesn't exist already when the Axis endpoint is processed. For more information about configuring Connectors and Providers, see Configuring Endpoints.
Service Initialization Callback If you need further control over the Axis service created by Mule, it is possible for your component to implement AxisInitialisable.
public interface AxisInitialisable { public void initialise(SOAPService service) throws InitialisationException; }
This gets called when the service is initialized and allows you to customize the service configuration from your Mule component.
Document generated by Confluence on Mar 11, 2009 14:57
Page 587
Proxying Web Services This page last changed on Mar 04, 2009 by jackie.wheeler.
Proxying Web Services [ Protocol Bridging ] [ WSProxyService ] [ CXF Proxy Services ] [ Example: Routing Messages Based on SOAPAction Headers with Transformations ] Mule can act as a web service gateway/proxy. Gateways can perform several useful functions: • • • • • •
Routing to the appropriate backend service (whether remote or local) Message transformations, such as converting from old versions of the message format Protocol bridging, such as HTTP to JMS Validation Security enforcement WS-Policy enforcement
Mule provides several utilities that help you do this: • Protocol bridging - allows you to forward requests from one endpoint to another. This is generally the best option for proxying web services. • WSProxyService - allows you to service WSDLs locally while proxying remote web services. • CXF proxy services - perform WS-Security or WS-Policy actions, route based on information such as the operation or SOAP Action, and easily work with just the payload by taking advantage of CXF's web service capabilities. The following sections provide more information on these utilities.
Protocol Bridging The simplest type of web service proxy just involves forwarding a request from one endpoint to another via service bridging. You can forward the data streams directly, or you can process and transform the XML. If you are doing content-based routing, this is often the best option, as it will add less overhead than a full CXF proxy (which is only needed in certain cases). Following is a simple example that forwards a request from one HTTP endpoint to another:
<service name="HttpWebServiceBridge">
This type of bridge can be combined with filters for easy message routing. For fast XPath routing of messages, you can use the SXC Module.
WSProxyService The WSProxyService allows you to serve WSDLs locally while proxying remote web services. This is handy when you have an alternate WSDL you want to service, or if you don't want WSDL requests to be routed with all the other SOAP message requests. Any request that comes in with a "?wsdl" attached to the HTTP URL will be redirected, and the specified WSDL will be served instead.
Document generated by Confluence on Mar 11, 2009 14:57
Page 588
To configure this for your service, you must first define a WSProxyService bean with your WSDL:
<mule xmlns="http://www.mulesource.org/schema/mule/core/2.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:spring="http://www.springframework.org/schema/beans" xmlns:cxf="http://www.mulesource.org/schema/mule/cxf/2.2" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/springbeans-2.5.xsd http://www.mulesource.org/schema/mule/core/2.2 http://www.mulesource.org/schema/mule/core/2.2/ mule.xsd http://www.mulesource.org/schema/mule/cxf/2.2 http://www.mulesource.org/schema/mule/cxf/2.2/ mule-cxf.xsd"> <spring:bean name="WSProxyService" class="org.mule.transport.soap.WSProxyService"> <spring:property name="wsdlFile" value="localWsdl.wsdl"/> ....
Next, define your service bridge to use this component:
<service name="HttpWebServiceBridge"> <spring-object bean="WSProxyService" />
Now any request to "http://localhost:8080/my/service?wsdl" will cause your WSDL to be served.
CXF Proxy Services Normally when building CXF web services, you'll databind the XML to POJOs. A CXF component might receive an OrderRequest object, or you might send an OrderRequest object via a CXF outbound router. However, it is often useful to work with the XML directly when building web services or consuming other web services. The CXF transport provides the ability to do this. While many times you can proxy web services without using CXF (see above), there are several cases where you might want to use CXF proxies: • • • • •
To To To To To
work directly with the SOAP body take advantage of the CXF web service standards support to use WS-Security or WS-Addressing enforce WS-Policy assertions easily service a WSDL associated with your service transform a SOAP body
Note that currently CXF proxies only support working with the SOAP body. They do not send the whole SOAP message along.
Document generated by Confluence on Mar 11, 2009 14:57
Page 589
Server-side Proxying To proxy a web service so you can work with the raw XML, you can create a simple inbound endpoint:
This will make the SOAP body available in the Mule message payload as an XMLStreamReader. To service a WSDL using a CXF proxy, you must specify the WSDL namespace as a property:
<property key="namespace" value="YOUR_WSDL_NAMESPACE"/>
Client-side Proxying Similarly, you can create an outbound endpoint to send raw XML payloads:
Example: Routing Messages Based on SOAPAction Headers with Transformations This example shows how you can use message routing with CXF web service proxying to handle web service requests that use an old message format. It will listen on the "http://localhost:63081/service" endpoint and send the SOAP body to the outbound routers. If the message has a SOAPAction header of "http://acme.com/v2/bid", it will send the message directly to the web service. If the header has a value of "http://acme.com/v1/bid", it will apply XSLT transformations to convert the message on the way out and on the way back in.
<service name="routeBasedOnSoapAction"> <message-property-filter pattern="SOAPAction=http://acme.com/v2/bid"/> <mule-xml:xslt-transformer xsl-file="v1-to-v2.xsl" returnClass="org.mule.module.xml.transformer.DelayedResult"/> <mule-xml:xslt-transformer xsl-file="v2-to-v1.xsl" returnClass="org.mule.module.xml.transformer.DelayedResult"/>
Document generated by Confluence on Mar 11, 2009 14:57
Page 590
<message-property-filter pattern="SOAPAction=http://acme.com/v1/bid"/>
Document generated by Confluence on Mar 11, 2009 14:57
Page 591
Using .NET Web Services with Mule This page last changed on Dec 11, 2008 by [email protected].
Using .NET Web Services with Mule Following are tips for using Mule to communicate with .NET web services.
Authentication and Other Security Features There are three ways to secure a web service: • Via an HTTP web server • Via authentication tokens in the SOAP header • Via WS-Security
Via an HTTP Web Server If you are running Mule on a Web App, you can configure the web server to use security by setting security configuration in web.xml and in the server's configuration file. Alternatively, to secure a web service running on Mule (where Mule is the server), you can set the HttpBasicAuthenticationFilter on the web service component. Any call made to the web service would have to pass through the filter that delegates the authentication to Acegi. Another alternative would be to use HTTPS where certificates are used for authentication. For more information see Configuring Security and Using HTTPS with CXF.
Using Authentication Tokens in SOAP Headers You can send authentication tokens through SOAP headers as long as there is an authentication provider established that is able to understand the headers and perform the authentication.
Using WS-Security If you are using CXF, you can configure a client and service to use WS-Security. For details, see Enabling WS-Security.
Passing Authentication Information to a Web Service There are three methods for passing authentication information to a web service configured on Mule: • Pass them in the URL, such as http://name:password@localhost:8080/MyService • Set the authentication items as properties when using the Mule client • Create headers containing the authentication items and send them as properties when using the Mule client
Document generated by Confluence on Mar 11, 2009 14:57
Page 592
Web Service Wrapper This page last changed on Oct 15, 2008 by jackie.wheeler.
Using the Web Service Wrapper The WebServiceWrapperComponent class allows you to send the result of a web service call to another endpoint. The web service call is performed within WebServiceWrapperComponent, providing the following advantages: • You can set any type of router on inbound and outbound. • Unlike the chaining router, it can send more than one HTTP request at a time • The URL for the web service call can be changed at run-time by sending the URL with the message
Configuring the Web Service Wrapper To use the web service wrapper, you specify the <wrapper-component> configuration element. The following table describes the attributes you can set for this element. These attributes are described in more detail in the examples that follow.
Attribute
Description
Required?
address
Specifies the URL of the web service to call
Yes, unless addressFromMessage is set to true
addressFromMessage (default is false)
Specifies that the URL of the web service will be obtained from the message itself
Not required if address is set
wrapperProperties
The SOAP document style, expressed as a map of two properties: style, which can be set to RPC (the default), Document, Message, or Wrapped, and use, which can be Encoded or Literal.
No
<soap-method>
A SOAP method to call (see Configuring SOAP Methods below)
No
The web service wrapper is generic and can be used with any type of web service stack supported by Mule, including Axis and CXF. The examples below show synchronous use cases, but the web service wrapper can also support an asynchronous use case like the loan broker example.
Example Configuration Using the CXF Transport Consider the following example. The web service wrapper is configured as a Mule component, accepting messages from a VM endpoint. A call must be made to a web service on the URL cxf:http:// localhost:65081/services/TestUMO?method=onReceive and the result must be sent to the outbound endpoint vm://testout. The inbound and outbound endpoints are configured in the usual way. The address is set as an attribute on the component, specifying the web service URL that you want to call.
<model name="Sample">
Document generated by Confluence on Mar 11, 2009 14:57
Page 593
<service name="WebServiceSample">
Example Configuration Using the addressFromMessage Property The "address" property is ideal to use when the web service URL for the web service is known at configuration time. However, if this URL is either not known or else needs to be changed at run-time, the "address" property can be omitted and the "adddressFromMessage" property can be set to true. The following example shows this configuration:
<service name = "WebServiceSample2">
The URL must be set on the message with the property name "ws.service.url".
Configuring SOAP Methods CXF endpoints are fairly easy to configure, whereas Axis needs some further configuration to set SOAP methods. You can set a SOAP method using the <soap-method> element as shown below:
<service name = "WebServiceSample3">
Document generated by Confluence on Mar 11, 2009 14:57
Page 594
Working with Services This page last changed on Jan 27, 2009 by jackie.wheeler.
Working with Services A service component is a class, web service, or other application that contains the business logic you want to plug in to the Mule framework. For example, one service component could add information to an invoice from a customer database, and another service component could be the order fulfillment application that processes that invoice. You can use any existing application for a service component, or create a new one. Your service component does not need to contain any Mule-specific code. Instead, you configure a service, which wraps the service component with the Mule-specific configuration. The service configuration points to the service component, as well as routers, filters, and transformers to use when carrying messages to and from the service component. It also specifies the endpoint on which this service will receive messages and the outbound endpoint where messages will go next. Services are the primary Mule artifact used to implement integration solutions.
To watch a demo of building a simple service, click here.
Service Components A service component can be a POJO, servlet, web service, and much more. Typically, you create a custom service component, but you can also use one of the several standard components included with Mule. For more information, see Configuring Components.
Service Configuration Most configuration happens at the service level. Services can be configured using globally defined endpoints, transformers, and filters, or these can be defined inline. For more information, see Configuring the Service.
Service Behavior When a service receives a message on an inbound endpoint, the service model (default is SEDA) determines the service's threading and queuing behavior, while the messaging pattern defines the inbound and outbound message exchange patterns that will be used.
Advanced Configuration You can further configure the service with security (configured on endpoints), transactions, and error handling.
Document generated by Confluence on Mar 11, 2009 14:57
Page 595
Configuring Components This page last changed on Feb 03, 2009 by jackie.wheeler.
Configuring Components [ Simple Components ] [ Java Components ] [ Other Components ] [ Customizing Behavior with Interceptors ] Service components contain the business logic for working with the messages passed through Mule. A service component can be any type of object, including a Spring bean, POJO, script, web service, or REST call. Because they are highly specific to your implementation, you will typically create your own custom components, or simply use an existing POJO. Mule also ships with some standard components you can use or extend as needed. This page describes how to configure the different types of components. For detailed information on the elements you configure for components, see Component Configuration Reference.
Simple Components There are several simple components included with Mule that are useful for testing or bypassing component execution.
Configuration Element
Description
Logs component invocations, outputting the received message as a string. This component does not return a response.
<echo-component/>
Extends the log component to log and echo the incoming message. The message is transformed before being returned, so transformations on inbound endpoints will be applied.
Throws an exception when invoked. This is useful for testing use cases that use a forwarding consumer inbound router.
<passthrough-component>
Similar to the echo component but does not log. This component is useful when defining services that consist of inbound and outbound endpoints/routers but don't have a component implementation. Note that explicitly configuring this component has exactly the same result as configuring a service with no component.
Identical to the pass-through component but preserves the Mule 1.4 terminology.
Configures the Mule FunctionalTestComponent, which allows more complex testing scenarios to be created. For more information, see Functional Testing.
Document generated by Confluence on Mar 11, 2009 14:57
Page 596
Java Components Java components specify a Java class to be used as the service component or configure a reference to an implementation in a container such as Spring. They also configure the way in which Mule should manage the Java service component's life-cycle, invoke it, and (if pooled) manage the pool of instances. Java components can be configured quickly and easily by simply specifying the service component implementation class name on the or <pooled-component> element. The <pooledcomponent> element allows you to establish a pooling profile for the service (see Tuning Performance). In both cases, the PrototypeObjectFactory will be used by default and a new object instance will be created for each request or (for pooled components) for each new object in the pool.
... <pooled-component class="org.my.ServiceComponentImpl"/>
Alternatively, you can explicitly specify object factories, such as the SingletonObjectFactory that creates a single instance of the object:
<singleton-object class="org.my.ServiceComponentImpl"/>
The explicit syntax is required instead of the shortcut syntax if you add interceptors to the component. For further configuration options and information on the default settings that are applied, see Configuring Java Components.
Other Components These are several other components available that allow you to use different technologies such as web services for your service components. These components are often included as part of transports or modules.
Configuration
Description
Proxies a remote call to a REST-style web service.
Proxies a remote call to a web service using CXF.
Proxies a remote call to a web service using Axis.
<script:component/>
Configures a JSR-223 script for the service component.
Customizing Behavior with Interceptors Mule interceptors are useful for attaching behaviors to multiple service components. The interceptor pattern is often referred to as practical AOP (Aspect Oriented Programming), as it allows the developer to intercept processing on an object and potentially alter the processing and outcome. For complete information, see Using Interceptors.
Document generated by Confluence on Mar 11, 2009 14:57
Page 597
Configuring Java Components This page last changed on Feb 09, 2009 by jackie.wheeler.
Configuring Java Components [ Object Factories ] [ Entry Point Resolvers ] [ Lifecycle Adapter Factory ] [ Bindings ] [ Configuring a Pooled Java Component ] Java is the default component type in Mule. Mule provides two JavaComponent implementations: DefaultJavaComponent , which you configure with the component element, and PooledJavaComponent , which adds pooling functionality and which you configure with the pooled-component element. These two implementations provide the following functionality and configuration options: • An ObjectFactory is used to obtain the Java service component implementation. • EntryPointResolvers can be configured to define how Mule services should invoke the component methods when processing a message. • A custom LifecycleAdaptor can be configured to customize the way in which the component implementation is initialized and disposed. • Bindings can be configured to bind component interface methods to endpoints. These endpoints are then invoked synchronously when the method is called. When you specify the class directly on the component or pooled-component element, the PrototypeObjectFactory is used by default, and a new instance is created for each invocation, or a new pooled component is created in the case of the PooledJavaComponent. Example:
.. <pooled-component class="org.my.CustomComponent"/>
Alternatively, you can specify the implementation using an object factory. Example:
<singleton-object class="org.my.CustomComponent"/> ... <spring-object bean="myCustomComponentBean"/>
All other component configuration elements are configured as children of the component or pooledcomponent element. Note: In Mule 2.0, Java component pooling is used only if the <pooled-component> element is used. In previous versions of Mule, pooling was the default.
Object Factories Object factories manage both object creation in the case of a Mule instantiated instance or object lookup from another container such as Spring via a single API. The following object factories are included with Mule and can be configured using Mule's core schema.
Document generated by Confluence on Mar 11, 2009 14:57
Page 598
<prototype-object class=..."/>
PrototypeObjectFactory
<singleton-object class=..."/>
SingletonObjectFactory
<spring-object bean=..."/>
SpringBeanLookup
Object factories also allow you to set properties, which are injected when a new object instance is created. Example:
<singleton-object class="org.my.SingletonObject"> <property key="myKey" value="theValue"/> <property key="myKey2" value="theValue2"/>
For a real-world example of using <spring-object/>, see Using Spring Beans as Service Components. You can easily implement additional object factories to integrate with other containers or simply to create object instances in a different way. Note: Object factories replace ContainerContexts in previous versions of Mule.
Entry Point Resolvers You can configure entry point resolvers that determine how your component is invoked when a message is received by the service. See Developing Service Components for a more detailed description of their functionality. To configure entry point resolvers, you can either configure an entry point resolver set or configure a single entry point resolver independently. When using an entry point resolver set, the order in which the resolvers are configured is the order of of precedence they are given in run-time. Example:
<entry-point-resolver-set> <array-entry-point-resolver/>
You can also configure entry point resolvers (single or sets) on models to apply them to all services defined in that model. You use the same configuration syntax as above but on the <model> element instead of .
Document generated by Confluence on Mar 11, 2009 14:57
Page 599
Lifecycle Adapter Factory You can configure your Java component to use a custom lifecycle adaptor. If you do not configure a custom implementation, the default implementation will be used, which allows the optional propagation of Mule's lifecycle to your component depending on the Mule lifecycle interfaces that are implemented. Example:
<custom-lifecycle-adapter-factory class="org.my.MyLifecycleMuleAdapterFactory"/>
See Developing Service Components for more information about lifecycles.
Bindings Components can use bindings to call an external service during execution. The bindings used with a Java component bind a Java interface, or single interface method, to an outbound endpoint. The external service to be called should implement the same interface, and the component should encapsulate a reference to that interface, which is initialized during the bootstrap stage by the Mule configuration builder. The reference will be initialized using a reflective proxy class. Binding can be used on Java components and script components. For more information see Component Bindings.
Configuring a Pooled Java Component A pooled Java component will maintain a pool of object instances that will be reused, with a single instance being used by one thread at any one time. The configuration of component pooling is independent of the object factory, allowing you to use whichever object factory you need. You configure the pool using the nested pooling-profile element as shown below:
<pooled-component class="org.my.PrototypeObject"> <pooling-profile exhaustedAction="WHEN_EXHAUSTED_FAIL" initialisationPolicy="INITIALISE_ALL" maxActive="1" maxIdle="2" maxWait="3" />
For more information about pooling and reference documentation for pooling configuration options, see Tuning Performance.
Document generated by Confluence on Mar 11, 2009 14:57
Page 600
Using Interceptors This page last changed on Jan 19, 2009 by jackie.wheeler.
Using Interceptors [ Interceptor Types ] [ Interceptor Event Flow ] [ Writing Interceptors ] [ Configuring Interceptors ] [ Interceptor Configuration Reference ] Mule interceptors are useful for attaching behaviors to multiple service components. The interceptor pattern is often referred to as practical AOP (Aspect Oriented Programming), as it allows the developer to intercept processing on an object and potentially alter the processing and outcome. (See also Spring AOP). Interceptors are very useful for attaching behavior such as profiling and permission and security checks to your service components.
Interceptor Types Mule has two types of interceptors: • EnvelopeInterceptor : Envelope filter that will execute before and after the component is invoked. Good for logging and profiling. • Interceptor : Intercepts the message and then forwards it for processing to the next element. An interceptor can stop further processing by not forwarding control to the next interceptor, as with a permissions checker interceptor.
Interceptor Event Flow The following shows an example interceptor stack and the event flow.
Document generated by Confluence on Mar 11, 2009 14:57
Page 601
Writing Interceptors If you want to intercept a message flow to a component on the inbound message flow, you should implement the Interceptor interface. It has a single method:
MuleMessage intercept(Invocation invocation) throws MuleException;
The invocation parameter contains the current message and the Service object of the target component. Developers can extract the current MuleMessage from the message and manipulate it as needed. The intercept method must return a MuleMessage that will be passed on to the component (or to the next interceptor in the chain). The EnvelopeInterceptor works in the same way, except that it exposes two methods that get invoked before and after the event processing:
MuleMessage before(Invocation invocation) throws MuleException; MuleMessage after(Invocation invocation) throws MuleException;
Configuring Interceptors Interceptors can be configured on your components as follows:
<service name="MyService"> <custom-interceptor class="org.my.CustomInterceptor"/> <prototype-object class="org.my.ComponentImpl"/>
When you configure interceptors, you must specify the object factory explicitly (in this example, <prototype-object>) instead of using the shortcut. You can also define interceptor stacks, which are one or more interceptors that can be referenced using a logical name. To use an interceptor stack, you must first configure it in the global section of the Mule XML configuration file (above the <model> element):
<custom-interceptor class="org.my.CustomInterceptor"/>
You can configure multiple elements on your components, and you can mix using built-in interceptors, custom interceptors, and references to interceptor stacks.
Document generated by Confluence on Mar 11, 2009 14:57
Page 602
Interceptor Configuration Reference The timer interceptor (ported from 1.x).
Attributes Child Elements
Name
Type
Required
Name
Cardinality
Description
Default
Description
Default
Description
Default
Description
The logging interceptor (ported from 1.x).
Attributes Child Elements
Name
Type
Required
Name
Cardinality
Description
<custom-interceptor ...> A user-implemented interceptor.
Attributes
Name class
Type
Required
class name
no
An implementation of the Interceptor interface.
Child Elements
Name
Cardinality
spring:property
0..*
Document generated by Confluence on Mar 11, 2009 14:57
Description
Page 603
Attributes
Name
Type
name
Required name
Default
no
Description The name used to identify this interceptor stack.
Child Elements
Name
Cardinality
Description
abstract-interceptor
1..1
A placeholder for an interceptor element.
A reference to a stack of intereceptors defined globally.
Attributes
Name
Type
Required
ref
name (no spaces)
Default
no
Description The name of the interceptor stack to use.
Child Elements
Name
Cardinality
Document generated by Confluence on Mar 11, 2009 14:57
Description
Page 604
Configuring the Service This page last changed on Jan 27, 2009 by jackie.wheeler.
Configuring the Service [ Inbound ] [ Component ] [ Outbound ] [ Async Reply ] [ Exception Strategy ] [ Service Bridge ] [ Service Model ] [ Service Messaging Style ] You configure services using a <service> element within a <model> element. Each <service> element represents and configures a Mule service, providing a unique name that identifies it and optionally an initial state that determines whether the service and its endpoints are started when Mule starts (supported values are started, stopped, or paused).
<mule> <model> <service name="GreeterUMO"> ... <service name="GreeterUMO2" initialState="stopped" > ...
Each service can be configured with the following optional elements: <description>: Describes the service : Configures the inbound routers, their endpoints, and inbound transformers component: Configures the service component : Configures the outbound routers, their endpoints, and outbound transformers : Configures an async reply router, which is used for asynchronous request-response messaging • <exception-strategy>: Configures the exception strategy for the service • • • • •
If you configure more than one of these elements, note that you must configure them in the order shown above. For detailed information on the <service> elements and attributes, see Service Configuration Reference. Following is a sample service configuration showing these elements:
<service name="GreeterUMO"> <description>Adds some text to the string before passing it on <stdio:inbound-endpoint system="IN"> <payload-type-filter expectedType="org.mule.example.hello.NameString" /> <default-service-exception-strategy>
Document generated by Confluence on Mar 11, 2009 14:57
Page 605
The following sections describe these elements in more detail.
Inbound This element is used to configure inbound endpoints and inbound routers. Endpoints are used to receive incoming messages, and inbound routers determine how these messages are routed. Inbound endpoints and routers are configured separately within the element.
Inbound Endpoints Inbound endpoints are used to receive incoming messages. An endpoint is simply a set of instructions indicating which transport and path/address to receive messages from, as well as any transformers, filters, or security that should be applied when receiving the messages. You can configure multiple inbound endpoints, each receiving message from different transports. For more information, see Configuring Endpoints and Available Transports.
Inbound Routers Inbound routers control and manipulate messages received by a service before passing them to the service component. Typically, an inbound router is used to filter incoming messages, aggregate a set of incoming messages, or re-sequence messages when they are received. Inbound routers are also used to register multiple inbound endpoints for a service. You can chain inbound routers together, so that each router must be matched before the message can be passed to the component. You can also configure a catch-all strategy that is invoked if none of the routers accept the current message. Inbound routers are different from outbound routers in that the endpoint is already known (as the message has already been received), so the purpose of the router is to control how messages are given to the component. If no inbound routers are configured, by default an InboundPassThroughRouter is used to simply pass the incoming message to the component. Matching Only the First Router By default, a message must match and be processed by all inbound routers in a service before it is passed to the service component. If you want to configure the service so that the message is processed only by the first router whose conditions it matches, you set the matchAll attribute on the element to false. This behavior is new in Mule 2.0. Previously, the message was processed only by the first matching router by default. For more information about the inbound routers that can be used, see Mule Inbound Routers .
Inbound Example
<stdio:inbound-endpoint system="IN" /> <jms:outbound-endpoint queue="failure.queue"/> <selective-consumer-router> <mulexml:jxpath-filter pattern="(msg/header/resultcode)='success'"/>
Document generated by Confluence on Mar 11, 2009 14:57
Page 606
This example uses a selective consumer router that will accept a message if a 'resultcode' element has a value of 'success'. If the message matches this filter's criteria, the message is passed to the component. If the message does not match, the catch-all strategy is invoked, which sends the message via its configured endpoint, in this case a JMS queue called 'failure.queue'.
Component The element configures the service component that will be invoked after the inbound message is processed by the inbound routers. If no component is configured, the service acts as a bridge and simply passes messages through to the outbound router. There are several standard components you can use, such as , which logs component invocations, outputting the received message as a string, and <echo-component>, which extends the log component to log and echo the incoming message. Typically, you will create your own component as a plain old Java object (POJO) and configure it using the element. For more information about component types and their configuration, see Configuring Components. You can also implement new component types in your Mule modules and use them within your configuration. In Mule 2.0, it is now easier to implement and use new non-Java component types and configure them with their own custom component element.
Outbound The element configures outbound routers and their endpoints. Because outbound routers are used to determine which endpoints to use for dispatching messages after the component has finished processing them, outbound endpoints are configured on the outbound routers, not directly on the