ConsumeJMS

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.

Additional Details...

Tags:

jms, get, message, receive, consume

Properties:

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, whether a property supports the NiFi Expression Language, 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	Default Value	Allowable Values	Description
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			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	QUEUE	QUEUE TOPIC	The type of the JMS Destination. Could be one of 'QUEUE' or 'TOPIC'. Usually provided by the administrator. Defaults to 'QUEUE'
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 used for authentication and authorization. Supports Expression Language: true (will be evaluated using variable registry only)
Password			Password used for authentication and authorization. Sensitive Property: 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 Supports Expression Language: true (will be evaluated using variable registry only)
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	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	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	false	true 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	false	true 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			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	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			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)
JNDI Initial Context Factory Class			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			The URL of the JNDI Provider to use (java.naming.provider.url). Supports Expression Language: true (will be evaluated using variable registry only)
JNDI Name of the Connection Factory			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			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: file, directory, URL. Supports Expression Language: true (will be evaluated using variable registry only)
JNDI 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			The Credentials to use when authenticating with JNDI (java.naming.security.credentials). Sensitive Property: true
JMS Connection Factory Implementation Class			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			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: file, directory, URL. Supports Expression Language: true (will be evaluated using variable registry only)
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)'. Supports Expression Language: true (will be evaluated using variable registry only)
JMS 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:

Dynamic Properties allow the user to specify both the name and value of a property.

Name	Value	Description
The name of a Connection Factory configuration property.	The value of a given 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. Supports Expression Language: true (will be evaluated using variable registry only)

Relationships:

Name	Description
success	All FlowFiles that are received from the JMS Destination are routed to this relationship

Reads Attributes:

None specified.

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.

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component does not allow an incoming relationship.

System Resource Considerations: