Mule
Mule Enterprise Service Bus
Overview
Design
- Super Type
- Service
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
| Notification | false |
| Template Directory | |
| Data View | Children, proximity: 1 |
| Logger Name |
Constraints
Allowed Child Dependencies
- MuleConfigFile 1
- MuleJavaHome 1
- MulePath 1
- MuleUserJar 1
- MuleZip 1
1: These types have a Singleton constraint. Only one instance may be added as a resource.
Allowed Parent Dependencies
- Node
- Site
Attributes
Exported Attributes
| Name | Property |
|---|---|
| muleBase | deployment-basedir |
| muleHome | deployment-install-root |
Defaults for Imported Attributes
| Name | Default |
|---|---|
| muleConfigFile | mule-config.xml |
| muleJavaHome | /usr/java |
| mulePath | /bin:/usr/bin |
Commands
Note
Commandline options displayed in square brackets "[]" are optional. If an option expects arguments, then angle brackets are shown after the option "<>". Any default value is shown within the brackets.
assertServiceIsUp
checks if process is running
- Usage
- assertServiceIsUp [-javahome <>] [-mulebase <${entity.attribute.muleBase}>] [-mulehome <${entity.attribute.muleHome}/${entity.attribute.mulePackageBase}>] [-path <>]
Options
| Option | Description |
|---|---|
| javahome | The Mule JAVA_HOME directory |
| mulebase | The Mule runtime directory |
| mulehome | The Mule package installation directory |
| path | The Mule PATH environment variable |
startService
start the service process
- Usage
- startService [-configfile <${entity.attribute.muleConfigFile}>] [-console] [-javahome <>] [-mulebase <${entity.attribute.muleBase}>] [-mulehome <${entity.attribute.muleHome}/${entity.attribute.mulePackageBase}>] [-path <>]
Options
| Option | Description |
|---|---|
| configfile | The location of the configuration file |
| console | Start Mule in console mode |
| javahome | The Mule JAVA_HOME directory |
| mulebase | The Mule runtime directory |
| mulehome | The Mule package installation directory |
| path | The Mule PATH environment variable |
stopService
stops the service process
- Usage
- stopService [-javahome <>] [-mulebase <${entity.attribute.muleBase}>] [-mulehome <${entity.attribute.muleHome}/${entity.attribute.mulePackageBase}>] [-path <>]
Options
| Option | Description |
|---|---|
| javahome | The Mule JAVA_HOME directory |
| mulebase | The Mule runtime directory |
| mulehome | The Mule package installation directory |
| path | The Mule PATH environment variable |
Related Types
The following types are defined for use with Mule.
MuleSetting
Overview
MuleSetting:
Mule configuration setting
Design
- Super Type
- Setting
| Role | Abstract. (Objects cannot be created.) |
| Instance Names | Unique |
MulePath
Overview
MulePath:
PATH to use to run Mule
Design
- Super Type
- MuleSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| mulePath | settingValue |
MuleJavaHome
Overview
MuleJavaHome:
Java installation to use to run Mule
Design
- Super Type
- MuleSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| muleJavaHome | settingValue |
MuleConfigFile
Overview
MuleConfigFile:
The name of the Mule configuration file (to be found in the CLASSPATH, or on the file system)
Design
- Super Type
- MuleSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| muleConfigFile | settingValue |


