diff options
Diffstat (limited to 'java/jca/README.txt')
| -rw-r--r-- | java/jca/README.txt | 127 |
1 files changed, 58 insertions, 69 deletions
diff --git a/java/jca/README.txt b/java/jca/README.txt index 29e6825c4c..a4d426310d 100644 --- a/java/jca/README.txt +++ b/java/jca/README.txt @@ -5,9 +5,10 @@ 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 +The Qpid JCA 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 adapter only supports C++ based brokers and has only been tested with Apache +Qpid C++ broker. The following document explains general configuration information for the Qpid JCA RA. Details for specific application server platforms are provided in separate README files typically designated as @@ -31,30 +32,29 @@ When a ManagedConnectionFactory JavaBean or ActivationSpec JavaBean are deployed the configuration properties from the ResourceAdapter or provide specific properties which in turn will override the defaults. -While some of the properties from the three componets are specific to the JCA adapter, a majority of the -properties directly correspond the the Qpid JMS client. As such, it is strongly encouraged your familiarize -yourself with the correct syntax, configuration options for the JMS client as well as the JCA adapter. Similarly, -familiarity with the 1.5 JCA specification is encouraged though not strictly required. +While some of the properties from the three components are specific to the JCA adapter, a majority of the +properties directly correspond the the Qpid JMS client. As such, familiarity with the Qpid JMS Client is strongly +encouraged. Similarly, familiarity with the JCA 1.5 specification is encouraged though not strictly required. The ResourceAdapter JavaBean ============================ -The ResourceAdapter JavaBean provides global configuration options for both inbound and outbound connectivity. -The set of ResourceAdapter properties are described below. The ResourceAdapter properties can be found in the META-INF/ra.xml -deployment descriptor which is provided with the adapter. Note, deploying a ResourceAdapter, ManagedConnectionFactory -or ActivationSpec is application server specific. As such, this document provides an explanation of these properties -but not how they are configured as this is environment specific. +The ResourceAdapter JavaBean provides global configuration options for both inbound and outbound +connectivity. The set of ResourceAdapter properties are described below. The ResourceAdapter properties +can be found in the META-INF/ra.xml deployment descriptor which is provided with the adapter. Note, +deploying a ResourceAdapter, ManagedConnectionFactory or ActivationSpec is application server specific. +As such, this document provides an explanation of these properties but not how they are configured. ResourceAdapter JavaBean Properties =================================== -ClientID +ClientId The unique client identifier. From the JMS API this is used only in the context of durable subscriptions. Default: client_id SetupAttempts - The number of attempts the ResourceAdapter will make to successfully setup an inbound activation on deployment, or when an exception - occurs at runtime. + The number of attempts the ResourceAdapter will make to successfully setup an inbound activation on deployment, + or when an exception occurs at runtime. Default: 5 SetupInterval @@ -65,14 +65,6 @@ UseLocalTx Whether or not to use local transactions instead of XA. Default: false -DefaultUserName - The default user name to use. -Default: guest - -DefaultPassword - The default password to use. -Default: guest - Host The hostname/ip address of the broker. Default: localhost @@ -87,23 +79,25 @@ Default: test ConnectionURL The full connection URL to the broker. -Default:amqp://guest:guest@/test?brokerlist='tcp://localhost:5672' +Default: amqp://anonymous:passwd@client/test?brokerlist='tcp://localhost?sasl_mechs='PLAIN'' TransactionManagerLocatorClass - The class responsible for locating the transaction manager within a specific application server. This is a ResourceAdapter - Java Bean specific property and is application server specific. As such, it is currently commented out. Two examples have - been provided. + The class responsible for locating the transaction manager within a specific application server. + This is a ResourceAdapter Java Bean specific property and is application server specific, as such, + no default is provided. Default: none TransactionManagerLocatorMethod - The specific method on the class above used to acquire a reference to the platform specific transaction manager. - This is a ResourceAdapter Java Bean specific property and is application server specific. - As such, it is currently commented out. Two examples have been provided. + The specific method on the TransactionManagerLocatorClass used to acquire a reference to the platform + specific transaction manager. This is a ResourceAdapter Java Bean specific property and is application + server specific as such, no default is provided. Default:none -Note, if you require XA support, both the TransactionManagerLocatorClass and the TransactionManagerLocatorMethod -properties MUST be set. While application servers typically provide a mechanism to do this in the form of a specific -deployment descriptor, or GUI console, the ra.xml file can also be modified directly. +UseConnectionPerHandler + The Apache C++ Broker multiplexes on the physical connection rather than the session. As a result, performance + improvements can be gained by allocating and assigning a connection per inbound listener. The alternative is + to share a connection across each handler for a given endpoint (MDB). +Default:true The ManagedConnectionFactory JavaBean ===================================== @@ -112,28 +106,16 @@ The ManagedConnectionFactory JavaBean provides outbound connectivity for the Qpi inherited from the ResourceAdapter JavaBean, the ManagedConnectionFactory JavaBean provides specific properties only applicable to outbound connectivity. -sessionDefaulType +SessionDefaulType The default type of Session. Currently unused. Default: java.jms.Queue -useTryLock +UseTryLock Multi-purpose property used to specify both that a lock on the underlying managed connection should be used, as well as the wait duration to aquire the lock. Primarily used for transaction management. A null or zero value will atttempt to acquire the lock without a duration. Anything greater than zero will wait n number of seconds before failing to acquire the lock. Default:0 -KeyStorePassword - The KeyStore password for SSL -Default:none - -KeyStorePath - The path to the KeyStore. -Default:none - -CertType - The type of certificate. -Default:SunX509 - The ActivationSpec JavaBean =========================== The ActivationSpec JavaBean provides inbound connectivity for the Qpid JCA adapter. In addition to most of the properties @@ -149,7 +131,7 @@ UseJNDI Default: true Destination - The name of the destination on which to listen for messages. + The JNDI name of the destination on which to listen for messages. Default:none DestinationType @@ -187,49 +169,56 @@ PrefetchLow PrefetchHigh Qpid specific -- TODO more explanation - +Setup Administered Objects ====================== The JCA specification provides for administered objects. Ass per the specification, administered objects are -JavaBeans that specific to the messaging provider. The Qpid JCA Resource Adapter provides two administered +JavaBeans that specific to the messaging provider. The Qpid JCA Resource Adapter provides three administered objects that can be used to configure JMS destinations and a specialized JMS Connection Factory respectively. Both these administered objects have properities to support configuration and deployment. -QpidDestinationProxy +QpidQueue/QpidTopic ==================== - The QpidDestinationProxy allows a developer, deployer or adminstrator to create destinations (queues or topic) and - bind these destinations into JNDI. The following lists the properties applicable to the QpidDestinationProxy +The QpidQueue and QpidTopic AdminObjects allow binding JMS destintations into the JEE JNDI namespace. Both +objects support one property: + +DestinationAddress + The address string of the destination. Please see the Qpid JMS client documentation for valid values. -destinationType - The type of destination to create. Valid values are QUEUE or TOPIC. +Example: + DestinationAddress=hello.Queue;{create:always, node:{type:queue, x-declare:{auto-delete:true}}} + DestinationAddress=amq.topic/hello.Topic + The QpidQueue/QpidTopic AdminObjects allow a developer, deployer or adminstrator to create destinations + (queues or topic) and bind these destinations into JNDI. Only one property is required: -destinationAddress - The address string of the destination. Please see the Qpid Java JMS client documentation for valid values. QpidConnectionFactoryProxy +========================== +The QpidConnectionFactoryProxy allows for a non-JCA ConnectionFactory to be bound into the JNDI tree. This +ConnectionFactory can in turn be used outside of the application server. Typically a ConnectionFactory of +this sort is used by Swing or other non-managed clients not requiring JCA. The QpidConnectionFactoryProxy +provides one property + +ConnectionURL + This is the url used to configure the connection factory. Please see the Qpid JMS client documentation for The QpidConnectionFactoryProxy allows for a non-JCA ConnectionFactory to be bound into the JNDI tree. This ConnectionFactory can in turn be used outside of the application server. Typically a ConnectionFactory of - this sort is used by Swing or other two-tier clients not requiring JCA. The QpidConnectionFactoryProxy provides - one property - -connectionURL - This is the url used to configure the connection factory. Please see the Qpid Java Client documentation for - further details. + this sort is used by Java Swing or other non-managed clients not requiring JCA. One one property is + required: +Example: + amqp://anonymous:passwd@client/test?brokerlist='tcp://localhost:5672?sasl_mechs='PLAIN'' Transaction Support =================== The Qpid JCA Resource Adapter provides three levels of transaction support: XA, LocalTransactions and NoTransaction. Typical usage of the Qpid JCA Resource adapter implies the use of XA transactions, though there are certain scenarios where this is not preferred. Transaction support configuration is application server specific and as such, is explained -in the corresponding documentation for each supported application server. However, there are two limitations with -the Qpid JCA adapter at this time: - -1) Currently, the Qpid C++ broker does not support he use of XA within the context of clustered brokers. As such, if -you are running in a cluster, you will need to configure the adapter to use LocalTransactions. +in the corresponding documentation for each supported application server. -2)XARecovery is currently not implemented. In the case of a system failure, in doubt transactions will have to be -manually resolved by and administrator or otherwise qualified personnel. +XA recovery, that is being able to recover 'in-doubt' transactions for a given resource manager is non-standardized, +and as such is application server specific. Currently, the Qpid JCA adapter only supports recovery for JBoss EAP 5.x +as a separate module. Conclusion ========== |