JMS queue connection factory [Settings]

A JMS queue connection factory is used to create connections to the associated JMS provider of JMS queues, for point-to-point messaging. Use queue connection factory administrative objects to manage JMS queue connection factories for the default messaging provider.

To view this pane in the console, click the following path:

Resources > JMS > JMS providers > [Content Pane] default_messaging provider > [Additional Properties] Queue connection factories > factory_name .

Use this panel to browse or change the configuration properties of the selected JMS queue connection factory for use with the default messaging JMS provider. These configuration properties control how connections are created to associated JMS queues.

By default, connections created using this JMS connection factory in the server containers (for example, from an enterprise bean) are pooled using J2C connection pooling. You can modify the connection pool settings for this connection factory by selecting the Connection pool properties properties link in the Additional properties section of the administrative console panel.

The configuration of a container-managed authentication alias and mapping module on a connection factory are deprecated in release 6.0. You now set these properties in the bindings for the resource reference of the application. If you do not want to modify the bindings for an existing application, locate this connection factory in the J2C panels where you can still find these properties.

Configuration tab

Configuration properties for this object. These property values are preserved even if the runtime environment is stopped then restarted. See the information center task descriptions for information about how to apply configuration changes to the runtime environment.

General properties

Administration

Scope

Specifies the highest topological level at which application servers can use this resource object.

Required No
Data type Text
Provider

Specifies a JMS provider, which enables asynchronous messaging based on the Java Message Service (JMS). It provides J2EE connection factories to create connections for specific JMS queue or topic destinations. JMS provider administrative objects are used to manage JMS resources for the associated JMS provider.

Required No
Data type Text
Name

The required display name for the resource.

Required Yes
Data type Text
JNDI name

The JNDI name for the resource.

As a convention, use a JNDI name of the form jms/Name, where Name is the logical name of the resource. For more information about the use of JNDI and its syntax, see JNDI support in WebSphere® Application Server.

Required Yes
Data type Text
Description

An optional description for the resource.

Required No
Data type Text area
Category

An optional category string to use when classifying or grouping the resource.

Required No
Data type Text

Connection

Bus name

The name of the service integration bus to connect to.

This is the name of the service integration bus that this connection factory is used to create connections to.
Fill in the name of the local bus in situations where an application makes connection to foreign buses.
Required Yes
Data type Custom
Target

The name of a target that identifies a group of messaging engines. Specify the type of target using the Target type property.

This indicates the name of a target that is to be used to determine one or more messaging engines to handle work. The type of target is indicated by the Target type property

Connections are load balanced across the available messaging engines that satisfy the selection criteria.

If you want applications to be able to connect to any messaging engine in the bus, do not set this property.

For more information about using this property with other connection factory properties for workload management of connections, see Administrative properties for JMS connections to a bus.

Required No
Data type Text
Target type

The type of target named in the Target property.

Required No
Data type drop-down list
Range
Bus member name
The name of a bus member. This option retrieves the active messaging engines that are hosted by the named bus member (an application server or server cluster). To specify a non-clustered bus member the Target property must be set to <Node01>.<server1>, for example Node01.server1. For a cluster bus member the Target property must be set to the cluster name.

Custom messaging engine group name
The name of a custom group of messaging engines (that form a self-declaring cluster). This option retrieves the active messaging engines that have registered with the named custom group.

Messaging engine name
The name of a messaging engine. This option retrieves the available endpoints that can be used to reach the named messaging engine.

Target significance

This property specifies the significance of the target group.

For more information about using this property with other connection factory properties for workload management of connections, see Administrative properties for JMS connections to a bus.

Required No
Data type drop-down list
Range
Preferred
It is preferred that a messaging engine be selected from the target group. A messaging engine in the target group is selected if one is available. If a messaging engine is not available in the target group, a messaging engine outside the target group is selected if available in the same service integration bus.

Required
It is required that a messaging engine be selected from the target group. A messaging engine in the target group is selected if one is available. If a messaging engine is not available in the target group, the connection process fails.

Target inbound transport chain

The name of the inbound transport chain that the application should target when connecting to a messaging engine in a separate process to the application. If a messaging engine in another process is chosen, a connection can be made only if the messaging engine is in a server that runs the specified inbound transport chain. Refer to the InfoCenter for more information.

Type the name of the transport chain that the application should use when connecting to a messaging engine in separate process to the application. If a messaging engine in another process is chosen, a connection can be made only if the messaging engine is in a server that runs the specified transport chain.

If the selected messaging engine is in the same server as the application, a direct in-process connection is made and this transport chain property is ignored.

