blob: 7d16ae7369f89a0cf49f3f24efaae9d303f13574 [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>JndiJmsConnectionFactoryProvider</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">JndiJmsConnectionFactoryProvider</h1><h2>Description: </h2><p>Provides a service to lookup an existing JMS ConnectionFactory using the Java Naming and Directory Interface (JNDI).</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>jms, jndi, messaging, integration, queue, topic, publish, subscribe</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Display Name</th><th>API Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>JNDI Initial Context Factory Class</strong></td><td>java.naming.factory.initial</td><td></td><td id="allowable-values"></td><td id="description">The fully qualified class name of the JNDI Initial Context Factory Class (java.naming.factory.initial).<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>JNDI Provider URL</strong></td><td>java.naming.provider.url</td><td></td><td id="allowable-values"></td><td id="description">The URL of the JNDI Provider to use (java.naming.provider.url).<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>JNDI Name of the Connection Factory</strong></td><td>connection.factory.name</td><td></td><td id="allowable-values"></td><td id="description">The name of the JNDI Object to lookup for the Connection Factory.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">JNDI / JMS Client Libraries</td><td>naming.factory.libraries</td><td></td><td id="allowable-values"></td><td id="description">Specifies jar files and/or directories to add to the ClassPath in order to load the JNDI / JMS client libraries. This should be a comma-separated list of files, directories, and/or URLs. If a directory is given, any files in that directory will be included, but subdirectories will not be included (i.e., it is not recursive).<br/><br/><strong>This property expects a comma-separated list of resources. Each of the resources may be of any of the following types: directory, file, URL.</strong><br/><br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">JNDI Principal</td><td>java.naming.security.principal</td><td></td><td id="allowable-values"></td><td id="description">The Principal to use when authenticating with JNDI (java.naming.security.principal).<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">JNDI Credentials</td><td>java.naming.security.credentials</td><td></td><td id="allowable-values"></td><td id="description">The Credentials to use when authenticating with JNDI (java.naming.security.credentials).<br/><strong>Sensitive Property: true</strong></td></tr></table><h3>Dynamic Properties: </h3><p>Supports Sensitive Dynamic Properties: <strong>No</strong></p><p>Dynamic Properties allow the user to specify both the name and value of a property.<table id="dynamic-properties"><tr><th>Name</th><th>Value</th><th>Description</th></tr><tr><td id="name">The name of a JNDI Initial Context environment variable.</td><td id="value">The value of the JNDI Initial Context environment variable.</td><td>In order to perform a JNDI Lookup, an Initial Context must be established. When this is done, an Environment can be established for the context. Any dynamic/user-defined property that is added to this Controller Service will be added as an Environment configuration/variable to this Context.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table></p><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.<h3>See Also:</h3><p><a href="../org.apache.nifi.jms.processors.ConsumeJMS/index.html">ConsumeJMS</a>, <a href="../org.apache.nifi.jms.processors.PublishJMS/index.html">PublishJMS</a>, <a href="../org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/index.html">JMSConnectionFactoryProvider</a></p></body></html>