Mule Examples

Mule provides a suite of example materials to help you learn more about building applications in Mule Studio and Mule Standalone.

Contents

Examples and Templates
Create and Run Example Applications
Go Further

Examples and Templates

Mule example applications offer insight into how you can use Mule to manage system connection and integration situations. Based on real-life business use cases, the examples demonstrate Mule's features and functionality, and suggest how you can take advantage of them.

In Mule Studio, Mule's graphical interface, these example apps exist in the form of templates which you can use to build a Mule application without having to start from scratch.
In Mule Standalone, (Mule without Studio) these example apps exist as files in the examples folder of the product distribution. You can access these example applications from your computer's console, using them as foundations upon which to build your own apps.

Complexity	Example App	Key Concepts	Included in Runtime
Complexity	Example App	Key Concepts	Community	Enterprise
Low	Hello World	Interacts with an end user via an HTTP request.	✓	✓
Low	HTTP Request-Response with Logger	Logs activity in an application.	✓	✓
Medium	Connect with Salesforce	Facilitates communication between a file-based system(s) and Salesforce.		✓
Medium	DataMapper with FlowRefLookup	Facilitates communication between a file-based system(s) and Salesforce. Uses a FlowRefLookup Table to acquire information outside the message, then append it to the payload.		✓
Medium	Legacy Modernization	Acts as a Web service proxy for a legacy, file-based system.		✓
Medium	Foreach Processing and Choice Routing	Dynamically applies routing criteria to a message at runtime. Processes collections iteratively without losing any of the payload. Enriches message payloads with data, rather than changing payload contents.	✓	✓
Medium	Websphere MQ	Facilitates message processing between Mule and WMQ.		✓
High	XML-only SOAP Web Service	Orchestrates a sequence of calls to other services or message queues. Dynamically applies routing criteria to a message at runtime.		✓
High	SOAP Web Service Security	Implements application-layer security on a SOAP Web service.		✓
High	Service Orchestration and Choice Routing	Orchestrates a sequence of calls to other services or message queues. Dynamically applies routing criteria to a message at runtime. Processes collections iteratively without losing any of the payload. Caches message content during processing to reuse frequently called data.		✓

What happened to the old examples?

They haven't disappeared! Click the links below to download examples that were deprecated with 3.4.0.

Mule Community Examples

Mule Enterprise Examples

Create and Run Example Applications

Create

If you haven't already done so, visit www.mulesoft.org and download Mule ESB with Mule Studio for free. Follow the instructions on the website to launch Mule Studio and select a workspace.
Click the File menu, then select New > Mule Project.
Use the table below to enter values in the fields.

Field Value
Name a name for your new project
Description a brief description of the application you intend to build
Server Runtime Mule Server 3.4.0 EE
How do I get Mule 3.4 Community runtime?
Click the box next to Create project based on an existing template.
Click a line item to select the template you wish to use to build your project.
Click Finish. Studio creates and opens the new project, complete with pre-built and pre-configured flows.

Run

In the Package Explorer pane in Studio, right-click the project name, then select Run As > Mule Application. Studio runs the application and Mule is up and kicking!
To stop the application from running, click the red Terminate button in Studio's Console.

Create

If you haven't already done so, visit www.mulesoft.org and download Mule ESB standalone runtime (without Mule Studio) for free. (Alternatively, download a trial version of Mule ESB Enterprise (with Management Tools).
Navigate to the folder on your local drive that contains your copy of Mule ESB Standalone runtime.
Locate the Examples folder, then the folder for the example you wish to run.
Copy the pre-built application archive (the .zip file) for the example.

Paste the copy of the .zip file in the Mule applications folder, $MULE_HOME/apps.
For example, to run the Hello World example, copy mule-example-hello-3.4.0.zip then move the copy to the $MULE_HOME/examples folder.

Alternatively, you can build the example in a build tool such as Ant or Maven.

Run ant or mvn in your Ant or Maven build tool, respectively.
The build tool compiles the example classes, produces an application zip file and copies it to your $MULE_HOME/apps folder.

Start Mule.
Need more detail?
1. Open a new command line.
  Windows: Open the Console.
  Mac: Open the Terminal application (Applications > Utilities > Terminal).
2. Access the directory and folder in which you pasted the zip file for your example (i.e. the application folder in Mule). For example, type cd /Users/aaron/Downloads/mule-standalone-3.4.0/
3. To start Mule, type ./bin/mule
After it starts, Mule polls the apps and examples folders every 5 seconds; it picks up the application you copied to the examples folder, then deploys it automatically. In the first command line, Mule notifies you that it has deployed the example application.
To stop the application from running, hit CTRL-C.

Go Further

Walk through the Studio Core Concepts to learn the basics of working with Mule Studio.
Study the Mule Studio Tutorials for step-by-step instructions on how to build an application.