Deprecation notice:

This processor is deprecated and may be removed in future releases.

Please consider using one the following alternatives: ConsumeJMS


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


jms, queue, 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.

Display NameAPI NameDefault ValueAllowable ValuesDescription
JMS ProviderJMS ProviderActiveMQ
  • ActiveMQ
The Provider used for the JMS Server
URLURLThe URL of the JMS Server
Destination NameDestination NameThe name of the JMS Topic or queue to use
Communications TimeoutCommunications Timeout30 secThe amount of time to wait when attempting to receive a message before giving up and assuming failure
Message Batch SizeMessage Batch Size10The number of messages to pull/push in a single iteration of the processor
UsernameUsernameUsername used for authentication and authorization
PasswordPasswordPassword used for authentication and authorization
Sensitive Property: true
SSL Context ServiceSSL Context ServiceController Service API:
Implementations: StandardRestrictedSSLContextService
The Controller Service to use in order to obtain an SSL Context.
Acknowledgement ModeAcknowledgement ModeClient 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 SelectorMessage SelectorThe JMS Message Selector to use in order to narrow the messages that are pulled
Copy JMS Properties to AttributesCopy JMS Properties to Attributestrue
  • 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 PrefixClient ID PrefixA 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


successAll FlowFiles are routed to success

Reads Attributes:

None specified.

Writes Attributes:

None specified.

State management:

This component does not store state.


This component is not restricted.

Input requirement:

This component does not allow an incoming relationship.

System Resource Considerations:

None specified.

See Also: