Volante Module Connector Reference

Configurations

Mule Project with Maven

Default configuration

Parameters

Name	Type	Description	Required
Name	String	The name for this configuration. Connectors reference the configuration with this name.	x
Connection	Maven Connection	The connection types that can be provided to this configuration.	x
Name	String	The identifier of this element used to reference it in other components	x
Expiration Policy	Expiration Policy	Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.

Name

Type

Description

Default Value

Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

Maven Connection

The connection types that can be provided to this configuration.

x

Name

String

The identifier of this element used to reference it in other components

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.

Connection Types

Maven Connection

Maven based Connection Provider for capturing messageFlow and TransformContext properties

Parameters

Name	Type	Description	Required
Message Flow	String	Name of the MessageFlow	x
Transform Contexts	Object	TransformContext properties
Reconnection	Reconnection	When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Name

Type

Description

Default Value

Required

Message Flow

String

Name of the MessageFlow

x

Transform Contexts

Object

TransformContext properties

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Operations

Volante POJO Transformer

<volante:transform-pojo>

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Primary Input	Any	This value will be passed as first input to volante flow	#[payload]
Additional Input	Object	Additional inputs will be passed as inputs to volante flow and as attachments of primary input [applicable only if volante flow’s primary input is of type RawMessage]. Input keys of additional inputs should match with volante flow’s inputs.
Config Ref	ConfigurationProvider	The name of the configuration to be used to execute this component		x
Target Variable	String	The name of a variable on which the operation’s output will be placed
Target Value	String	An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

x

Primary Input

Any

This value will be passed as first input to volante flow

#[payload]

Additional Input

Object

Additional inputs will be passed as inputs to volante flow and as attachments of primary input [applicable only if volante flow’s primary input is of type RawMessage]. Input keys of additional inputs should match with volante flow’s inputs.

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Object

For Configurations

Mule Project with Maven

Throws

VOLANTE:CONNECTIVITY
VOLANTE:RETRY_EXHAUSTED
VOLANTE:TRANSFORM

Volante Byte Array Transformer

<volante:transform-byte-array>

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Primary Byte Array Input	Any	This value will be passed as first input to volante flow	#[payload]
Additional Input	Object	Additional inputs will be passed as inputs to volante flow and as attachments of primary input [applicable only if volante flow’s primary input is of type RawMessage]. Input keys of additional inputs should match with volante flow’s inputs.
Config Ref	ConfigurationProvider	The name of the configuration to be used to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure if repeatable streams should be used and their behaviour
Target Variable	String	The name of a variable on which the operation’s output will be placed
Target Value	String	An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

x

Primary Byte Array Input

Any

This value will be passed as first input to volante flow

#[payload]

Additional Input

Object

Additional inputs will be passed as inputs to volante flow and as attachments of primary input [applicable only if volante flow’s primary input is of type RawMessage]. Input keys of additional inputs should match with volante flow’s inputs.

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

Configure if repeatable streams should be used and their behaviour

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Binary

Attributes Type

Object

For Configurations

Mule Project with Maven

Throws

VOLANTE:CONNECTIVITY
VOLANTE:RETRY_EXHAUSTED
VOLANTE:TRANSFORM

Volante Transformer

<volante:transform-object>

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Primary Input	Any	This value will be passed as first input to volante flow	#[payload]
Additional Input	Object	Additional inputs will be passed as inputs to volante flow and as attachments of primary input [applicable only if volante flow’s primary input is of type RawMessage]. Input keys of additional inputs should match with volante flow’s inputs.
Config Ref	ConfigurationProvider	The name of the configuration to be used to execute this component		x
Target Variable	String	The name of a variable on which the operation’s output will be placed
Target Value	String	An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

x

Primary Input

Any

This value will be passed as first input to volante flow

#[payload]

Additional Input

Object

Additional inputs will be passed as inputs to volante flow and as attachments of primary input [applicable only if volante flow’s primary input is of type RawMessage]. Input keys of additional inputs should match with volante flow’s inputs.

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Object

