<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetJMSTopic</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">GetJMSTopic</h1><h2>Deprecation notice: </h2><p>This processor is deprecated and may be removed in future releases.</p><p>Please consider using one the following alternatives: <a href="../../../nifi-jms-processors-nar/1.19.1/org.apache.nifi.jms.processors.ConsumeJMS/index.html">ConsumeJMS</a></p><h2>Description: </h2><p>Pulls messages from a ActiveMQ JMS Topic, creating a FlowFile for each JMS Message or bundle of messages, as configured.</p><h3>Tags: </h3><p>jms, topic, subscription, durable, non-durable, listen, get, pull, source, consume, consumer</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Display Name</th><th>API Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>JMS Provider</strong></td><td>JMS Provider</td><td id="default-value">ActiveMQ</td><td id="allowable-values"><ul><li>ActiveMQ</li></ul></td><td id="description">The Provider used for the JMS Server</td></tr><tr><td id="name"><strong>URL</strong></td><td>URL</td><td></td><td id="allowable-values"></td><td id="description">The URL of the JMS Server</td></tr><tr><td id="name"><strong>Destination Name</strong></td><td>Destination Name</td><td></td><td id="allowable-values"></td><td id="description">The name of the JMS Topic or queue to use</td></tr><tr><td id="name"><strong>Communications Timeout</strong></td><td>Communications Timeout</td><td id="default-value">30 sec</td><td id="allowable-values"></td><td id="description">The amount of time to wait when attempting to receive a message before giving up and assuming failure</td></tr><tr><td id="name"><strong>Message Batch Size</strong></td><td>Message Batch Size</td><td id="default-value">10</td><td id="allowable-values"></td><td id="description">The number of messages to pull/push in a single iteration of the processor</td></tr><tr><td id="name">Username</td><td>Username</td><td></td><td id="allowable-values"></td><td id="description">Username used for authentication and authorization</td></tr><tr><td id="name">Password</td><td>Password</td><td></td><td id="allowable-values"></td><td id="description">Password used for authentication and authorization<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">SSL Context Service</td><td>SSL Context Service</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.19.1/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.19.1/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The Controller Service to use in order to obtain an SSL Context.</td></tr><tr><td id="name"><strong>Acknowledgement Mode</strong></td><td>Acknowledgement Mode</td><td id="default-value">Client Acknowledge</td><td id="allowable-values"><ul><li>Client Acknowledge</li><li>Auto Acknowledge</li></ul></td><td id="description">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.</td></tr><tr><td id="name">Message Selector</td><td>Message Selector</td><td></td><td id="allowable-values"></td><td id="description">The JMS Message Selector to use in order to narrow the messages that are pulled</td></tr><tr><td id="name"><strong>Copy JMS Properties to Attributes</strong></td><td>Copy JMS Properties to Attributes</td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">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</td></tr><tr><td id="name">Client ID Prefix</td><td>Client ID Prefix</td><td></td><td id="allowable-values"></td><td id="description">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</td></tr><tr><td id="name"><strong>Use Durable Subscription</strong></td><td>Use Durable Subscription</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, connections to the specified topic will use Durable Subscription so that messages are queued when we are not pulling them</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All FlowFiles are routed to success</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component does not allow an incoming relationship.<h3>System Resource Considerations:</h3>None specified.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.PutJMS/index.html">PutJMS</a></p></body></html>