Consumes JMS Message of type BytesMessage, TextMessage, ObjectMessage, MapMessage or StreamMessage transforming its content to a FlowFile and transitioning it to 'success' relationship. JMS attributes such as headers and properties will be copied as FlowFile attributes. MapMessages will be transformed into JSONs and then into byte arrays. The other types will have their raw contents as byte array transferred into the flowfile.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|
| Connection Factory Service | Connection Factory Service | | Controller Service API:
JMSConnectionFactoryProviderDefinition
Implementations: JndiJmsConnectionFactoryProvider
JMSConnectionFactoryProvider | The Controller Service that is used to obtain Connection Factory. Alternatively, the 'JNDI *' or the 'JMS *' properties can also be be used to configure the Connection Factory. |
| Destination Name | Destination Name | | | The name of the JMS Destination. Usually provided by the administrator (e.g., 'topic://myTopic' or 'myTopic').
Supports Expression Language: true (will be evaluated using variable registry only) |
| Destination Type | Destination Type | QUEUE | | The type of the JMS Destination. Could be one of 'QUEUE' or 'TOPIC'. Usually provided by the administrator. Defaults to 'QUEUE' |
| Message Selector | Message Selector | | | The JMS Message Selector to filter the messages that the processor will receive
Supports Expression Language: true (will be evaluated using variable registry only) |
| User Name | User Name | | | User Name used for authentication and authorization.
Supports Expression Language: true (will be evaluated using variable registry only) |
| Password | Password | | | Password used for authentication and authorization.
Sensitive Property: true |
| Connection Client ID | Connection Client ID | | | The client id to be set on the connection, if set. For durable non shared consumer this is mandatory, for all others it is optional, typically with shared consumers it is undesirable to be set. Please see JMS spec for further details
Supports Expression Language: true (will be evaluated using variable registry only) |
| Session Cache Size | Session Cache size | 1 | | This property is deprecated and no longer has any effect on the Processor. It will be removed in a later version. |
| Character Set | character-set | UTF-8 | | The name of the character set to use to construct or interpret TextMessages
Supports Expression Language: true (will be evaluated using variable registry only) |
| Acknowledgement Mode | Acknowledgement Mode | CLIENT_ACKNOWLEDGE (2) | - AUTO_ACKNOWLEDGE (1)
 - CLIENT_ACKNOWLEDGE (2)
