ConsumeJMS

ConsumeJMS 2.0.0

Bundle: org.apache.nifi | nifi-jms-processors-nar
Description: 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.
Tags: consume, get, jms, message, receive
Input Requirement: FORBIDDEN
Supports Sensitive Dynamic Properties: false

Properties

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.
Display Name

Acknowledgement Mode

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.

API Name

Acknowledgement Mode

Default Value

2

Allowable Values
- AUTO_ACKNOWLEDGE (1)
- CLIENT_ACKNOWLEDGE (2)
- DUPS_OK_ACKNOWLEDGE (3)
Expression Language Scope

Not Supported

Sensitive

false

Required

true
JMS Broker URI
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)'.

Display Name

JMS Broker URI

Description

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)'.

API Name

broker

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
JMS Connection Factory Implementation Class
The fully qualified name of the JMS ConnectionFactory implementation class (eg. org.apache.activemq.ActiveMQConnectionFactory).

Display Name

JMS Connection Factory Implementation Class

Description

The fully qualified name of the JMS ConnectionFactory implementation class (eg. org.apache.activemq.ActiveMQConnectionFactory).

API Name

cf

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
JMS Client Libraries
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.

Display Name

JMS Client Libraries

Description

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.

API Name

cflib

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Character Set
The name of the character set to use to construct or interpret TextMessages

Display Name

Character Set

Description

The name of the character set to use to construct or interpret TextMessages

API Name

character-set

Default Value

UTF-8

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
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

Display Name

Connection Client ID

Description

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

API Name

Connection Client ID

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Connection Factory Service
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.

Display Name

Connection Factory Service

Description

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.

API Name

Connection Factory Service

Service Interface

org.apache.nifi.jms.cf.JMSConnectionFactoryProviderDefinition

Service Implementations

org.apache.nifi.jms.cf.JMSConnectionFactoryProvider

org.apache.nifi.jms.cf.JndiJmsConnectionFactoryProvider

Expression Language Scope

Not Supported

Sensitive

false

Required

false
JNDI Name of the Connection Factory
The name of the JNDI Object to lookup for the Connection Factory.

Display Name

JNDI Name of the Connection Factory

Description

The name of the JNDI Object to lookup for the Connection Factory.

API Name

connection.factory.name

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Destination Name
The name of the JMS Destination. Usually provided by the administrator (e.g., 'topic://myTopic' or 'myTopic').

Display Name

Destination Name

Description

The name of the JMS Destination. Usually provided by the administrator (e.g., 'topic://myTopic' or 'myTopic').

API Name

Destination Name

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Destination Type
The type of the JMS Destination. Could be one of 'QUEUE' or 'TOPIC'. Usually provided by the administrator. Defaults to 'QUEUE'
Display Name

Destination Type

Description

The type of the JMS Destination. Could be one of 'QUEUE' or 'TOPIC'. Usually provided by the administrator. Defaults to 'QUEUE'

API Name

Destination Type

Default Value

QUEUE

Allowable Values
- QUEUE
- TOPIC
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Durable Subscription
If destination is Topic if present then make it the consumer durable. @see https://jakarta.ee/specifications/platform/9/apidocs/jakarta/jms/session#createDurableConsumer-jakarta.jms.Topic-java.lang.String-
Display Name

Durable Subscription

Description

If destination is Topic if present then make it the consumer durable. @see https://jakarta.ee/specifications/platform/9/apidocs/jakarta/jms/session#createDurableConsumer-jakarta.jms.Topic-java.lang.String-

API Name

Durable subscription

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
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'

Display Name

Error Queue Name

Description

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'

API Name

Error Queue Name

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
JNDI Initial Context Factory Class
The fully qualified class name of the JNDI Initial Context Factory Class (java.naming.factory.initial).

Display Name

JNDI Initial Context Factory Class

Description

The fully qualified class name of the JNDI Initial Context Factory Class (java.naming.factory.initial).

API Name

java.naming.factory.initial

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
JNDI 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.

Display Name

JNDI Provider URL

Description

The URL of the JNDI Provider to use as the value for java.naming.provider.url. See additional details documentation for allowed URL schemes.

API Name

java.naming.provider.url

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
JNDI Credentials
The Credentials to use when authenticating with JNDI (java.naming.security.credentials).

Display Name

JNDI Credentials

Description

The Credentials to use when authenticating with JNDI (java.naming.security.credentials).

API Name

java.naming.security.credentials

Expression Language Scope

Not Supported

Sensitive

true

Required

false
JNDI Principal
The Principal to use when authenticating with JNDI (java.naming.security.principal).

Display Name

JNDI Principal

Description

The Principal to use when authenticating with JNDI (java.naming.security.principal).

API Name

java.naming.security.principal

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Maximum Batch Size
The maximum number of messages to publish or consume in each invocation of the processor.

Display Name

Maximum Batch Size

Description

The maximum number of messages to publish or consume in each invocation of the processor.

API Name

Maximum Batch Size

Default Value

1

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Message Selector
The JMS Message Selector to filter the messages that the processor will receive

Display Name

