Pulls messages from a JMS Topic, creating a FlowFile for each JMS Message or bundle of messages, as configured


jms, topic, subscription, durable, non-durable, listen, get, pull, source, consume, consumer


In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property is considered “sensitive”, meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the file has an entry for the property nifi.sensitive.props.key.

Name Default Value Allowable Values Description
JMS Provider ActiveMQ * ActiveMQ The Provider used for the JMS Server
URL The URL of the JMS Server
Destination Name The name of the JMS Topic or queue to use
Communications Timeout 30 sec The amount of time to wait when attempting to receive a message before giving up and assuming failure
Message Batch Size 10 The number of messages to pull/push in a single iteration of the processor
Username Username used for authentication and authorization
Password Password used for authentication and authorization
Sensitive Property: true
SSL Context Service Controller Service API:
The Controller Service to use in order to obtain an SSL Context.
Acknowledgement Mode Client Acknowledge * Client Acknowledge
* Auto Acknowledge
The JMS Acknowledgement Mode. Using Auto Acknowledge can cause messages to be lost on restart of NiFi but may provide better performance than Client Acknowledge.
Message Selector The JMS Message Selector to use in order to narrow the messages that are pulled
Copy JMS Properties to Attributes true * true
* false
Whether or not the JMS Message Properties should be copied to the FlowFile Attributes; if so, the attribute name will be jms.XXX, where XXX is the JMS Property name
Client ID Prefix A human-readable ID that can be used to associate connections with yourself so that the maintainers of the JMS Server know who to contact if problems arise
Use Durable Subscription false * true
* false
If true, connections to the specified topic will use Durable Subscription so that messages are queued when we are not pulling them


Name Description
success All FlowFiles are routed to success

Reads Attributes:

None specified.

Writes Attributes:

None specified.

See Also: