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(value={"jms","get","message","receive","consume"})
 @InputRequirement(value=INPUT_FORBIDDEN)
 @CapabilityDescription(value="Consumes JMS Message of type BytesMessage or TextMessage 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.")
 @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="other attributes",description="Each message property is written to an attribute.")
 @SeeAlso(value={PublishJMS.class,JMSConnectionFactoryProvider.class})
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.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static PropertyDescriptor	ACKNOWLEDGEMENT_MODE
(package private) static AllowableValue	AUTO_ACK
(package private) static AllowableValue	CLIENT_ACK
(package private) static AllowableValue	DUPS_OK
(package private) static PropertyDescriptor	DURABLE_SUBSCRIBER
static String	JMS_SOURCE_DESTINATION_NAME
static Relationship	REL_SUCCESS
private static Set<Relationship>	relationships
(package private) static PropertyDescriptor	SHARED_SUBSCRIBER
(package private) static PropertyDescriptor	SUBSCRIPTION_NAME
private static List<PropertyDescriptor>	thisPropertyDescriptors
(package private) static PropertyDescriptor	TIMEOUT

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

BYTES_MESSAGE, CF_SERVICE, CHARSET, CLIENT_ID, DESTINATION, DESTINATION_TYPE, MESSAGE_BODY, PASSWORD, propertyDescriptors, QUEUE, SESSION_CACHE_SIZE, TEXT_MESSAGE, TOPIC, USER

Constructor Summary

Constructors

Constructor and Description
ConsumeJMS()

Method Summary

Modifier and Type	Method and Description
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()
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.
private FlowFile	updateFlowFileAttributesWithJMSAttributes(Map<String,String> jmsAttributes, FlowFile flowFile, ProcessSession processSession) Copies JMS attributes (i.e., headers and properties) as FF attributes.

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

close, onTrigger, setupWorkerPool

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

customValidate, equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, 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

Field Detail

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

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

REL_SUCCESS

public static final Relationship REL_SUCCESS

relationships

private static final Set<Relationship> relationships

thisPropertyDescriptors

private static final List<PropertyDescriptor> thisPropertyDescriptors

Constructor Detail

ConsumeJMS

public ConsumeJMS()

Method Detail

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

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 AbstractJMSProcessor<JMSConsumer>

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