Message Selector

Description

The JMS Message Selector to filter the messages that the processor will receive

API Name

Message Selector

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
JNDI / JMS Client 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).

Display Name

JNDI / JMS Client Libraries

Description

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).

API Name

naming.factory.libraries

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Output Strategy
The format used to output the JMS message into a FlowFile record.
Display Name

Output Strategy

Description

The format used to output the JMS message into a FlowFile record.

API Name

output-strategy

Default Value

USE_VALUE

Allowable Values
- Use Content as Value
- Use Wrapper
- Use Appender
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Record Reader is set to any value specified
Password
Password used for authentication and authorization.

Display Name

Password

Description

Password used for authentication and authorization.

API Name

Password

Expression Language Scope

Not Supported

Sensitive

true

Required

false
Record Reader
The Record Reader to use for parsing received JMS Messages into Records.

Display Name

Record Reader

Description

The Record Reader to use for parsing received JMS Messages into Records.

API Name

record-reader

Service Interface

org.apache.nifi.serialization.RecordReaderFactory

Service Implementations

org.apache.nifi.avro.AvroReader

org.apache.nifi.cef.CEFReader

org.apache.nifi.csv.CSVReader

org.apache.nifi.excel.ExcelReader

org.apache.nifi.grok.GrokReader

org.apache.nifi.json.JsonPathReader

org.apache.nifi.json.JsonTreeReader

org.apache.nifi.services.protobuf.ProtobufReader

org.apache.nifi.lookup.ReaderLookup

org.apache.nifi.record.script.ScriptedReader

org.apache.nifi.syslog.Syslog5424Reader

org.apache.nifi.syslog.SyslogReader

org.apache.nifi.windowsevent.WindowsEventLogReader

org.apache.nifi.xml.XMLReader

org.apache.nifi.yaml.YamlTreeReader

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Record Writer
The Record Writer to use for serializing Records before writing them to a FlowFile.
Display Name

Record Writer

Description

The Record Writer to use for serializing Records before writing them to a FlowFile.

API Name

record-writer

Service Interface

org.apache.nifi.serialization.RecordSetWriterFactory

Service Implementations

org.apache.nifi.avro.AvroRecordSetWriter

org.apache.nifi.csv.CSVRecordSetWriter

org.apache.nifi.text.FreeFormTextRecordSetWriter

org.apache.nifi.json.JsonRecordSetWriter

org.apache.nifi.lookup.RecordSetWriterLookup

org.apache.nifi.record.script.ScriptedRecordSetWriter

org.apache.nifi.xml.XMLRecordSetWriter

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Record Reader is set to any value specified
Shared Subscription
If destination is Topic if present then make it the consumer shared. @see https://jakarta.ee/specifications/platform/9/apidocs/jakarta/jms/session#createSharedConsumer-jakarta.jms.Topic-java.lang.String-
Display Name

Shared Subscription

Description

If destination is Topic if present then make it the consumer shared. @see https://jakarta.ee/specifications/platform/9/apidocs/jakarta/jms/session#createSharedConsumer-jakarta.jms.Topic-java.lang.String-

API Name

Shared subscription

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
JMS SSL Context Service
The SSL Context Service used to provide client certificate information for TLS/SSL connections.

Display Name

JMS SSL Context Service

Description

The SSL Context Service used to provide client certificate information for TLS/SSL connections.

API Name

SSL Context Service

Service Interface

org.apache.nifi.ssl.SSLContextService

Service Implementations

org.apache.nifi.ssl.StandardRestrictedSSLContextService

org.apache.nifi.ssl.StandardSSLContextService

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Subscription Name
The name of the subscription to use if destination is Topic and is shared or durable.

Display Name

Subscription Name

Description

The name of the subscription to use if destination is Topic and is shared or durable.

API Name

Subscription Name

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Timeout
How long to wait to consume a message from the remote broker before giving up.

Display Name

Timeout

Description

How long to wait to consume a message from the remote broker before giving up.

API Name

Timeout

Default Value

1 sec

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
User Name
User Name used for authentication and authorization.

Display Name

User Name

Description

User Name used for authentication and authorization.

API Name

User Name

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false

Dynamic Properties

The name of a Connection Factory configuration property.
Additional configuration property for the Connection Factory. It can be used when the Connection Factory is being configured via the 'JNDI *' or the 'JMS *'properties of the processor. For more information, see the Additional Details page.

Name

The name of a Connection Factory configuration property.

Description

Additional configuration property for the Connection Factory. It can be used when the Connection Factory is being configured via the 'JNDI *' or the 'JMS *'properties of the processor. For more information, see the Additional Details page.

Value

The value of a given Connection Factory configuration property.

Expression Language Scope

ENVIRONMENT

Restrictions

Required Permission	Explanation
reference remote resources	Client Library Location can reference resources over HTTP

Relationships

Name	Description
success	All FlowFiles that are received from the JMS Destination are routed to this relationship
parse.failure	If a message cannot be parsed using the configured Record Reader, the contents of the message will be routed to this Relationship as its own individual FlowFile.

Writes Attributes

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.