org.apache.nifi.jms.processors

Class AbstractJMSProcessor<T extends JMSWorker>

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

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

Type Parameters:

T - the type of JMSWorker which could be JMSPublisher or JMSConsumer

All Implemented Interfaces:

ConfigurableComponent, Processor

Direct Known Subclasses:

ConsumeJMS, PublishJMS

public abstract class AbstractJMSProcessor<T extends JMSWorker>
extends AbstractProcessor

Base JMS processor to support implementation of JMS producers and consumers.

See Also:

PublishJMS, ConsumeJMS, JMSConnectionFactoryProviderDefinition

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	AbstractJMSProcessor.ConnectionFactoryConfigValidator

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static String	BYTES_MESSAGE
(package private) static PropertyDescriptor	CF_SERVICE
(package private) static PropertyDescriptor	CHARSET
(package private) static PropertyDescriptor	CLIENT_ID
private AtomicInteger	clientIdCounter
private IJMSConnectionFactoryProvider	connectionFactoryProvider
(package private) static PropertyDescriptor	DESTINATION
(package private) static PropertyDescriptor	DESTINATION_TYPE
(package private) static List<PropertyDescriptor>	JMS_CF_PROPERTIES
(package private) static List<PropertyDescriptor>	JNDI_JMS_CF_PROPERTIES
(package private) static PropertyDescriptor	PASSWORD
(package private) static String	QUEUE
(package private) static PropertyDescriptor	SESSION_CACHE_SIZE
(package private) static String	TEXT_MESSAGE
(package private) static String	TOPIC
(package private) static PropertyDescriptor	USER
private BlockingQueue<T>	workerPool

Constructor Summary

Constructors

Constructor and Description
AbstractJMSProcessor()

Method Summary

Modifier and Type	Method and Description
private T	buildTargetResource(ProcessContext context) This method essentially performs initialization of this Processor by obtaining an instance of the ConnectionFactory from the JMSConnectionFactoryProvider (ControllerService) and performing a series of ConnectionFactory adaptations which eventually results in an instance of the CachingConnectionFactory used to construct JmsTemplate used by this Processor.
void	close()
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
protected abstract T	finishBuildingJmsWorker(org.springframework.jms.connection.CachingConnectionFactory connectionFactory, org.springframework.jms.core.JmsTemplate jmsTemplate, ProcessContext processContext) Finishes building one of the JMSWorker subclasses T.
protected static String	getClientId(ProcessContext context)
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
void	onTrigger(ProcessContext context, ProcessSession session)
protected abstract void	rendezvousWithJms(ProcessContext context, ProcessSession session, T jmsWorker) Delegate method to supplement onTrigger(ProcessContext, ProcessSession) operation.
protected void	setClientId(ProcessContext context, org.springframework.jms.connection.SingleConnectionFactory connectionFactory) Set clientId for JMS connections when clientId is not null.
void	setupConnectionFactoryProvider(ProcessContext context)
void	setupWorkerPool(ProcessContext context)
void	shutdownConnectionFactoryProvider(ProcessContext context)

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

onTrigger

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

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

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

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

QUEUE

static final String QUEUE

See Also:

Constant Field Values

TOPIC

static final String TOPIC

See Also:

Constant Field Values

TEXT_MESSAGE

static final String TEXT_MESSAGE

See Also:

Constant Field Values

BYTES_MESSAGE

static final String BYTES_MESSAGE

See Also:

Constant Field Values

USER

static final PropertyDescriptor USER

PASSWORD

static final PropertyDescriptor PASSWORD

DESTINATION

static final PropertyDescriptor DESTINATION

DESTINATION_TYPE

static final PropertyDescriptor DESTINATION_TYPE

CLIENT_ID

static final PropertyDescriptor CLIENT_ID

SESSION_CACHE_SIZE

static final PropertyDescriptor SESSION_CACHE_SIZE

CHARSET

static final PropertyDescriptor CHARSET

CF_SERVICE

static final PropertyDescriptor CF_SERVICE

JNDI_JMS_CF_PROPERTIES

static final List<PropertyDescriptor> JNDI_JMS_CF_PROPERTIES

JMS_CF_PROPERTIES

static final List<PropertyDescriptor> JMS_CF_PROPERTIES

connectionFactoryProvider

private volatile IJMSConnectionFactoryProvider connectionFactoryProvider

workerPool

private volatile BlockingQueue<T extends JMSWorker> workerPool

clientIdCounter

private final AtomicInteger clientIdCounter

Constructor Detail

AbstractJMSProcessor

public AbstractJMSProcessor()

Method Detail

getClientId

protected static String getClientId(ProcessContext context)

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)
               throws ProcessException

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

setupConnectionFactoryProvider

@OnScheduled
public void setupConnectionFactoryProvider(ProcessContext context)

shutdownConnectionFactoryProvider

@OnUnscheduled
public void shutdownConnectionFactoryProvider(ProcessContext context)

setupWorkerPool

@OnScheduled
public void setupWorkerPool(ProcessContext context)

close

@OnStopped
public void close()

rendezvousWithJms

protected abstract void rendezvousWithJms(ProcessContext context,
                                          ProcessSession session,
                                          T jmsWorker)
                                   throws ProcessException

Delegate method to supplement onTrigger(ProcessContext, ProcessSession) operation. It is implemented by sub-classes to perform Processor specific functionality.

Throws:

ProcessException

finishBuildingJmsWorker

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

Finishes building one of the JMSWorker subclasses T.

See Also:

JMSPublisher, JMSConsumer

buildTargetResource

private T buildTargetResource(ProcessContext context)

This method essentially performs initialization of this Processor by obtaining an instance of the ConnectionFactory from the JMSConnectionFactoryProvider (ControllerService) and performing a series of ConnectionFactory adaptations which eventually results in an instance of the CachingConnectionFactory used to construct JmsTemplate used by this Processor.

setClientId

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

Set clientId for JMS connections when clientId is not null. It is overridden by ConsumeJMS when durable subscriptions is configured on the processor.

Parameters:

context - context.

connectionFactory - the connection factory.

Since:

NIFI-6915