Foreign JMS Providers
Generic Resource Adapter for JMS is a Java EE Connector 1.5 resource adapter that can wrap the JMS client library of external JMS providers such as IBM Websphere MQ, Tibco EMS, and Sonic MQ among others, and thus integrate any JMS provider with a Java EE 1.4 application server such as Sun Java System Application Server. The adapter is a.rar archive that can be deployed and configured using a Java EE 1.4 application server's administration tools.
Configuring the Generic Resource Adapter for JMS
Application server's administration tools can be used to deploy and configure the generic resource adapter for JMS. This section explains how to configure Generic Resource Adapter for JMS with Sun Java System Application Server. Overall, the Resource Adapter can be configured to indicate whether the JMS provider supports XA or not. It is also possible to indicate what mode of integration is possible with the JMS provider. Two modes of integration are supported by the resource adapter. First one uses JNDI as the means of integration. In this case, administered objects are set up in JMS provider's JNDI tree and will be looked up for use by the generic resource adapter. If that mode is not suitable for integration, it is also possible to use Java reflection of JMS administered object javabean classes as the mode of integration. You can use the Sun Java System Application Server's Administration Console or the CLI to configure the resource adapter. This is not different from configuring any other resource adapter.
Configuring the Generic Resource Adapter
Prior to deploying the resource adapter, JMS client libraries should be made available to the application server. For some JMS providers, client libraries may also include native libraries. In such cases, these native libraries should also be made available to the application server JVM(s).
-
Deploy the generic resource adapter the same way you would deploy a connector module.
For steps to do this, refer to the Admin Console Online Help. During deployment, make sure that you specify install-dir/lib/addons/resourceadapters/genericjmsra/genericra.rar as the location of the generic resource adapter. Also, you must specify the properties explained in the section Resource Adapter Properties.
-
Create a connector connection pool.
For steps to do this, refer to the Admin Console Online help. In the New Connector Connection Pool page, from the Resource Adapter combo box, select genericra. Also, in the Connection Definition combo box, select javax.jms.QueueConnectionFactory. Additionally, specify the properties explained in the section ManagedConnectionFactory Properties.
-
Create a connector resource.
For detailed procedure to do this, you can refer the Admin Console Online Help. In the New Connector Resource page, select the pool you created in the previous step.
-
Create an administered object resource.
For detailed procedure to do this, you can refer the Admin Console Online Help. In the New Admin Object Resource page, select genericra as the Resource Adapter and javax.jms.Queue as the Resource Type. Click Next and in the second page, click Add Property. In the Additional Properties table, specify a new property called DestinationProperties with the value Name\\=clientQueue. For information on more properties, see the section Administered Object Resource Properties.
-
Make the following changes to the security policy in Sun Java System Application Server.
-
Modify sjsas_home/domains/domain1/config/server.policy to add java.util.logging.LoggingPermission "control"
-
Modify sjsas_home/lib/appclient/client.policy to add permission javax.security.auth.PrivateCredentialPermission "javax.resource.spi.security.PasswordCredential * \"*\"","read";
-
Resource Adapter Properties
The following table presents the properties to be used while creating the resource adapter.
|
Property Name |
Valid Values |
Default value |
Description |
|---|---|---|---|
|
ProviderIntegrationMode |
javabean/jndi |
javabean |
Decides the mode of integration between the resource adapter and the JMS client. |
|
ConnectionFactoryClassName |
Name of the class available in the application server classpath, for example: com.sun.messaging.ConnectionFactory |
none |
Class name of javax.jms.ConnectionFactory implementation of the JMS client. Used if ProviderIntegrationMode is javabean. |
|
QueueConnectionFactoryClassName |
Name of the class available in the application server classpath, for example: com.sun.messaging.QueueConnectionFactory |
none |
Class name of javax.jms.QueueConnectionFactory implementation of the JMS client. This is used if ProviderIntegrationMode is javabean. |
|
TopicConnectionFactoryClassName |
Name of the class available in the application server classpath , for example: com.sun.messaging.TopicConnectionFactory |
none |
Class name of javax.jms.TopicConnectionFactory implementation of the JMS client. This is used if ProviderIntegrationMode is specified as javabean. |
|
XAConnectionFactoryClassName |
Name of the class available in application server classpath , for example: com.sun.messaging.XAConnectionFactory |
none |
Class name of javax.jms.ConnectionFactory implementation of the JMS client. This is used if ProviderIntegrationMode is specified as javabean. |
|
XAQueueConnectionFactoryClassName |
Name of the class available in application server classpath , for example: com.sun.messaging.XAQueueConnectionFactory |
none |
Class name of javax.jms.XAQueueConnectionFactory implementation of the JMS client. This is used if ProviderIntegrationMode is specified as javabean. |
|
XATopicConnectionFactoryClassName |
Name of the class available in application server classpath , for example: com.sun.messaging.XATopicConnectionFactory |
none |
Class name of javax.jms.XATopicConnectionFactory implementation of the JMS client. This is used if ProviderIntegrationMode is javabean. |
|
TopicClassName |
Name of the class available in application server classpath, for example: com.sun.messaging.Topic |
none |
Class Name of javax.jms.Topic implementation of the JMS client. This is used if ProviderIntegrationMode is javabean. |
|
QueueClassName |
Name of the class available in application server classpath, for example:
com.sun.messaging.Queue |
none |
Class Name of javax.jms.Queue implementation of the JMS client. This is used if ProviderIntegrationMode is specified as a javabean. |
|
SupportsXA |
True/false |
FALSE |
Specifies whether the JMS client supports XA or not. |
|
ConnectionFactoryProperties |
Name value pairs separated by comma. |
none |
This specifies the javabean property names and values of the ConnectionFactory of the JMS client. This is required only if ProviderIntegrationMode is javabean. |
|
JndiProperties |
Name value pairs separated by comma. |
none |
This specifies the JNDI provider properties to be used for connecting to the JMS provider's JNDI. This is used only if ProviderIntegrationMode is jndi. |
|
CommonSetterMethodName |
Method name |
none |
This specifies the common setter method name that some JMS vendors use to set the properties on their administered objects. This property is used only if ProviderIntegrationMode is javabean. In the case of Sun Java System Message Queue, this property is named setProperty. |
|
UserName |
Name of the JMS user |
none |
User name to connect to the JMS Provider. |
|
Password |
Password for the JMS user. |
none |
Password to connect to the JMS provider. |
|
RMPolicy |
ProviderManaged or OnePerPhysicalConnection |
ProviderManaged |
The isSameRM method on an XAResource is used by the Transaction Manager to determine if the Resource Manager instance represented by two XAResources are the same. When RMPolicy is set to ProviderManaged(the default value), the JMS provider is responsible for determining the RMPolicy and the XAResource wrappers in the Generic Resource Adapter merely delegate the isSameRM call to the message queue provider's XA resource implementations. This should ideally work for most message queue products. Some XAResource implementations, such as IBM MQ Series, rely on a resource manager per physical connection. This causes issues when there is inbound and outbound communication to the same queue manager in a single transaction (for example, when an MDB sends a response to a destination). When RMPolicy is set to OnePerPhysicalConnection, the XAResource wrapper implementation's isSameRM in Generic Resource Adapter would check if both the XAResources use the same physical connection, before delegating to the wrapped objects. |
ManagedConnectionFactory Properties
ManagedConnectionFactory properties are specified when a connector-connection-pool is created. All the properties specified while creating the resource adapter can be overridden in a ManagedConnectionFactory. Additional properties available only in ManagedConnectionFactory are given below.
|
Property Name |
Valid Value |
Default Value |
Description |
|---|---|---|---|
|
ClientId |
A valid client ID |
none |
ClientID as specified by JMS 1.1 specification. |
|
ConnectionFactoryJndiName |
JNDI Name |
none |
JNDI name of the connection factory bound in the JNDI tree of the JMS provider. The administrator should provide all connection factory properties (except clientID) in the JMS provider itself. This property name will be used only if ProviderIntegratinMode is jndi. |
|
ConnectionValidationEnabled |
true/false |
FALSE |
If set to true, the resource adapter will use an exception listener to catch any connection exception and will send a CONNECTION_ERROR_OCCURED event to application server. |
Administered Object Resource Properties
Properties in this section are specified when an administered object resource is created. All the resource adapter properties can be overridden in an administered resource object. Additional properties available only in the administered object resource are given below.
|
Property Name |
Valid Value |
Default Value |
Description |
|---|---|---|---|
|
DestinationJndiName |
JNDI Name |
none |
JNDI name of the destination bound in the JNDI tree of the JMS provider. Administrator should provide all properties in the JMS provider itself. This property name will be used only if ProviderIntegrationMode is jndi. |
|
DestinationProperties |
Name value pairs separated by comma |
none |
This specifies the javabean property names and values of the destination of the JMS client. Required only if ProviderIntegrationMode is javabean. |
Activation Spec Properties
Properties in this section are specified in the sun specific deployment descriptor of MDB as activation-config-properties. All the resource adapter properties can be overridden in an Activation Spec. Additional properties available only in ActivationSpec are given below.
|
Property Name |
Valid Value |
Default Value |
Description |
|---|---|---|---|
|
MaxPoolSize |
An integer |
8 |
Maximum size of server session pool internally created by the resource adapter for achieving concurrent message delivery. This should be equal to the maximum pool size of MDB objects. |
|
MaxWaitTime |
An integer |
3 |
The resource adapter will wait for the time in seconds specified by this property to obtain a server session from its internal pool. If this limit is exceeded, message delivery will fail. |
|
SubscriptionDurability |
Durable or Non-Durable |
Non-Durable |
SubscriptionDurability as specified by JMS 1.1 specification. |
|
SubscriptionName |
none |
SubscriptionName as specified by JMS 1.1 specification. |
|
|
MessageSelector |
A valid message selector |
none |
MessageSelector as specified by JMS 1.1 specification. |
|
ClientID |
A valid client ID |
none |
ClientID as specified by JMS 1.1 specification. |
|
ConnectionFactoryJndiName |
A valid JNDI Name |
none |
JNDI name of connection factory created in JMS provider. This connection factory will be used by resource adapter to create a connection to receive messages. Used only if ProviderIntegrationMode is configured as jndi. |
|
DestinationJndiName |
A valid JNDI Name |
none |
JNDI name of destination created in JMS provider. This destination will be used by resource adapter to create a connection to receive messages from. Used only if ProviderIntegrationMode is configured as jndi. |
|
DestinationType |
javax.jms.Queue or javax.jms.Topic |
null |
Type of the destination the MDB will listen to. |
|
DestinationProperties |
Name-value pairs separated by comma |
none |
This specifies the javabean property names and values of the destination of the JMS client. Required only if ProviderIntegrationMode is javabean. |
|
RedeliveryAttempts |
integer |
Number of times a message will be delivered if a message causes a runtime exception in the MDB. |
|
|
RedeliveryInterval |
time in seconds |
Interval between repeated deliveries, if a message causes a runtime exception in the MDB. |
|
|
SendBadMessagesToDMD |
true/false |
false |
Indicates whether the resource adapter should send the messages to a dead message destination, if the number of delivery attempts is exceeded. |
|
DeadMessageDestinationJndiName |
a valid JNDI name. |
none |
JNDI name of the destination created in the JMS provider. This is the target destination for dead messages. This is used only if ProviderIntegrationMode is jndi. |
|
DeadMessageDestinationClassName |
class name of destination object. |
none |
Used if ProviderIntegrationMode is javabean. |
|
DeadMessageDestinationProperties |
Name Value Pairs separated by comma |
none |
This specifies the javabean property names and values of the destination of the JMS client. This is required only if ProviderIntegrationMode is javabean. |
|
ReconnectAttempts |
integer |
Number of times a reconnect will be attempted in case exception listener catches an error on connection. |
|
|
ReconnectInterval |
time in seconds |
interval between reconnects. |
- © 2010, Oracle Corporation and/or its affiliates