Package org.apache.nifi.jms.processors

Class ConsumeJMS

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.jms.processors.AbstractJMSProcessor<JMSConsumer>

org.apache.nifi.jms.processors.ConsumeJMS

All Implemented Interfaces:

ConfigurableComponent, Processor

@Tags({"jms","get","message","receive","consume"})
@InputRequirement(INPUT_FORBIDDEN)
@CapabilityDescription("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.")
@WritesAttribute(attribute="jms_deliveryMode",description="The JMSDeliveryMode from the message header.") @WritesAttribute(attribute="jms_expiration",description="The JMSExpiration from the message header.") @WritesAttribute(attribute="jms_priority",description="The JMSPriority from the message header.") @WritesAttribute(attribute="jms_redelivered",description="The JMSRedelivered from the message header.") @WritesAttribute(attribute="jms_timestamp",description="The JMSTimestamp from the message header.") @WritesAttribute(attribute="jms_correlationId",description="The JMSCorrelationID from the message header.") @WritesAttribute(attribute="jms_messageId",description="The JMSMessageID from the message header.") @WritesAttribute(attribute="jms_type",description="The JMSType from the message header.") @WritesAttribute(attribute="jms_replyTo",description="The JMSReplyTo from the message header.") @WritesAttribute(attribute="jms_destination",description="The JMSDestination from the message header.") @WritesAttribute(attribute="jms.messagetype",description="The JMS message type, can be TextMessage, BytesMessage, ObjectMessage, MapMessage or StreamMessage).") @WritesAttribute(attribute="other attributes",description="Each message property is written to an attribute.")
@DynamicProperty(name="The name of a Connection Factory configuration property.",
                 value="The value of a given 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.",
                 expressionLanguageScope=ENVIRONMENT)
@SeeAlso({PublishJMS.class,JMSConnectionFactoryProvider.class})
@Restricted(restrictions=@Restriction(requiredPermission=REFERENCE_REMOTE_RESOURCES,explanation="Client Library Location can reference resources over HTTP"))
public class ConsumeJMS
extends AbstractJMSProcessor<JMSConsumer>

Consuming JMS processor which upon each invocation of AbstractJMSProcessor.onTrigger(ProcessContext, ProcessSession) method will construct a FlowFile containing the body of the consumed JMS message and JMS properties that came with message which are added to a FlowFile as attributes.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.nifi.jms.processors.AbstractJMSProcessor

AbstractJMSProcessor.ConnectionFactoryConfigValidator

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final PropertyDescriptor	ACKNOWLEDGEMENT_MODE
(package private) static final AllowableValue	AUTO_ACK
(package private) static final AllowableValue	CLIENT_ACK
private static final String	COUNTER_PARSE_FAILURES
private static final String	COUNTER_RECORDS_PROCESSED
private static final String	COUNTER_RECORDS_RECEIVED
(package private) static final AllowableValue	DUPS_OK
(package private) static final PropertyDescriptor	DURABLE_SUBSCRIBER
(package private) static final PropertyDescriptor	ERROR_QUEUE
static final String	JMS_MESSAGETYPE
static final String	JMS_SOURCE_DESTINATION_NAME
(package private) static final PropertyDescriptor	MESSAGE_SELECTOR
(package private) static final PropertyDescriptor	OUTPUT_STRATEGY
private static final List<PropertyDescriptor>	propertyDescriptors
static final PropertyDescriptor	RECORD_READER
static final PropertyDescriptor	RECORD_WRITER
static final Relationship	REL_PARSE_FAILURE
static final Relationship	REL_SUCCESS
private static final Set<Relationship>	relationships
(package private) static final PropertyDescriptor	SHARED_SUBSCRIBER
(package private) static final PropertyDescriptor	SUBSCRIPTION_NAME
(package private) static final PropertyDescriptor	TIMEOUT

Fields inherited from class org.apache.nifi.jms.processors.AbstractJMSProcessor

BASE_RECORD_READER, BASE_RECORD_WRITER, BYTES_MESSAGE, CF_SERVICE, CHARSET, CLIENT_ID, DESTINATION, DESTINATION_TYPE, JMS_CF_PROPERTIES, JNDI_JMS_CF_PROPERTIES, PASSWORD, QUEUE, TEXT_MESSAGE, TOPIC, USER

Constructor Summary

Constructors

Constructor	Description
ConsumeJMS()

Method Summary

