Adapter for JMS 6.1 SP1 | webMethods Adapter for JMS Documentation | webMethods Adapter for JMS Installation and User’s Documentation | Adapter Connections | Configuring Adapter for JMS Connections
 
Configuring Adapter for JMS Connections
When you configure Adapter for JMS connections, you specify information that Integration Server uses to connect to a JMS provider. You configure Adapter for JMS connections using Integration Server Administrator.
*To configure a connection
1. In the Adapters menu in the Integration Server Administrator navigation area, click Adapter for JMS.
2. On the Connections screen, click Configure New Connection.
3. On the Connection Types screen, click the connection type with which you want the adapter to connect to the JMS provider.
*Select Adapter for JMS QueueConnection as the connection type to connect to a queue.
*Select Adapter for JMS TopicConnection as the connection type to connect to a topic.
4. In the Adapter for JMS Connection section, provide values for the following fields.
Parameter
Description/Action
Package
The package in which to configure the connection.You must create the package using Designer before you can specify it for this parameter. For general information about creating packages, see the webMethods Service Development Help for your release.
Note:
Configure the connection in a user-defined package rather than in the adapter's package. See Package Management for other important considerations when creating packages for use with the Adapter for JMS.
Folder Name
The folder in which to configure the connection.
Connection Name
The name you want to give the connection. Connection names cannot have spaces or use special characters reserved by Integration Server or Designer. For more information about the use of special characters in package, folder, and element names, see the webMethods Service Development Help for your release.
5. In the Connection Properties section, provide values for the following fields:
Parameter
Description
Transaction Type
The type of transaction support that the connection provides. Select one of the following transaction types:
*XA_TRANSACTION: The connection uses XA transactions.
*NO_TRANSACTION: When receiving messages, the connection automatically acknowledges the received message. (Sessions are created with the CLIENT_ACKNOWLEDGE acknowledge mode.) When sending messages, the message is automatically delivered.
*LOCAL_TRANSACTION: The connection does not automatically commit transactions. You can manually define the transactions, or the Integration Server transaction manager will manage it for you. For instructions on managing transactions manually, see Built-In Transaction Management Services.
JNDI Initial Context Factory
The fully qualified class name for the Initial Context Factory used by your JNDI provider. For example: weblogic.jndi.WLInitialContextFactory.
JNDI Provider URL
The URL to the starting context within the JNDI directory service. For example: t3://MyHost.MyCompany.com:7001.
JNDI Security Principal
(Optional) Your JNDI login name or security principal, for JNDI lookup purposes.
JNDI Security Credentials
(Optional) Your JNDI login password or security credentials, for JNDI lookup purposes.
JNDI Other Properties
(Optional) Enables you to provide additional JNDI properties. The properties you specify in this field will differ depending on the specific JNDI Naming Context you are using. Specify properties in the following format, separating multiple properties using a semicolon (;): propertyName1=value1; propertyName2=value2.For JBoss connections, to define the security protocol at the server side to the default authentication module, specify the java.naming.security.protocol property with a value of “other”, as follows:
java.naming.security.protocol=other
Alternatively, if you need to assign the security protocol to use a custom module defined in the client-login conf/login-config.xml entry in the JBoss server, specify the name of the custom module as the value of the java.naming.security.protocol property:
java.naming.security.protocol=CustomModule
Topic/Queue ConnectionFactory JNDI Name
The full path name identifying the JMS Queue or Topic ConnectionFactory bound with the JNDI service. For Topic connections provide Topic ConnectionFactory Name and for Queue connections provide Queue ConnectionFactory Name.
JMS User
(Optional) Your JMS login name to connect to the JMS provider.
JMS Password
(Optional) Your JMS login password for connection purposes.
Connection Client ID
(Adapter for JMS TopicConnection only) A unique client identifier for this connection. The purpose of the client identifier is to associate a connection and its objects with a state maintained on behalf of the client by the provider. The only such state identified by the JMS API is that required to support durable subscriptions.
Note:
You can only use this property if there is no default Client ID stored with the topic connection factory.
Note:
If you need to use a Client ID for the notifications, it is better to specify it along with the other notification parameters using Designer, and not while creating the connection factory or the Adapter for JMS connections. When the Client ID is specified in the connection factory or JMS connections, only one connection can be created through this connection factory or connection. This limits the Adapter for JMS from leveraging the connection pool.
6. In the Connection Management Properties section, provide values for the following fields:
Parameter
Description
Enable Connection Pooling
Enables the adapter to use connection pooling. Default: true. See Adapter Connections for more information about connection pooling.
Note:
If you plan to enable connection pooling in a clustered environment, consider the connection pool size. For details, see Considerations When Configuring Connections with Connection Pooling Enabled.
Minimum Pool Size
If connection pooling is enabled, this field specifies the minimum number of connection objects that remain in the connection pool at all times. When the adapter creates the pool, it create this number of connections. Default: 1.
Maximum Pool Size
The maximum number of connection objects that can exist in the connection pool. The adapter will reuse any inactive connections in the pool or, if all connections are active and the connection pool has reached its maximum size, the adapter will wait for a connection to become available. Default: 10.
Pool Increment Size
If connection pooling is enabled, this field specifies the number of connections by which the pool will be incremented if connections are needed, up to the maximum pool size. Default: 1.
Block Timeout
If connection pooling is enabled, this field specifies the number of milliseconds that Integration Server will wait to obtain a connection before it times out and returns an error. Default: 1000.
Expire Timeout
If connection pooling is enabled, this field specifies the number of milliseconds that an inactive connection can remain in the pool before it is closed and removed from the pool. For example, to specify 10 seconds, specify 10000. Enter 0 to specify no timeout. Default: 1000.
Note:
Note that the adapter will never violate the Minimum Pool Size parameter. These connections remain in the pool regardless of how long they are inactive.
Startup Retry Count
The number of times that the system should attempt to initialize the connection pool at startup if the initial attempt fails. Default: 0.
Startup Backoff Timeout
The number of seconds that the system should wait between attempts to initialize the connection pool.
7. Click Save Connection.
The connection you configured appears on the adapter's Connections screen and in Designer’s Package Navigator.
By default, when you configure a connection, it is not enabled. For information about enabling connections, see Enabling Adapter Connections.