ijokarumawak commented on a change in pull request #3246: NIFI-5929 Support for IBM MQ multi-instance queue managers URL: https://github.com/apache/nifi/pull/3246#discussion_r271131548
########## File path: nifi-nar-bundles/nifi-jms-bundle/nifi-jms-processors/src/main/resources/docs/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/additionalDetails.html ########## @@ -1,56 +1,155 @@ <!DOCTYPE html> <html lang="en"> - <!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - --> - <head> - <meta charset="utf-8" /> - <title>JMSConnectionFactoryProvider</title> - <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> - </head> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<head> + <meta charset="utf-8"/> + <title>JMSConnectionFactoryProvider</title> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"/> +</head> - <body> - <h2>Description:</h2> - <p> - This ControllerService serves as a general factory service to serving vendor specific - instances of the <i>javax.jms.ConnectionFactory</i>. It does so by allowing user to - configure vendor specific properties as well as point to the location of the vendor - provided JMS client libraries so the correct implementation of the <i>javax.jms.ConnectionFactory</i> - can be found, loaded, instantiated and served to the dependent Processors (see PublishJMS, ConsumeJMS). - </p> - <p> - To accommodate variety of JMS vendors and their implementation of the <i>ConnectionFactory</i> - this ControllerService exposes only 3 static configuration properties that are common across many implementations - of the <i>ConnectionFactory</i>. The rest of the configuration properties are set following - <a href="http://docstore.mik.ua/orelly/java-ent/jnut/ch06_02.htm";>Java Beans</a> convention (see below). - </p> - <p> - The 3 static configuration properties are: +<body> +<h2>Description</h2> +<p> + This controller service serves as a general factory service to serving vendor specific + instances of the <i>javax.jms.ConnectionFactory</i>. It does so by allowing user to + configure vendor specific properties as well as point to the location of the vendor + provided JMS client libraries so the correct implementation of the <i>javax.jms.ConnectionFactory</i> + can be found, loaded, instantiated and served to the dependent processors (see PublishJMS, ConsumeJMS). +</p> +<p> + All JMS vendors and <i>ConnectionFactory</i> implementations are supported as long as the configuration values can + be set through <i>set</i> methods (detailed explanation in the last paragraph). However some helpful accommodation + are done for the following JMS vendors: +</p> +<ul> + <li>Apache ActiveMQ</li> + <li>IBM MQ</li> + <li>TIBCO EMS</li> +</ul> +<p> + This controller service exposes only a single mandatory static configuration property that are required across all + implementations. The rest of the configuration properties are either optional or vendor specific. +</p> +<p> + The mandatory configuration property is: +</p> +<ul> + <li><b>MQ ConnectionFactory Implementation</b> - A fully qualified name of the JMS <i>ConnectionFactory</i> + implementation class. For example: <ul> - <li><b>MQ ConnectionFactory Implementation</b> - A fully qualified name of the JMS ConnectionFactory implementation - class (i.e., org.apache.activemq.ActiveMQConnectionFactory)</li> - <li><b>MQ Client Libraries path</b> - Path to the directory with additional resources (i.e., JARs, configuration files etc.) to be added - to the classpath. Such resources typically represent target MQ client libraries for the ConnectionFactory - implementation. It is optional if you are using Apache ActiveMQ since its libraries are distributed with this component.</li> - <li><b>Broker URI</b> - URI pointing to the network location of the JMS Message broker. For example, 'tcp://myhost:61616' for ActiveMQ or simply 'myhost:1414'.</li> + <li>Apache ActiveMQ - <a href="http://activemq.apache.org/maven/5.15.9/apidocs/org/apache/activemq/ActiveMQConnectionFactory.html";>org.apache.activemq.ActiveMQConnectionFactory</a></li> + <li>IBM MQ - <a href="https://www-01.ibm.com/support/knowledgecenter/SSFKSJ_8.0.0/com.ibm.mq.javadoc.doc/WMQJMSClasses/com/ibm/mq/jms/MQQueueConnectionFactory.html";>com.ibm.mq.jms.MQQueueConnectionFactory</a></li> + <li>TIBCO EMS - <a href="https://docs.tibco.com/pub/enterprise_message_service/8.1.0/doc/html/tib_ems_api_reference/api/javadoc/com/tibco/tibjms/TibjmsQueueConnectionFactory.html";>com.tibco.tibjms.TibjmsQueueConnectionFactory</a></li> </ul> - The rest of the properties are set as Dynamic Properties following <a href="http://docstore.mik.ua/orelly/java-ent/jnut/ch06_02.htm";>Java Beans</a> - convention where a property name is derived from the <i>set*</i> method of the vendor specific ConnectionFactory's implementation. - For example, <i>com.ibm.mq.jms.MQConnectionFactory.setChannel(String)</i> would imply 'channel' property and - <i>com.ibm.mq.jms.MQConnectionFactory.setTransportType(int)</i> would imply 'transportType' property. - For the list of available properties please consult vendor provided documentation. Here is an example for - <a href="https://www-01.ibm.com/support/knowledgecenter/SSFKSJ_8.0.0/com.ibm.mq.javadoc.doc/WMQJMSClasses/com/ibm/mq/jms/MQQueueConnectionFactory.html";>IBM's com.ibm.mq.jms.MQConnectionFactory</a> - </p> - </body> + </li> +</ul> +<p> + The following static configuration properties are optional but required in many cases: +</p> +<ul> + <li><b>MQ Client Libraries path</b> - Path to the directory with additional resources (i.e. JARs, + configuration files, etc.) to be added to the classpath. Such resources typically represent target client + libraries for the <i>ConnectionFactory</i> implementation. It is optional if you are using Apache ActiveMQ since + its libraries are included with this component. + </li> + <li><b>Broker URI</b> - URI pointing to the network location of the JMS Message broker. For example: + <ul> + <li>Apache ActiveMQ - <i>tcp://myhost:1234</i> for single broker and + <i>failover:(tcp://myhost01:1234,tcp://myhost02:1234)</i> for multiple brokers. + </li> + <li>IBM MQ - <i>myhost:1234</i> for single broker. <i>myhost01(1234),myhost02(1234)</i> for multiple + brokers. + </li> + <li>TIBCO EMS - <i>tcp://myhost:1234</i> for single broker and + <i>tcp://myhost01:7222,tcp://myhost02:7222</i> for multiple brokers. + </li> Review comment: When I clicked the link for TIBCO EMS, I got following error at browser and content wasn't rendered. Let's set `target="_blank"` to these external links to open them in the new tab.  ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