For Configurations

Mule Project with Maven

Throws

VOLANTE:CONNECTIVITY
VOLANTE:RETRY_EXHAUSTED
VOLANTE:TRANSFORM

Volante String Transformer

<volante:transform-string>

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Primary String Input	String	This value will be passed as first input to volante flow	#[payload]
Additional Input	Object	Additional inputs will be passed as inputs to volante flow and as attachments of primary input [applicable only if volante flow’s primary input is of type RawMessage]. Input keys of additional inputs should match with volante flow’s inputs.
Config Ref	ConfigurationProvider	The name of the configuration to be used to execute this component		x
Target Variable	String	The name of a variable on which the operation’s output will be placed
Target Value	String	An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

x

Primary String Input

String

This value will be passed as first input to volante flow

#[payload]

Additional Input

Object

Additional inputs will be passed as inputs to volante flow and as attachments of primary input [applicable only if volante flow’s primary input is of type RawMessage]. Input keys of additional inputs should match with volante flow’s inputs.

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

Object

For Configurations

Mule Project with Maven

Throws

VOLANTE:CONNECTIVITY
VOLANTE:RETRY_EXHAUSTED
VOLANTE:TRANSFORM

Types

Reconnection

Field	Type	Description	Default Value	Required
Fails Deployment	Boolean	When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy
Reconnection Strategy	Reconnect Reconnect Forever	The reconnection strategy to use

Field

Type

Description

Default Value

Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Reconnection Strategy

Reconnect
Reconnect Forever

The reconnection strategy to use

Reconnect

Field	Type	Description
Frequency	Number	How often (in ms) to reconnect
Blocking	Boolean	If false, the reconnection strategy will run in a separate, non-blocking thread
Count	Number	How many reconnection attempts to make

Field

Type

Description

Default Value

Required

Frequency

Number

How often (in ms) to reconnect

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread

Count

Number

How many reconnection attempts to make

Reconnect Forever

Field	Type	Description	Default Value	Required
Frequency	Number	How often (in ms) to reconnect
Blocking	Boolean	If false, the reconnection strategy will run in a separate, non-blocking thread

Field

Type

Description

Default Value

Required

Frequency

Number

How often (in ms) to reconnect

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread

Expiration Policy

Field	Type	Description	Default Value	Required
Max Idle Time	Number	A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration
Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the maxIdleTime attribute

Field

Type

Description

Default Value

Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit that qualifies the maxIdleTime attribute

Error Mapping

Field	Type	Description	Default Value	Required
Source	Enumeration, one of: ANY REDELIVERY_EXHAUSTED TRANSFORMATION EXPRESSION SECURITY CLIENT_SECURITY SERVER_SECURITY ROUTING CONNECTIVITY RETRY_EXHAUSTED TIMEOUT
Target	String			x

Field

Type

Description

Default Value

Required

Source

Enumeration, one of:

ANY
REDELIVERY_EXHAUSTED
TRANSFORMATION
EXPRESSION
SECURITY
CLIENT_SECURITY
SERVER_SECURITY
ROUTING
CONNECTIVITY
RETRY_EXHAUSTED
TIMEOUT

Target

String

x

Repeatable In Memory Stream

Field	Type	Description
Initial Buffer Size	Number	This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.
Buffer Size Increment	Number	This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full.
Max Buffer Size	Number	This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.
Buffer Unit	Enumeration, one of: BYTE KB MB GB	The unit in which all these attributes are expressed

Field

Type

Description

Default Value

Required

Initial Buffer Size

Number

This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full.

Max Buffer Size

Number

This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

BYTE
KB
MB
GB

The unit in which all these attributes are expressed

Repeatable File Store Stream

Field	Type	Description	Default Value	Required
In Memory Size	Number	Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.
Buffer Unit	Enumeration, one of: BYTE KB MB GB	The unit in which maxInMemorySize is expressed

Field

Type

Description

Default Value

Required

In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

BYTE
KB
MB
GB

The unit in which maxInMemorySize is expressed