Configuring the Eclipse Amlen resource adapter for outbound communication

To configure outbound communication, define the properties of a ConnectionFactory object and an administered destination object.

When outbound communication is used, an application that is running on WebSphere® Application Server starts a connection to Eclipse Amlen, and then sends messages to and receives messages from Eclipse Amlen in a synchronous manner.

To configure outbound communication, define JCA resources in the properties of a ConnectionFactory object, which the application server uses to create a JMS ConnectionFactory object.

Complete the following steps to create and configure a new ConnectionFactory by using the WebSphere Application Server panels.

Log on to the WebSphere Application Server administrative console.
Click Resources > Resource Adapters > J2C connection factories.
Click New and complete the Name and Connection factory interface fields.
Click Apply.
Click the Custom properties link in the Additional Properties panel. You can then edit the properties of the ConnectionFactory object.
Click Save to save your changes.

Note: In addition to Eclipse Amlen connection factory settings, you can view connection pool settings for the connection factory by clicking Resources > Resource Adapters > J2C connection factories > [Connection factory name] > Connection pool properties. Connection pool settings can have a significant impact on performance. For information about connection pool settings, see Connection pool settings in the WebSphere Application Server documentation.

Table 1 lists the properties of a ConnectionFactory object that are used to configure the Eclipse Amlen resource adapter for outbound communication.

Table 1. ConnectionFactory object propertiesList of the properties of a ConnectionFactory object that are used to configure the Eclipse Amlen resource adapter for outbound communication
lists the properties of a ConnectionFactory object that are used to configure the Eclipse Amlen resource adapter for outbound communication.
Name of property	Type	Valid values	Default value	Description
clientId	String	Any valid Unicode string.	`null`	The client ID for this connection. Setting client ID is optional in most cases, but is required for non-shared, durable subscriptions. If clientId is set, it must be unique for all connections to an Eclipse Amlen server. If clientId is not set (and is not required to be set), then the Eclipse Amlen JMS client automatically creates a client ID. The Eclipse Amlen JMS client allows any valid Unicode string to be used as a client ID. However, you might prefer to use displayable characters. System generated client IDs start with an underscore (_), therefore avoid putting an underscore as an initial character to prevent conflicts. Client IDs that start with two underscores (__) are reserved for system use. Note: If clientId is specified, set the maximum connections value for the connection pool to `1`. You can set maximum connections by clicking Resources > Resource Adapters > J2C connection factories > [Connection factory name] > Connection pool properties.
convertMessageType	String	`auto`, `bytes`, `text`	`auto`	The action to take when a message is converted to JMS from a source that does not indicate the message type. If the message comes from JMS, then this property is not used. When `bytes` is specified, then messages are converted to `BytesMessage`. When `text` is specified, then messages are converted to `TextMessage`. When `auto` is specified, then the JMS client automatically determines whether to convert the message to `BytesMessage` or to `TextMessage`.
password	String	Any valid Unicode string.	`null`	The password for user authentication with Eclipse Amlen. Eclipse Amlen uses this value if user is specified.
port	Numeric	Value can be in the range of `1` - `65535`	`0` This default value must be changed.	The Eclipse Amlen TCP port to use for this connection. If there are multiple Eclipse Amlen servers in the server properties list, then all servers use the same port.
protocol	String	`tcp`, `tcps`	`tcp`	The transmit protocol for communication with Amlen. A value of `tcp` indicates a non-secure connection. A value of `tcps` indicates a secure connection. If a secure connection is specified, then you must ensure that the WebSphere Application Server is correctly configured. For more information, see Transport Layer Security for the Eclipse Amlen resource adapter.
securityConfiguration	String	Any valid Unicode string.	`null`	The name of the WebSphere security configuration to use for this connection. This value is only used if protocol is set to `tcps`. Use securityConfiguration only if you are not using the WebSphere Application Server default security configuration. For more information, see Transport Layer Security for the Eclipse Amlen resource adapter.
securitySocketFactory	String	Any valid Unicode string.	`null`	The name of the security socket factory that is used for establishing secure connections. This value is only used if protocol is set to `tcps`. Use securitySocketFactory only if you are not using the WebSphere Application Server default security socket factory. For more information, see Transport Layer Security for the Eclipse Amlen resource adapter.
server	String	Any valid Unicode string.	`null` This default value must be changed.	A space or comma delimited list of Eclipse Amlen host names or IP addresses. The resource adapter attempts to connect to each server in the list until a connection is established.
temporaryQueue	String	Any valid Unicode string.	`null`	Specifies the prototype name for a temporary queue. A unique identifier is appended to this name to form the actual temporary queue name. Prototype names allow Eclipse Amlen policies to be assigned to the temporary queue by locating the temporary queue in a known place in the queue name space. If the prototype contains the character sequence `$CLIENTID`, then that string is replaced by the client ID of the connection. A temporary queue is used as the JMS "reply to" destination for request-reply scenarios in the point-to-point messaging domain.
temporaryTopic	String	Any valid Unicode string.	`null`	Specifies the prototype name for a temporary topic. A unique identifier is appended to this name to form the actual temporary topic name. Prototype names allow Eclipse Amlen policies to be assigned to the temporary topic by locating the temporary topic in a known place in the topic tree. If the prototype contains the character sequence `$CLIENTID`, then that string is replaced by the client ID of the connection. A temporary topic is used as the JMS "reply to" destination for request-reply scenarios in the publish/subscribe messaging domain.
transactionSupportLevel	String	`XATransaction`, `LocalTransaction`, `NoTransaction`	`XATransaction`	Specifies the types of transactions to support for this connection. A value of `XATransaction` indicates that global and local transactions are supported. A value of `LocalTransaction` indicates that WebSphere Application Server can use resource manager local transactions only for this connection. A value of `NoTransaction` indicates that WebSphere Application Server transactions are not supported for this connection.
traceLevel	Numeric	`-1`, or value can be in the range of `0` - `9`	`-1`	The level of trace detail that is provided in the Eclipse AmlenJMS and resource adapter output for this connection. When set to `-1`, the trace level that is used for this connection is the ResourceAdapter defaultTraceLevel setting. For example, WebSphere Application Server is started with defaultTraceLevel set to `4`. If an MDB is then started that uses an activation specification with traceLevel set to `-1`, then the trace level for that MDB and associated activation specification is `4`. At level `0`, there is no trace. At level `9`, there is a detailed debug trace. As the trace level is increased, more trace is shown. Use trace levels of `5` or lower to minimize performance impact and generate a small amount of trace, including stack traces for all exceptions. Use trace levels of `6` - `9` for debugging. Higher log levels can result in a large amount of trace output and can affect performance. Note: If the defaultTraceLevel is changed after the WebSphere Application Server is started, then any new or existing activation specifications and connection factories that are set to use `-1` continue to receive and use the defaultTraceLevel that was in effect when the WebSphere Application Server started. The new defaultTraceLevel value is not used until the next time the application server is started.
user	String	Any valid Unicode string.	`null`	The user name for user authentication with Eclipse Amlen. Eclipse Amlen always uses this value if it is provided, unless a security profile is attached to the endpoint with UsePasswordAuthentication set to `False`.