- DUPS_OK_ACKNOWLEDGE (3)
| 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. |
| Durable Subscription | Durable subscription | false | | If destination is Topic if present then make it the consumer durable. @see https://docs.oracle.com/javaee/7/api/javax/jms/Session.html#createDurableConsumer-javax.jms.Topic-java.lang.String-
Supports Expression Language: true (will be evaluated using variable registry only) |
| Shared Subscription | Shared subscription | false | | If destination is Topic if present then make it the consumer shared. @see https://docs.oracle.com/javaee/7/api/javax/jms/Session.html#createSharedConsumer-javax.jms.Topic-java.lang.String-
Supports Expression Language: true (will be evaluated using variable registry only) |
| Subscription Name | Subscription Name | | | The name of the subscription to use if destination is Topic and is shared or durable.
Supports Expression Language: true (will be evaluated using variable registry only) |
| Timeout | Timeout | 1 sec | | How long to wait to consume a message from the remote broker before giving up.
Supports Expression Language: true (will be evaluated using variable registry only) |
| Error Queue Name | Error Queue Name | | | The name of a JMS Queue where - if set - unprocessed messages will be routed. Usually provided by the administrator (e.g., 'queue://myErrorQueue' or 'myErrorQueue').Only applicable if 'Destination Type' is set to 'QUEUE'
Supports Expression Language: true (will be evaluated using variable registry only) |
| Record Reader | record-reader | | Controller Service API:
RecordReaderFactory
Implementations: CEFReader
SyslogReader
ReaderLookup
ProtobufReader
Syslog5424Reader
CSVReader
GrokReader
WindowsEventLogReader
ScriptedReader
AvroReader
ParquetReader
JsonPathReader
ExcelReader
JsonTreeReader
YamlTreeReader
XMLReader | The Record Reader to use for parsing received JMS Messages into Records. |
| Record Writer | record-writer | | Controller Service API:
RecordSetWriterFactory
Implementations: JsonRecordSetWriter
RecordSetWriterLookup
AvroRecordSetWriter
XMLRecordSetWriter
FreeFormTextRecordSetWriter
CSVRecordSetWriter
ParquetRecordSetWriter
ScriptedRecordSetWriter | The Record Writer to use for serializing Records before writing them to a FlowFile.
This Property is only considered if the [Record Reader] Property has a value specified. |
| Output Strategy | output-strategy | Use Content as Value | - Use Content as Value
- Use Wrapper
- Use Appender
| The format used to output the JMS message into a FlowFile record.
This Property is only considered if the [Record Reader] Property has a value specified. |
| JNDI Initial Context Factory Class | java.naming.factory.initial | | | The fully qualified class name of the JNDI Initial Context Factory Class (java.naming.factory.initial).
Supports Expression Language: true (will be evaluated using variable registry only) |
| JNDI Provider URL | java.naming.provider.url | | | The URL of the JNDI Provider to use as the value for java.naming.provider.url. See additional details documentation for allowed URL schemes.
Supports Expression Language: true (will be evaluated using variable registry only) |
| JNDI Name of the Connection Factory | connection.factory.name | | | The name of the JNDI Object to lookup for the Connection Factory.
Supports Expression Language: true (will be evaluated using variable registry only) |
| JNDI / JMS Client Libraries | naming.factory.libraries | | | Specifies jar files and/or directories to add to the ClassPath in order to load the JNDI / JMS client libraries. This should be a comma-separated list of files, directories, and/or URLs. If a directory is given, any files in that directory will be included, but subdirectories will not be included (i.e., it is not recursive).
This property expects a comma-separated list of resources. Each of the resources may be of any of the following types: URL, file, directory.
Supports Expression Language: true (will be evaluated using variable registry only) |
| JNDI Principal | java.naming.security.principal | | | The Principal to use when authenticating with JNDI (java.naming.security.principal).
Supports Expression Language: true (will be evaluated using variable registry only) |
| JNDI Credentials | java.naming.security.credentials | | | The Credentials to use when authenticating with JNDI (java.naming.security.credentials).
Sensitive Property: true |
| JMS Connection Factory Implementation Class | cf | | | The fully qualified name of the JMS ConnectionFactory implementation class (eg. org.apache.activemq.ActiveMQConnectionFactory).
Supports Expression Language: true (will be evaluated using variable registry only) |
| JMS Client Libraries | cflib | | | Path to the directory with additional resources (eg. JARs, configuration files etc.) to be added to the classpath (defined as a comma separated list of values). Such resources typically represent target JMS client libraries for the ConnectionFactory implementation.
This property expects a comma-separated list of resources. Each of the resources may be of any of the following types: URL, file, directory.
Supports Expression Language: true (will be evaluated using variable registry only) |
| JMS Broker URI | broker | | | URI pointing to the network location of the JMS Message broker. Example for ActiveMQ: 'tcp://myhost:61616'. Examples for IBM MQ: 'myhost(1414)' and 'myhost01(1414),myhost02(1414)'.
Supports Expression Language: true (will be evaluated using variable registry only) |
| JMS SSL Context Service | SSL Context Service | | Controller Service API:
SSLContextService
Implementations: StandardSSLContextService
StandardRestrictedSSLContextService | The SSL Context Service used to provide client certificate information for TLS/SSL connections. |
Dynamic Properties allow the user to specify both the name and value of a property.
| Name | Description |
|---|
| jms_deliveryMode | The JMSDeliveryMode from the message header. |
| jms_expiration | The JMSExpiration from the message header. |
| jms_priority | The JMSPriority from the message header. |
| jms_redelivered | The JMSRedelivered from the message header. |
| jms_timestamp | The JMSTimestamp from the message header. |
| jms_correlationId | The JMSCorrelationID from the message header. |
| jms_messageId | The JMSMessageID from the message header. |
| jms_type | The JMSType from the message header. |
| jms_replyTo | The JMSReplyTo from the message header. |
| jms_destination | The JMSDestination from the message header. |
| jms.messagetype | The JMS message type, can be TextMessage, BytesMessage, ObjectMessage, MapMessage or StreamMessage). |
| other attributes | Each message property is written to an attribute. |