The transport chains represent network protocol stacks operating within a server. The name you specify must be one of the transport chains available in the server that hosts the messaging engine, as listed on the Servers > Application servers > [Content Pane] server_name > Messaging engine inbound transports panel. The following transport chains are provided, but you can define your own transport chains on that panel.

InboundBasicMessaging
This is a connection-oriented protocol, using a standard TCP/IP connection (JFAP-TCP/IP). It includes support for two-phase transactional (remote XA) flows, so that a message producer or consumer, running on a client or server system, can participate in a global transaction managed on that client or server system. The specific use for the XA flows is to support access from an application running in one server to a messaging engine on second server, perhaps because the first server does not have a suitable messaging engine. If the remote XA flows are used, a transaction coordinator must be available local to the application.
InboundSecureMessaging
This is the InboundBasicMessaging protocol wrapped in SSL.

For more information about using this property with other connection factory properties for workload management of connections, see Administrative properties for JMS connections to a bus.

Required No
Data type Text
Provider endpoints

A comma-separated list of endpoint triplets, with the syntax hostName:portNumber:chainName, used to connect to a bootstrap server. For example Merlin:7276:BootstrapBasicMessaging,Gandalf:5557:BootstrapSecureMessaging.". If hostName is not specified, the default is localhost. If portNumber is not specified, the default is 7276. If chainName is not specified, the default is BootstrapBasicMessaging. Refer to the InfoCenter for more information.

You only need to modify this property if you have client applications running outside of an application server, or applications on a server in another cell, that want to use this connection factory to connect to the target service integration bus specified on the connection factory.

To use JMS destinations of the default messaging provider, an application connects to a messaging engine on the target service integration bus to which the destinations are assigned. For example, a JMS queue is assigned to a queue destination on a service integration bus.

Client applications running outside of an application server - for example, running in a client container or outside the WebSphere Application Server environment - cannot locate directly a suitable messaging engine to connect to in the target bus. Similarly, an application running on a server in one cell to connect to a target bus in another cell cannot locate directly a suitable messaging engine to connect to in the target bus.

In these scenarios, the clients (or servers in another bus) must complete a bootstrap process through a bootstrap server that is a member of the target bus. A bootstrap server is an application server running the SIB Service, but does not need to be running any messaging engines. The bootstrap server selects a messaging engine that is running in an application server that supports the desired target transport chain. For the bootstrap process to be possible, you must configure one or more provider end points in the connection factory used by the client.

A bootstrap server uses a specific port and bootstrap transport chain. The port is the SIB_ENDPOINT_ADDRESS (or SIB_ENDPOINT_SECURE_ADDRESS if security is enabled), of the messaging engine hosting the remote end of the link. Together with host name, these form the endpoint address of the bootstrap server.

The properties of a JMS connection factory used by an application control the selection of a suitable messaging engine and how the application connects to the selected messaging engine.
  • If no security credentials are provided, then by default
    • If no host is specified then localhost is used
    • If no port is specified then port 7276 is used
    • If no bootstrap channel chain is specified then bootstrap transport chain called BootstrapBasicMessaging is used
  • If security credentials are provided, then by default
    • If no host is specified then localhost is used
    • If no port is specified then port 7286 is used
    • If no bootstrap channel chain is specified then bootstrap transport chain called BootstrapBasicMessaging is used
[iSeries] Note: For the i5/OS® platform, you must (at least) change the default host name from localhost to your.server.name.

If you want an application to use a bootstrap server with a different endpoint address, you need to specify the required endpoint address on the Provider endpoints property of the JMS connection factories that the client application uses. You can specify one or more endpoint addresses of bootstrap servers.

The endpoint addresses for bootstrap servers must be specified in every JMS connection factory that is used by applications outside of an application server. To avoid having to specify a long list of bootstrap servers, you can provide a few highly-available servers as dedicated bootstrap servers. Then you only need to specify a short list of bootstrap servers on each connection factory.

Note: When configuring a connection to a non-default bootstrap server, specify the required values for the endpoint address using colons as separators.
For example: for a server assigned non-secure port 7278, on host boothost1, and using the default transport chain BootstrapBasicMessaging:
boothost1:7278:BootstrapBasicMessaging
or 
boothost1:7278
and for a server assigned secure port 7289, on host boothost2, and using the predefined transport chain BootstrapTunneledSecureMessaging:
boothost2:7289:BootstrapTunneledSecureMessaging
The syntax for an endpoint address is as follows:
[ [host_name] [ ":" [port_number] [ ":" chain_name] ] ]
where:
host_name
is the name of the host on which the server runs. It can be an IP address. In the case of an IPv6 address, put square braces ([]) around host_name as shown in the example below:
[2002:914:fc12:179:9:20:141:42]:7276:BootstrapBasicMessaging
. If a value is not specified, the default is localhost.
[iSeries] Note: For the i5/OS platform, you must (at least) change the default host name from localhost to your.server.name.
port_number
where specified, is one of the following addresses of the messaging engine hosting the remote end of the link:
  • SIB_ENDPOINT_ADDRESS if security is not enabled
  • For secure connections, SIB_ENDPOINT_SECURE_ADDRESS if security is enabled.

