org.apache.nifi.jms.cf

Class JMSConnectionFactoryProvider

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.jms.cf.JMSConnectionFactoryProvider

All Implemented Interfaces:

ConfigurableComponent, ControllerService, JMSConnectionFactoryProviderDefinition

@Tags(value={"jms","messaging","integration","queue","topic","publish","subscribe"})
 @CapabilityDescription(value="Provides a generic service to create vendor specific javax.jms.ConnectionFactory implementations. ConnectionFactory can be served once this service is configured successfully")
 @DynamicProperty(name="The name of a Connection Factory configuration property.",
                 value="The value of a given Connection Factory configuration property.",
                 description="The properties that are set following Java Beans convention where a property name is derived from the \'set*\' method of the vendor specific ConnectionFactory\'s implementation. For example, \'com.ibm.mq.jms.MQConnectionFactory.setChannel(String)\' would imply \'channel\' property and \'com.ibm.mq.jms.MQConnectionFactory.setTransportType(int)\' would imply \'transportType\' property.")
 @SeeAlso(classNames={"org.apache.nifi.jms.processors.ConsumeJMS","org.apache.nifi.jms.processors.PublishJMS"})
public class JMSConnectionFactoryProvider
extends AbstractControllerService
implements JMSConnectionFactoryProviderDefinition

Provides a factory service that creates and initializes ConnectionFactory specific to the third party JMS system.

It accomplishes it by adjusting current classpath by adding to it the additional resources (i.e., JMS client libraries) provided by the user via JMSConnectionFactoryProviderDefinition#CLIENT_LIB_DIR_PATH, allowing it then to create an instance of the target ConnectionFactory based on the provided JMSConnectionFactoryProviderDefinition#CONNECTION_FACTORY_IMPL which can be than access via getConnectionFactory() method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	JMSConnectionFactoryProvider.NonEmptyBrokerURIValidator Validator that ensures that brokerURI's length > 0 after EL evaluation

Field Summary

Fields

Modifier and Type	Field and Description
private static String	BROKER
static PropertyDescriptor	BROKER_URI
private static String	CF_IMPL
private static String	CF_LIB
static PropertyDescriptor	CLIENT_LIB_DIR_PATH
private boolean	configured
static PropertyDescriptor	CONNECTION_FACTORY_IMPL
private javax.jms.ConnectionFactory	connectionFactory
private org.slf4j.Logger	logger
private static List<PropertyDescriptor>	PROPERTY_DESCRIPTORS
static PropertyDescriptor	SSL_CONTEXT_SERVICE

Constructor Summary

Constructors

Constructor and Description
JMSConnectionFactoryProvider()

Method Summary

Modifier and Type	Method and Description
private void	createConnectionFactoryInstance(ConfigurationContext context) Creates an instance of the ConnectionFactory from the provided 'CONNECTION_FACTORY_IMPL'.
void	disable()
void	enable(ConfigurationContext context)
javax.jms.ConnectionFactory	getConnectionFactory()
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	resetConnectionFactory(javax.jms.ConnectionFactory cachedFactory)
private void	setConnectionFactoryProperties(ConfigurationContext context) This operation follows standard bean convention by matching property name to its corresponding 'setter' method.
private void	setProperty(String propertyName, Object propertyValue) Sets corresponding ConnectionFactory's property to a 'propertyValue' by invoking a 'setter' method that corresponds to 'propertyName'.
private String	toMethodName(String propertyName) Will convert propertyName to a method name following bean convention.

Methods inherited from class org.apache.nifi.controller.AbstractControllerService

abstractClearConfigContext, abstractStoreConfigContext, disabled, enabled, getConfigurationContext, getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, getProperty, getStateManager, init, initialize, isEnabled

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

customValidate, equals, getPropertyDescriptor, getPropertyDescriptors, hashCode, onPropertyModified, toString, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.nifi.controller.ControllerService

initialize

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

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

logger

private final org.slf4j.Logger logger

PROPERTY_DESCRIPTORS

