Pulls messages from a JMS Topic, creating a FlowFile for each JMS Message or bundle of messages, as configured
Tags: jms, topic, subscription, durable, non-durable, listen, get, pull, source, consume, consumer
Properties:
In the list below, the names of required properties appear in bold. Anyother properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the NiFi Expression Language (or simply EL), 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 nifi.properties file has an entry for the property nifi.sensitive.props.key.
| Name | Description | Default Value | Valid Values | EL | Sensitive |
|---|---|---|---|---|---|
| JMS Provider | The Provider used for the JMS Server | ActiveMQ |
| No | No |
| URL | The URL of the JMS Server | No | No | ||
| Destination Name | The name of the JMS Topic or queue to use | No | No | ||
| Communications Timeout | The amount of time to wait when attempting to receive a message before giving up and assuming failure | 30 sec | No | No | |
| Message Batch Size | The number of messages to pull/push in a single iteration of the processor | 10 | No | No | |
| Username | Username used for authentication and authorization | No | No | ||
| Password | Password used for authentication and authorization | No | Yes | ||
| Acknowledgement Mode | 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. | Client Acknowledge |
| No | No |
| Message Selector | The JMS Message Selector to use in order to narrow the messages that are pulled | No | No | ||
| Copy JMS Properties to Attributes | 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 | true |
| No | No |
| 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 | No | No | ||
| Use Durable Subscription | If true, connections to the specified topic will use Durable Subscription so that messages are queued when we are not pulling them | false |
| No | No |
Relationships:
| Name | Description |
|---|---|
| success | All FlowFiles are routed to success |