If port_number is not specified, the default is 7276.

To find either of these values using the WebSphere Application Server administrative console, complete the following steps:
  1. In the navigation pane, click Servers > Application servers > [Content Pane] server_name.
  2. Under Communications, click Ports
chain_name
is the name of a predefined bootstrap transport chain used to connect to the bootstrap server. If not specified, the default is BootstrapBasicMessaging.

The following predefined bootstrap transport chains are provided:

BootstrapBasicMessaging
This corresponds to the server transport chain InboundBasicMessaging (JFAP-TCP/IP)
BootstrapSecureMessaging
This corresponds to the server transport chain InboundSecureMessaging (JFAP-SSL-TCP/IP)
BootstrapTunneledMessaging
Before you can use this bootstrap transport chain, you must define a corresponding server transport chain on the bootstrap server. (See Servers > Application servers > server_name > Messaging engine inbound transports.) This transport chain tunnels JFAP using HTTP wrappers.
BootstrapTunneledSecureMessaging
Before you can use this bootstrap transport chain, you must define a corresponding server transport chain on the bootstrap server. (See Servers > Application servers > server_name > Messaging engine inbound transports.) This transport chain tunnels JFAP using HTTP wrappers.

Specifying host_name : chain_name instead of host_name : : chain_name (with two colons) is incorrect. It is valid to enter nothing, or to enter any of the following: "a, "a:", ":7276", "::chain", and so on. The default value applies if you do not specify a value, but you must separate the fields with ":"s.

If you want to provide more than one bootstrap server, identify all the required endpoint addresses. Separate each endpoint address by a comma character. For example, to use the servers from the earlier example:
boothost1:7278:BootstrapBasicMessaging, boothost2:7289:BootstrapTunneledSecureMessaging, [2002:914:fc12:179:9:20:141:42]:7276:BootstrapBasicMessaging
Required No
Data type Text area
Connection proximity

The proximity of messaging engines that can accept connection requests, in relation to the bootstrap messaging engine.

When a client issues a client connect request, the processing attaches to the required bus according to the following logic:
  • If a target group is specified, connect to the first messaging engine that satisfies the following conditions for the target type:
    • Server Look for a messaging engine in the same server.
    • Cluster Look for a messaging engine in the same server, then on other servers in the same cluster.
    • Host Look for a messaging engine in the same server, then on other servers in the same cluster, then on other servers in the same host.
    • Bus Look for a messaging engine in the same server, then on other servers in the same cluster, then on other servers in same host, then any other messaging engine on the same bus.
  • If a target group is not specified, or a target group is specified but no suitable messaging engine is found and target significance is Preferred, connect to the first messaging engine that satisfies the following conditions for the target type:
    • Server Look for a messaging engine in the same server.
    • Cluster Connection fails.
    • Host Look for a messaging engine in the same server, then on other servers in the same host.
    • Bus Look for a messaging engine in the target group in same server, then on other servers in same host, then any other messaging engine on the same bus.

For more information about using this property with other connection factory properties for workload management of connections, see Administrative properties for JMS connections to a bus.

Required No
Data type drop-down list
Range
Bus
Connections can be made to messaging engines in the same bus.

Cluster
Connections can be made to messaging engines in the same server cluster.

Host
Connections can be made to messaging engines in the same host.

Server
Connections can be made to messaging engines in the same application server.

Quality of Service

Nonpersistent message reliability

The reliability applied to nonpersistent JMS messages sent using this connection factory.

You can change the delivery reliability option for the destination of a message that is sent by a JMS application as Nonpersistent. The default is Express nonpersistent but you have a range of other options, including those with persistent characteristics, with Assured persistent being the most reliable. For more information refer to Message reliability levels.
Required No
Data type drop-down list
Range
Best effort nonpersistent
Messages are discarded when a messaging engine stops or fails. Messages may also be discarded if a connection used to send them becomes unavailable and as a result of constrained system resources.

Express nonpersistent
Messages are discarded when a messaging engine stops or fails. Messages may also be discarded if a connection used to send them becomes unavailable.

Reliable nonpersistent
Messages are discarded when a messaging engine stops or fails.

Reliable persistent
Messages may be discarded when a messaging engine fails.

Assured persistent
Messages are not discarded.

As bus destination
Use the delivery option configured for the bus destination.

Persistent message reliability

The reliability applied to persistent JMS messages sent using this connection factory.

