Attachment 710590 Details for Bug 912309 – README-JBOSS.txt

README-JBOSS.txt

README-JBOSS.txt (text/plain), 6.77 KB, created by Weston M. Price on 2013-03-15 11:06:13 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Weston M. Price

Created: 2013-03-15 11:06:13 UTC

Size: 6.77 KB

patch

obsolete

>Qpid JCA Resource Adapter
>
>JBoss EAP 5.x Installation and Configuration Instructions
>
>Overview
>========
>The Qpid Resource Adapter is a JCA 1.5 compliant resource adapter that allows
>for JEE integration between EE applications and AMQP 0.10  message brokers.
>
>The adapter provides both outbound and inbound connectivity and
>exposes a variety of options to fine tune your messaging applications.
>Currently the adapter only supports C++ based brokers and has only been tested with Apache Qpid C++ broker.
>
>The following document explains how to configure the resource adapter for deployment in JBoss EAP 5.x.
>
>Deployment
>==========
>To deploy the Qpid JCA adapter for either JBoss EAP, simply copy the qpid-ra-<version>.rar file
>to your JBoss deploy directory. By default this can be found at JBOSS_ROOT/server/<server-name>/deploy,
>where JBOSS_ROOT denotes the root directory of your JBoss installation and <server-name> denotes the
>name of your deployment server. A successful adapter installation will be accompanied by the
>following INFO message:
>
>    INFO  [QpidResourceAdapter] Qpid resource adaptor started
>
>At this point the adapter is deployed and ready for configuration.
>
>Configuration Overview
>======================
>The standard configuration mechanism for JCA adapters in the EAP 5.x
>environment is the *-ds.xml file. While the Qpid JCA adapter provides
>an ra.xml file in accordance with the JCA specification, this file
>is typically never modified directly. A default set of values is
>provided in the ra.xml file, these will almost always be overriden
>via the *-ds.xml file configuration file.
>
>A sample *-ds.xml file, qpid-jca-ds.xml, can be found in your Qpid JCA
>resource adapter directory.
>
>The general README.txt file provides a detailed description of all the properties associated
>with the Qpid JCA Resource adapter. Please consult this file for further explanation of
>how configuration properties are treated within the Qpid JCA adapter. The following
>sections explain particular configuration options for the *-ds.xml file in the EAP
>environment.
>
>ConnectionFactory Configuration
>======================================
>As per the JCA specification, the standard outbound-connectivity component is the
>ConnectionFactory. In EAP 5.x ConnectionFactories are configured
>via the *-ds.xml file. As previously mentioned, a sample *-ds.xml file, qpid-jca-ds.xml
>has been provided with your distribution. This file can be easily modified to suit
>your development and deployment needs. The following describes the ConnectionFactory
>portion of the sample file.
>
>XA ConnectionFactory
>====================
>  <tx-connection-factory>
>    <jndi-name>QpidJMSXA</jndi-name>
>    <xa-transaction/>
>    <rar-name>qpid-ra-<ra-version>.rar</rar-name>
>    <connection-definition>org.apache.qpid.ra.QpidRAConnectionFactory</connection-definition>
>    <config-property name="ConnectionURL">amqp://guest:guest@/test?brokerlist='tcp://localhost:5672?sasl_mechs='PLAIN''</config-property>
>    <max-pool-size>20</max-pool-size>
>  </tx-connection-factory>
>
>The QpidJMSXA connection factory defines an XA capable ManagedConnectionFactory.
>You will need to insert your particular rar version for the rar-name property.
>The jndi-name and ConnectionURL property are both configurable and can be modified
>for your environment. After deployment the ConnectionFactory will be bound into JNDI under the name
>
>java:<jndi-name>
>
>For the previous example, this would resolve to
>
>java:QpidJMSXA
>
>Admininstered Object Configuration
>==================================
>Destinations (queues, topics) are configured in EAP via JCA standard Administered Objects (AdminObjects). These objects
>are placed within the *-ds.xml file alongside your ConnectionFactory configurations. The sample file qpid-jca-ds.xml
>provides two such objects
>
>  <mbean code="org.jboss.resource.deployment.AdminObject"
>         name="qpid.jca:name=HelloQueue">
>     <attribute name="JNDIName">Hello</attribute>
>     <depends optional-attribute-name="RARName">jboss.jca:service=RARDeployment,name='qpid-ra-<ra-version>.rar'</depends>
>     <attribute name="Type">org.apache.qpid.ra.admin.QpidQueue</attribute>
>     <attribute name="Properties">
>        DestinationAddress=amq.direct
>     </attribute>
>  </mbean>
>
>The above XML defines a JMS Queue which is bound into JNDI as
>
>HelloQueue
>
>This destination can be retrieved from JNDI and be used for the consumption or production of messages. The desinationAddress property
>can be customized for your environment. Please see the Qpid Java Client documentation for specific configuration options.
>
>  <mbean code="org.jboss.resource.deployment.AdminObject"
>         name="qpid.jca:name=HelloTopic">
>     <attribute name="JNDIName">HelloTopic</attribute>
>     <depends optional-attribute-name="RARName">jboss.jca:service=RARDeployment,name='qpid-ra-<ra-version>.rar'</depends>
>     <attribute name="Type">org.apache.qpid.ra.admin.QpidTopic</attribute>
>     <attribute name="Properties">
>        DestinationAddress=amq.topic
>     </attribute>
>  </mbean>
>
>The above XML defines a JMS Topic which is bound into JNDI as
>
>HelloTopic
>
>This destination can be retrieved from JNDI and be used for the consumption or production of messages. The DesinationAddress property
>can be customized for your environment. Please see the Qpid Java Client documentation for specific configuration options.
>
>
>  <mbean code="org.jboss.resource.deployment.AdminObject"
>         name="qpid.jca:name=QpidConnectionFactory">
>     <attribute name="JNDIName">QpidConnectionFactory</attribute>
>     <depends optional-attribute-name="RARName">jboss.jca:service=RARDeployment,name='qpid-ra-<ra-version>.rar'</depends>
>     <attribute name="Type">org.apache.qpid.ra.admin.QpidRAConnectionFactory</attribute>
>     <attribute name="Properties">
>        ConnectionURL=amqp://anonymous:@client/test?brokerlist='tcp://localhost:5672?sasl_mechs='PLAIN''
>     </attribute>
>  </mbean>
>
>The above XML defines a ConnectionFactory that can be used external to EAP 5.x. Typically this connection factory
>is used by standalone or 'thin' clients that do not require an application server. This object is bound into
>the EAP 5.x JNDI tree as
>
>QpidConnectionFactory
>
>ActivationSpec Configuration
>============================
>The standard method for inbound communication is the MessageDrivenBean architecture with is configured
>via the ActivationSpec mechanism. Please see the general README.tx file for an explanation of the
>QpidActivationSpec, as well as general inbound connectivity options.
>
>An ActivationSpec can either be configured via the Java Annotation mechanism, or in the ejb-jar.xml deployment
>descriptor.
>
>Summary
>=======
>The above description for the Qpid JCA adapter for EAP 5.x is just a general guide for deploying and configuring
>the Qpid JCA adapter. The sample file provided can be easily modified and it is expected you will do so to
>conform to your own environment.
>

Actions: View

Attachments on bug 912309: 710590