private static final List<PropertyDescriptor> PROPERTY_DESCRIPTORS

configured

private volatile boolean configured

connectionFactory

private volatile javax.jms.ConnectionFactory connectionFactory

BROKER

private static final String BROKER

See Also:

Constant Field Values

CF_IMPL

private static final String CF_IMPL

See Also:

Constant Field Values

CF_LIB

private static final String CF_LIB

See Also:

Constant Field Values

CONNECTION_FACTORY_IMPL

public static final PropertyDescriptor CONNECTION_FACTORY_IMPL

CLIENT_LIB_DIR_PATH

public static final PropertyDescriptor CLIENT_LIB_DIR_PATH

BROKER_URI

public static final PropertyDescriptor BROKER_URI

SSL_CONTEXT_SERVICE

public static final PropertyDescriptor SSL_CONTEXT_SERVICE

Constructor Detail

JMSConnectionFactoryProvider

public JMSConnectionFactoryProvider()

Method Detail

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

resetConnectionFactory

public void resetConnectionFactory(javax.jms.ConnectionFactory cachedFactory)

Specified by:

resetConnectionFactory in interface JMSConnectionFactoryProviderDefinition

getConnectionFactory

public javax.jms.ConnectionFactory getConnectionFactory()

Specified by:

getConnectionFactory in interface JMSConnectionFactoryProviderDefinition

Returns:

new instance of ConnectionFactory

enable

@OnEnabled
public void enable(ConfigurationContext context)
                       throws InitializationException

Throws:

InitializationException

disable

@OnDisabled
public void disable()

setConnectionFactoryProperties

private void setConnectionFactoryProperties(ConfigurationContext context)

This operation follows standard bean convention by matching property name to its corresponding 'setter' method. Once the method was located it is invoked to set the corresponding property to a value provided by during service configuration. For example, 'channel' property will correspond to 'setChannel(..) method and 'queueManager' property will correspond to setQueueManager(..) method with a single argument.

There are also few adjustments to accommodate well known brokers. For example ActiveMQ ConnectionFactory accepts address of the Message Broker in a form of URL while IBMs in the form of host/port pair (more common). So this method will use value retrieved from the 'BROKER_URI' static property 'as is' if ConnectionFactory implementation is coming from ActiveMQ and for all others (for now) the 'BROKER_URI' value will be split on ':' and the resulting pair will be used to execute setHostName(..) and setPort(..) methods on the provided ConnectionFactory. This may need to be maintained and adjusted to accommodate other implementation of ConnectionFactory, but only for URL/Host/Port issue. All other properties are set as dynamic properties where user essentially provides both property name and value, The bean convention is also explained in user manual for this component with links pointing to documentation of various ConnectionFactories.

See Also:

method

setProperty

private void setProperty(String propertyName,
                         Object propertyValue)

Sets corresponding ConnectionFactory's property to a 'propertyValue' by invoking a 'setter' method that corresponds to 'propertyName'. For example, 'channel' property will correspond to 'setChannel(..) method and 'queueManager' property will correspond to setQueueManager(..) method with a single argument.

NOTE: There is a limited type conversion to accommodate property value types since all NiFi configuration properties comes as String. It is accomplished by checking the argument type of the method and executing its corresponding conversion to target primitive (e.g., value 'true' will go thru Boolean.parseBoolean(propertyValue) if method argument is of type boolean). None-primitive values are not supported at the moment and will result in IllegalArgumentException. It is OK though since based on analysis of several ConnectionFactory implementation the all seem to follow bean convention and all their properties using Java primitives as arguments.

createConnectionFactoryInstance

private void createConnectionFactoryInstance(ConfigurationContext context)

Creates an instance of the ConnectionFactory from the provided 'CONNECTION_FACTORY_IMPL'.

toMethodName

private String toMethodName(String propertyName)

Will convert propertyName to a method name following bean convention. For example, 'channel' property will correspond to 'setChannel method and 'queueManager' property will correspond to setQueueManager method name