Configurations

Config

JmsExtension is a JMS 1.0.2b, 1.1 and 2.0 compliant MuleSoft Extension, used to consume and produce JMS Messages. The Extension supports all JMS functionality including topics and queues, durable subscribers, acknowledgement modes and local transactions.

Parameters

Name Type Description Default Value Required

Name

String

The name of this configuration. With this name can be later referenced.

x 

Encoding

String

 

Content Type

String

*/*

 

Consumer Config

 

Producer Config

 

Associated Operations

Associated Sources

Operations

Ack

<jmsn:ack>

Allows the user to perform an ACK when the AckMode#MANUAL mode is elected while consuming the Message. As per JMS Spec, performing an ACK over a single Message automatically works as an ACK for all the Messages produced in the same JmsSession.

The ackId must refer to a JmsSession created using the current JmsConnection. If the JmsSession or JmsConnection were closed, the ACK will fail. If the ackId does not belong to a JmsSession created using the current JmsConnection to a session of the current connection

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Ack Id

String

the JmsSession#getAckId

x 

For Configurations.

Throws

  • JMSN:ACK  

  • JMSN:CONNECTIVITY  

  • JMSN:RETRY_EXHAUSTED  

Consume

<jmsn:consume>

Operation that allows the user to consume a single Message from a given Destination. extra configurations that are required based on the destination type. and headers as Result#getAttributes

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Destination

String

the name of the Destination from where the Message should be consumed

x 

Consumer Type

the type of the MessageConsumer that is required for the given destination, along with any

 

Ack Mode

Enumeration, one of:

  • NONE

  • AUTO

  • MANUAL

  • DUPS_OK

  • TRANSACTED

the AckMode that will be configured over the Message and Session

 

Selector

String

a custom JMS selector for filtering the messages

 

Content Type

String

the Message's content content type

 

Encoding

String

the Message's content encoding

 

Maximum Wait

Number

maximum time to wait for a message before timing out

10000

 

Maximum Wait Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to be used in the maximumWaitTime configurations

MILLISECONDS

 

Target Variable

String

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

 

Output

Type

Any

Attributes Type

For Configurations.

Throws

  • JMSN:ACK  

  • JMSN:CONNECTIVITY  

  • JMSN:CONSUMING  

  • JMSN:TIMEOUT  

  • JMSN:RETRY_EXHAUSTED  

Publish

<jmsn:publish>

Operation that allows the user to send a Message to a JMS Destination

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Destination

String

the name of the Destination where the Message should be sent

x 

Destination Type

Enumeration, one of:

  • QUEUE

  • TOPIC

QUEUE

 

Message Builder

the MessageBuilder used to create the Message to be sent

 

Persistent Delivery

Boolean

true if DeliveryMode#PERSISTENT should be used

 

Priority

Number

the Message#getJMSPriority to be set

 

Time To Live

Number

the time the message will be in the broker before it expires and is discarded

 

Time To Live Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

unit to be used in the timeToLive configurations

 

Disable Message Id

Boolean

 

Disable Message Timestamp

Boolean

 

Delivery Delay

Number

Only used by JMS 2.0. Sets the delivery delay to be applied in order to postpone the Message delivery

 

Delivery Delay Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to be used in the deliveryDelay configurations

 

For Configurations.

Throws

  • JMSN:CONNECTIVITY  

  • JMSN:PUBLISHING  

  • JMSN:RETRY_EXHAUSTED  

  • JMSN:ILLEGAL_BODY  

Publish Consume

<jmsn:publish-consume>

Operation that allows the user to send a message to a JMS Destination and waits for a response either to the provided ReplyTo destination or to a temporary Destination created dynamically and headers as Result#getAttributes

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Destination

String

the name of the Destination where the Message should be sent

x 

Message Builder

the MessageBuilder used to create the Message to be sent

 

Ack Mode

Enumeration, one of:

  • NONE

  • AUTO

  • MANUAL

  • DUPS_OK

  • TRANSACTED

the AckMode that will be configured over the Message and Session

 

Maximum Wait

Number

10000

 

Maximum Wait Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

MILLISECONDS

 

Target Variable

String

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

 

Persistent Delivery

Boolean

 

Priority

Number

 

Time To Live

Number

 

Time To Live Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

 

Disable Message Id

Boolean

 

Disable Message Timestamp

Boolean

 

Delivery Delay

Number

 

Delivery Delay Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

 

Output

Type

Any

Attributes Type

For Configurations.

Throws

  • JMSN:ACK  

  • JMSN:CONNECTIVITY  

  • JMSN:CONSUMING  

  • JMSN:PUBLISHING  

  • JMSN:TIMEOUT  

  • JMSN:RETRY_EXHAUSTED  

  • JMSN:ILLEGAL_BODY  

Sources

Listener

<jmsn:listener>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Destination

String

x 

Consumer Type

 

Ack Mode

Enumeration, one of:

  • NONE

  • AUTO

  • MANUAL

  • DUPS_OK

  • TRANSACTED

 

Selector

String

 

Content Type

String

 

Encoding

String

 

Redelivery Policy

Defines a policy for processing the redelivery of the same message

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Response

 

Output

Type

Any

Attributes Type

For Configurations.

Types

Jms Consumer Config

Field Type

Ack Mode

Enumeration, one of:

  • NONE

  • AUTO

  • MANUAL

  • DUPS_OK

  • TRANSACTED

Consumer Type

Selector

String

Max Redelivery

Number

Jms Producer Config

Field Type

Persistent Delivery

Boolean

Priority

Number

Time To Live

Number

Time To Live Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Disable Message Id

Boolean

Disable Message Timestamp

Boolean

Delivery Delay

Number

Delivery Delay Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Jms Type

String

Redelivery Policy

Field Type

Max Redelivery Count

Number

Use Secure Hash

Boolean

Message Digest Algorithm

String

Id Expression

String

Object Store Ref

String

Reconnect

Field Type

Frequency

Number

Count

Number

Blocking

Boolean

Reconnect Forever

Field Type

Frequency

Number

Response Builder

Field Type

Message Builder

Overrides

Message Builder

Field Type

Body

Any

Jms Type

String

Correlation Id

String

Send Content Type

Boolean

Content Type

String

Send Encoding

Boolean

Encoding

String

Reply To

Properties

Object

Jmsx Properties

Jms Destination

Field Type

Destination

String

Destination Type

Enumeration, one of:

  • QUEUE

  • TOPIC

Jmsx Properties

Field Type

Jmsx User ID

String

Jmsx App ID

String

Jmsx Delivery Count

Number

Jmsx Group ID

String

Jmsx Group Seq

Number

Jmsx Producer TXID

String

Jmsx Consumer TXID

String

Jmsx Rcv Timestamp

Number

Jms Publish Parameters

Field Type

Persistent Delivery

Boolean

Priority

Number

Time To Live

Number

Time To Live Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Disable Message Id

Boolean

Disable Message Timestamp

Boolean

Delivery Delay

Number

Delivery Delay Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Pooling Profile

Field Type

Max Active

Number

Max Idle

Number

Max Wait

Number

Min Eviction Millis

Number

Eviction Check Interval Millis

Number

Exhausted Action

Enumeration, one of:

  • WHEN_EXHAUSTED_GROW

  • WHEN_EXHAUSTED_WAIT

  • WHEN_EXHAUSTED_FAIL

Initialisation Policy

Enumeration, one of:

  • INITIALISE_NONE

  • INITIALISE_ONE

  • INITIALISE_ALL

Disabled

Boolean

Active MQ Connection Factory Configuration

Field Type

Broker Url

String

Enable Xa

Boolean

Initial Redelivery Delay

Number

Redelivery Delay

Number

Max Redelivery

Number

Queue Consumer

Field Type

Topic

Boolean

Topic Consumer

Field Type

Is Durable

Boolean

Is Shared

Boolean

No Local

Boolean

Subscription Name

String

Default Caching

Field Type

Session Cache Size

Number

Cache Producers

Boolean

Cache Consumers

Boolean

Jndi Connection Factory

Field Type

Connection Factory Jndi Name

String

Lookup Destination

Enumeration, one of:

  • NEVER

  • ALWAYS

  • TRY_ALWAYS

Name Resolver Provider

Jndi Name Resolver Provider

Field Type

Custom Jndi Name Resolver

Name Resolver Builder

Jndi Name Resolver Properties

Field Type

Jndi Initial Context Factory

String

Jndi Provider Url

String

Provider Properties

Object

Simple Jndi Name Resolver

Field Type

Context Factory

Any

Jndi Initial Factory

String

Jndi Provider Properties

Object

Jndi Provider Url

String

Cached Jndi Name Resolver

Field Type

Context Factory

Any

Jndi Initial Factory

String

Jndi Provider Properties

Object

Jndi Provider Url

String