Modifier and Type	Method	Description
private void	acknowledge(List<JMSConsumer.JMSResponse> processedMessages, List<JMSConsumer.JMSResponse> failedMessages)
private void	acknowledge(JMSConsumer.JMSResponse response)
private FlowFile	createFlowFileFromMessage(ProcessSession processSession, String destinationName, JMSConsumer.JMSResponse response)
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
private JMSConsumer.JMSResponse	findLastBatchedJmsResponse(List<JMSConsumer.JMSResponse> processedMessages, List<JMSConsumer.JMSResponse> failedMessages)
protected JMSConsumer	finishBuildingJmsWorker(org.springframework.jms.connection.CachingConnectionFactory connectionFactory, org.springframework.jms.core.JmsTemplate jmsTemplate, ProcessContext processContext)	Will create an instance of JMSConsumer
Set<Relationship>	getRelationships()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
private static boolean	isDurableSubscriber(ProcessContext context)
private static boolean	isShared(ProcessContext context)
private Map<String,String>	mergeJmsAttributes(Map<String,String> headers, Map<String,String> properties)
void	onSchedule(ProcessContext context)
private void	processMessageSet(ProcessContext context, ProcessSession session, JMSConsumer consumer, String destinationName, String errorQueueName, boolean durable, boolean shared, String subscriptionName, String messageSelector, String charset)
private void	processSingleMessage(ProcessSession processSession, JMSConsumer consumer, String destinationName, String errorQueueName, boolean durable, boolean shared, String subscriptionName, String messageSelector, String charset)
private void	reject(List<JMSConsumer.JMSResponse> processedMessages, List<JMSConsumer.JMSResponse> failedMessages)
protected void	rendezvousWithJms(ProcessContext context, ProcessSession processSession, JMSConsumer consumer)	Will construct a FlowFile containing the body of the consumed JMS message (if JMSConsumer.JMSResponse returned by JMSConsumer is not null) and JMS properties that came with message which are added to a FlowFile as attributes, transferring FlowFile to 'success' Relationship.
protected void	setClientId(ProcessContext context, org.springframework.jms.connection.SingleConnectionFactory cachingFactory)	Use provided clientId for non shared durable consumers, if not set always a different value as defined in AbstractJMSProcessor.setClientId(ProcessContext, SingleConnectionFactory).
private FlowFile	updateFlowFileAttributesWithJMSAttributes(Map<String,String> jmsAttributes, FlowFile flowFile, ProcessSession processSession)	Copies JMS attributes (i.e., headers and properties) as FF attributes.
private void	withLog(Runnable runnable)

Methods inherited from class org.apache.nifi.jms.processors.AbstractJMSProcessor

close, getClientId, getSupportedDynamicPropertyDescriptor, migrateProperties, onTrigger, setupConnectionFactoryProvider, setupWorkerPool, shutdownConnectionFactoryProvider

Methods inherited from class org.apache.nifi.processor.AbstractProcessor

onTrigger

Methods inherited from class org.apache.nifi.processor.AbstractSessionFactoryProcessor

getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, init, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrue

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

equals, getPropertyDescriptor, getPropertyDescriptors, hashCode, onPropertyModified, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Methods inherited from interface org.apache.nifi.processor.Processor

isStateful, migrateRelationships

Field Details

JMS_MESSAGETYPE

public static final String JMS_MESSAGETYPE

See Also:

• Constant Field Values

COUNTER_PARSE_FAILURES

private static final String COUNTER_PARSE_FAILURES

See Also:

• Constant Field Values

COUNTER_RECORDS_RECEIVED

private static final String COUNTER_RECORDS_RECEIVED

See Also:

• Constant Field Values

COUNTER_RECORDS_PROCESSED

private static final String COUNTER_RECORDS_PROCESSED

See Also:

• Constant Field Values

AUTO_ACK

static final AllowableValue AUTO_ACK

CLIENT_ACK

static final AllowableValue CLIENT_ACK

DUPS_OK

static final AllowableValue DUPS_OK

JMS_SOURCE_DESTINATION_NAME

public static final String JMS_SOURCE_DESTINATION_NAME

See Also:

• Constant Field Values

MESSAGE_SELECTOR

static final PropertyDescriptor MESSAGE_SELECTOR

ACKNOWLEDGEMENT_MODE

static final PropertyDescriptor ACKNOWLEDGEMENT_MODE

DURABLE_SUBSCRIBER

static final PropertyDescriptor DURABLE_SUBSCRIBER

SHARED_SUBSCRIBER

static final PropertyDescriptor SHARED_SUBSCRIBER

SUBSCRIPTION_NAME

static final PropertyDescriptor SUBSCRIPTION_NAME

TIMEOUT

static final PropertyDescriptor TIMEOUT