You can change the delivery reliability option for the destination of a message that is sent by a JMS application as Persistent. The default is Reliable persistent but you have a range of other options including those with nonpersistent characteristics, with Best effort nonpersistent being the least reliable. For more information refer to .
Important: If you change the delivery reliability options of a message sent by a JMS application from one of the Persistent message reliability options (Assured persistent and Reliable persistent) to one of the Nonpersistent message reliability options (Best effort nonpersistent, Express nonpersistent, and Reliable nonpersistent), you risk losing messages in certain circumstances. For example, at server restart, or when there is heavy workload.
Required No
Data type drop-down list
Range
Best effort nonpersistent
Messages are discarded when a messaging engine stops or fails. Messages may also be discarded if a connection used to send them becomes unavailable and as a result of constrained system resources.

Express nonpersistent
Messages are discarded when a messaging engine stops or fails. Messages may also be discarded if a connection used to send them becomes unavailable.

Reliable nonpersistent
Messages are discarded when a messaging engine stops or fails.

Reliable persistent
Messages may be discarded when a messaging engine fails.

Assured persistent
Messages are not discarded.

As bus destination
Use the delivery option configured for the bus destination.

Advanced Messaging

Read ahead

Read ahead is an optimization that preemptively assigns messages to consumers. This improves the time taken to satisfy consumer requests.

Messages that are assigned to a consumer are locked on the server and cannot be consumed by any other consumers for that destination. Messages that are assigned to a consumer, but not consumed before that consumer is closed, are subsequently unlocked on the server and then available for receipt by other consumers.

You can override this property for individual JMS destinations by setting the Read ahead property on the JMS destination.

Required No
Data type drop-down list
Range
Default
The message provider preemptively assigns messages to consumers on nondurable subscriptions and unshared durable subscriptions. That is, read ahead optimization is turned on only when there can only be a single consumer.

Enabled
The messaging provider preemptively assigns messages to consumers. This improves the time taken to satisfy consumer requests.
Disabled
The messaging provider does not preemptively assign messages to consumers.

Temporary queue name prefix

The prefix of up to twelve characters used for names of temporary queues created by applications that use this connection factory.

Required No
Data type Text

Advanced Administration

Component-managed authentication alias

This alias specifies a user ID and password to be used to authenticate connections to the JMS provider for application-managed authentication.

This property provides a list of the J2C authentication data entry aliases that have been defined to WebSphere Application Server. You can select a data entry alias to be used to authenticate the creation of a new connection to the JMS provider.

If you have enabled WebSphere Application Server security, select the alias that specifies the user ID and password used to authenticate the creation of a new connection to the JMS provider. The use of this alias depends on the resource authentication (res-auth) setting declared in the connection factory resource reference of an application component's deployment descriptors.

Required No
Data type drop-down list
Log missing transaction contexts

Whether or not the container logs that there is a missing transaction context when a connection is obtained.

The J2EE programming model indicates that connections should always have a transaction context. However, some applications do not correctly have a transaction context associated with them.

Select this property to log connections being created without a transaction context.

Required No
Data type Check box
Manage cached handles

Whether cached handles (handles held in instance variables in a bean) should be tracked by the container.

Select this option to track handle management, which can be useful for debugging purposes. However, tracking handles can cause large performance overhead if used at run time.
Required No
Data type Check box
Share data source with CMP

Allow sharing of connections between JMS and container-managed persistence (CMP) entity beans.

This option is used as part of the task to enable container-managed persistence (CMP) entity beans to share the database connections used by the data store of a messaging engine. This has been estimated as a potential performance improvement of 15% for overall message throughput, but can only be used for entity beans connected to the application server that contains the messaging engine.

For more information about using this option, see Enabling CMP entity beans and messaging engine data stores to share database connections.

Required No
Data type Check box
XA recovery authentication alias

The authentication alias used during XA recovery processing.

Select the alias to be used during transaction recovery processing.

This property provides a list of the J2C authentication data entry aliases that have been defined to WebSphere Application Server. You can select a data entry alias to be used to authenticate during XA recovery processing.

If you have enabled security for the associated service integration bus, select the alias that specifies the user ID and password used for XA recovery which is valid in the user registry for WebSphere Application Server. This property must be set if bus security is enabled and XA transactions are to be used.

Required No
Data type drop-down list

Additional properties

Connection pool properties
An optional set of connection pool settings.



Reference topic Reference topic    

Terms and conditions for information centers | Feedback

Last updatedLast updated: Aug 31, 2013 1:23:07 AM CDT
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=pix&product=was-nd-dist&topic=SIBJMSQueueConnectionFactory_DetailForm
File name: SIBJMSQueueConnectionFactory_DetailForm.html