Summary: Configuration | Message Processors

org.mule.modules

mule-module-ion

1.0-RC1

Namespace	http://www.mulesoft.org/schema/mule/ion
Schema Location	http://www.mulesoft.org/schema/mule/ion/1.0/mule-ion.xsd
Version	1.0
Minimum Mule Version	3.2

Module Overview

Provides the ability to interact with Mule iON from within a Mule application. There are operations to deploy, start, stop, and update applications as well as send notifications from your application to iON.

When running this connector in an application inside iON, it will use token based authentication to access the API. This will allow access and usage of the iON APIs without the need to specify your username and password.

Summary

Configuration
<ion:config> Configure an instance of this module

Message Processors
<ion:create-notification> Create a notification inside iON.
<ion:create-notification-from-flow> Create a notification inside iON for your flow.
<ion:delete-application> Delete an application.
<ion:deploy-application> Deploy specified application.
<ion:dismiss-all-notifications> Dismiss all notifications.
<ion:dismiss-notification> Dismiss an individual notification.
<ion:get-application> Get an application.
<ion:list-applications> List applications.
<ion:list-notifications> List a user's notifications.
<ion:start-application> Start an application.
<ion:stop-application> Stop an application.
<ion:update-application> Update an application.

Configuration

To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:

<mule xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:ion="http://www.mulesoft.org/schema/mule/ion"
      xsi:schemaLocation="
               http://www.mulesoft.org/schema/mule/core
               http://www.mulesoft.org/schema/mule/core/current/mule.xsd
               http://www.mulesoft.org/schema/mule/ion
               http://www.mulesoft.org/schema/mule/ion/1.0/mule-ion.xsd">

      <!-- here goes your flows and configuration elements -->

</mule>

This module is configured using the config element. This element must be placed outside of your flows and at the root of your Mule application. You can create as many configurations as you deem necesary as long as each carries its own name.

Each message processor, message source or transformer carries a config-ref attribute that allows the invoker to specify which configuration to use.

Attributes
Type	Name	Default Value	Description
xs:string	name		Optional. Give a name to this configuration so it can be later referenced.
xs:long	maxWaitTime	0	Optional. Maximum time allowed to deplpoy/undeploy.
xs:string	password		Optional. iON password.
xs:string	url	https://muleion.com/	Optional. iON URL.
xs:string	username		Optional. iON username.

Message Processors

<ion:create-notification>

Create a notification inside iON.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
message		The contents of the notification.
priority		The notification priority.
domain		Optional. The application domain.
payload		The payload of the message. If it's an exception, it'll get appended to the message.

Child Elements

Return Payload

The notification that was created.

<ion:create-notification-from-flow>

Create a notification inside iON for your flow. If not running in an iON environment, this will log to the console.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
message		The contents of the notification.
priority		The notification priority.
payload		The payload of the message. If it's an exception, it'll get appended to the message.
includeStacktrace		Optional. If the message payload contains an Exception, whether or not to include the stacktrace. True by default.

Child Elements

<ion:delete-application>

Delete an application.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
domain		The application domain.

Child Elements

<ion:deploy-application>

Deploy specified application.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
file		Mule application to deploy
domain		The application domain.
muleVersion		Optional. The version of Mule, e.g. 3.2.2.
workerCount		Optional. The number of workers to deploy.

Child Elements

<ion:environmentVariables> Optional. Environment variables for you application.

<ion:dismiss-all-notifications>

Dismiss all notifications.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.

Child Elements

<ion:dismiss-notification>

Dismiss an individual notification.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
href		The href property of the Notification object.

Child Elements

<ion:get-application>

Get an application.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
domain		The application domain.

Child Elements

Return Payload

An application.

<ion:list-applications>

List applications.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.

Child Elements

Return Payload

A list of applications.

<ion:list-notifications>

List a user's notifications.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
domain		Optional. The domain to list notifications for.
maxResults		Optional. The maximum number of results to retrieve.
offset		Optional. The offset to start listing alerts from.
includeDismissed		Optional. Whether or not to include dismissed messages.

Child Elements

Return Payload

A List of notifications.

<ion:start-application>

Start an application.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
domain		The application domain.

Child Elements

<ion:stop-application>

Stop an application.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
domain		The application domain.

Child Elements

<ion:update-application>

Update an application.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
application		The application to update.