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, VerifiableControllerService, IJMSConnectionFactoryProvider, JMSConnectionFactoryProviderDefinition

@Tags(value={"jms","messaging","integration","queue","topic","publish","subscribe"})
 @CapabilityDescription(value="Provides a generic service to create vendor specific javax.jms.ConnectionFactory implementations. The Connection Factory 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.",
                 expressionLanguageScope=VARIABLE_REGISTRY)
 @SeeAlso(classNames={"org.apache.nifi.jms.processors.ConsumeJMS","org.apache.nifi.jms.processors.PublishJMS"})
public class JMSConnectionFactoryProvider
extends AbstractControllerService
implements JMSConnectionFactoryProviderDefinition, VerifiableControllerService

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 JMSConnectionFactoryProperties.JMS_CLIENT_LIBRARIES, allowing it then to create an instance of the target ConnectionFactory based on the provided JMSConnectionFactoryProperties.JMS_CONNECTION_FACTORY_IMPL which can be than access via getConnectionFactory() method.

Field Summary

Fields

Modifier and Type	Field and Description
protected JMSConnectionFactoryHandler	delegate
private static String	ESTABLISH_CONNECTION
private static String	VERIFY_JMS_INTERACTION

Constructor Summary

Constructors

Constructor and Description
JMSConnectionFactoryProvider()

Method Summary

Modifier and Type	Method and Description
private javax.jms.Connection	createConnection(javax.jms.ConnectionFactory connectionFactory, List<ConfigVerificationResult> results, javax.jms.ExceptionListener exceptionListener, ComponentLog logger)
private void	createSession(javax.jms.Connection connection, List<ConfigVerificationResult> results, Exception capturedException, ComponentLog logger)
javax.jms.ConnectionFactory	getConnectionFactory()
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	onDisabled()
void	onEnabled(ConfigurationContext context)
void	resetConnectionFactory(javax.jms.ConnectionFactory cachedFactory)
List<ConfigVerificationResult>	verify(ConfigurationContext context, ComponentLog verificationLogger, Map<String,String> variables)

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, isStateful

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

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

ESTABLISH_CONNECTION

private static final String ESTABLISH_CONNECTION

See Also:

Constant Field Values

VERIFY_JMS_INTERACTION

private static final String VERIFY_JMS_INTERACTION

See Also:

Constant Field Values

delegate

protected volatile JMSConnectionFactoryHandler delegate

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

onEnabled

@OnEnabled
public void onEnabled(ConfigurationContext context)

onDisabled

@OnDisabled
public void onDisabled()

getConnectionFactory

public javax.jms.ConnectionFactory getConnectionFactory()

Specified by:

getConnectionFactory in interface IJMSConnectionFactoryProvider

resetConnectionFactory

public void resetConnectionFactory(javax.jms.ConnectionFactory cachedFactory)

Specified by:

resetConnectionFactory in interface IJMSConnectionFactoryProvider

verify

public List<ConfigVerificationResult> verify(ConfigurationContext context,
                                             ComponentLog verificationLogger,
                                             Map<String,String> variables)

Specified by:

verify in interface VerifiableControllerService

createConnection

private javax.jms.Connection createConnection(javax.jms.ConnectionFactory connectionFactory,
                                              List<ConfigVerificationResult> results,
                                              javax.jms.ExceptionListener exceptionListener,
                                              ComponentLog logger)

createSession

private void createSession(javax.jms.Connection connection,
                           List<ConfigVerificationResult> results,
                           Exception capturedException,
                           ComponentLog logger)