ERROR_QUEUE

static final PropertyDescriptor ERROR_QUEUE

RECORD_READER

public static final PropertyDescriptor RECORD_READER

RECORD_WRITER

public static final PropertyDescriptor RECORD_WRITER

OUTPUT_STRATEGY

static final PropertyDescriptor OUTPUT_STRATEGY

REL_SUCCESS

public static final Relationship REL_SUCCESS

REL_PARSE_FAILURE

public static final Relationship REL_PARSE_FAILURE

relationships

private static final Set<Relationship> relationships

propertyDescriptors

private static final List<PropertyDescriptor> propertyDescriptors

Constructor Details

ConsumeJMS

public ConsumeJMS()

Method Details

isDurableSubscriber

private static boolean isDurableSubscriber(ProcessContext context)

isShared

private static boolean isShared(ProcessContext context)

onSchedule

@OnScheduled
public void onSchedule(ProcessContext context)

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractJMSProcessor<JMSConsumer>

rendezvousWithJms

protected void rendezvousWithJms(ProcessContext context,
 ProcessSession processSession,
 JMSConsumer consumer)
                          throws ProcessException

Will construct a FlowFile containing the body of the consumed JMS message (if JMSConsumer.JMSResponse returned by JMSConsumer is not null) and JMS properties that came with message which are added to a FlowFile as attributes, transferring FlowFile to 'success' Relationship.

Specified by:

rendezvousWithJms in class AbstractJMSProcessor<JMSConsumer>

Throws:

ProcessException

processSingleMessage

private void processSingleMessage(ProcessSession processSession,
 JMSConsumer consumer,
 String destinationName,
 String errorQueueName,
 boolean durable,
 boolean shared,
 String subscriptionName,
 String messageSelector,
 String charset)

createFlowFileFromMessage

private FlowFile createFlowFileFromMessage(ProcessSession processSession,
 String destinationName,
 JMSConsumer.JMSResponse response)

processMessageSet

private void processMessageSet(ProcessContext context,
 ProcessSession session,
 JMSConsumer consumer,
 String destinationName,
 String errorQueueName,
 boolean durable,
 boolean shared,
 String subscriptionName,
 String messageSelector,
 String charset)

acknowledge

private void acknowledge(JMSConsumer.JMSResponse response)

acknowledge

private void acknowledge(List<JMSConsumer.JMSResponse> processedMessages,
 List<JMSConsumer.JMSResponse> failedMessages)

reject

private void reject(List<JMSConsumer.JMSResponse> processedMessages,
 List<JMSConsumer.JMSResponse> failedMessages)

withLog

private void withLog(Runnable runnable)

findLastBatchedJmsResponse

private JMSConsumer.JMSResponse findLastBatchedJmsResponse(List<JMSConsumer.JMSResponse> processedMessages,
 List<JMSConsumer.JMSResponse> failedMessages)

finishBuildingJmsWorker

protected JMSConsumer finishBuildingJmsWorker(org.springframework.jms.connection.CachingConnectionFactory connectionFactory,
 org.springframework.jms.core.JmsTemplate jmsTemplate,
 ProcessContext processContext)

Will create an instance of JMSConsumer

Specified by:

finishBuildingJmsWorker in class AbstractJMSProcessor<JMSConsumer>

See Also:

• JMSPublisher
• JMSConsumer

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

setClientId

protected void setClientId(ProcessContext context,
 org.springframework.jms.connection.SingleConnectionFactory cachingFactory)

Use provided clientId for non shared durable consumers, if not set always a different value as defined in AbstractJMSProcessor.setClientId(ProcessContext, SingleConnectionFactory).

See Session.createDurableConsumer(javax.jms.Topic, String, String, boolean), in special following part: An unshared durable subscription is identified by a name specified by the client and by the client identifier, which must be set. An application which subsequently wishes to create a consumer on that unshared durable subscription must use the same client identifier.

Overrides:

setClientId in class AbstractJMSProcessor<JMSConsumer>

Parameters:

context - context.

cachingFactory - the connection factory.

updateFlowFileAttributesWithJMSAttributes

private FlowFile updateFlowFileAttributesWithJMSAttributes(Map<String,String> jmsAttributes,
 FlowFile flowFile,
 ProcessSession processSession)

Copies JMS attributes (i.e., headers and properties) as FF attributes. Given that FF attributes mandate that values are of type String, the copied values of JMS attributes will be "stringified" via String.valueOf(attribute).

mergeJmsAttributes

private Map<String,String> mergeJmsAttributes(Map<String,String> headers,
 Map<String,String> properties)