Configuring an Endpoint Connection for a JMS Session and Transport

Use the Endpoint Wizard to configure an endpoint connection for a JMS session and transport. To access the Endpoint Wizard, from Endpoint Manager, right-click on the Messaging endpoint node, select Add Endpoint, and select the endpoint type.

You must configure a session before you configure the transport because the session provides information used by the transport. JMS Sessions are configured to point to existing connection factories on a JMS provider.

JMS Session

Session Key

Description

Name

Name and description of the new configuration object for use in the GUI to select the appropriate service. User defined.

JMS Server URL

URL for the server hosting the session. Required.
Legacy Key: JMS_SES_PROVIDER_URL

Example: iiop://<machine name>:9000

The example assumes the default port number, 9000 is used. To verify the port number, check the eas_install.props file in the <server install directory>/EAServer directory. Check the port value for com.Sybase.jaguar.install.listeners.iiop.

Initial Context Factory

Name of the initial context factory that is used to look up connection factory and queue objects. Required.

Example: com.sybase.jms.InitialContextFactory

Connection Factory

Name of the connection factory that is used to connect to queues. Required.
Example: javax.jms.QueueConnectionFactory

Classpath

Java class path used by the application server instance. Required.

<CLIENT_CLASSPATH> must include the following, separated by semicolons (;) on Windows or colons (:) on UNIX:

   JMS Classes

    • the application server jar file [easj2ee.jar for Sybase EAServer] and

    • the OT driver jar file [dvjms41jni.jar for JMS OT driver]

   Client classes [easclient.jar for Sybase EAServer]

Example: <server install directory>/EAServer/java/lib/easclient.jar;<server install directory>/bin/dvjms41jni.jar;<server install directory>/bin/easj2ee.jar;

Transacted Session

Select CLIENT_ACKNOWLEDGE for JMS messaging implemented with EAServer. CLIENT_ACKNOWLEDGE acknowledges messages by calling the acknowledge method on the message.

Note: This parameter selects whether the JMS session is transacted. If TRUE, message acknowledgement is handled automatically by the session commit and recovery in handled by session rollback. If FALSE, the session is not transacted. The CLIENT_ACKNOWLEDGE option is suggested for JMS messaging implemented with EAServer. Selecting TRUE will result in a runtime error and subsequent application shutdown if the application server timeout is reached.

User name

User name associated with the application server connection.

Password

Password associated with the application server connection.

JMS Session Properties

Arbitrary key/value pairs that are passed to the JMS InitialContext when instantiated. Refer to the documentation for your specific JMS implementation for information on configurable keys and values.

 

JMS Transports are configured to point to existing destinations (that is, queues) on a JMS provider.

JMS Transport

This information identifies each configuration parameter presented in the Endpoint Manager for each type of transport mechanism that you are using. The specific key name is also provided.  See the Common Transport Keys for keys that are also included in the JMS transport configuration.

JMS Transport Keys

Transport Key

Description

JMS Selective Get

 

The selection string used when filtering messages. For example, you can set this based on an if clause: Get the message if... . (for example, if the priority is above a certain value). If a message that meets this criteria is not found, no message is returned. Default is NULL.
Legacy Key: JMS_TIL_MSG_SELECTOR

Default JMS Body Type

 

Message type to send.

Values: JMS_BYTES sends and receives Bytes Messages. Default.

            JMS_Text sends and receives Text Messages.

When JMS_MSG_BODY_TYPE is set, it overrides this property.

Default is JMS_BYTES.

Legacy Key: JMS_TIL_DEFAULT_BODY_TYPE

Blocking Timeout

 

The number of milliseconds with no activity before a timeout occurs.

The default is for no blocking to occur so the return is immediate.

It is recommended that you set blocking timeout to 2000 (2 seconds).

Legacy Key: NNOT_TIL_GET_BLOCKING_TIMEOUT

Transport Name

 

The queue or topic name associated with the transport instance for a lookup of the queue or topic. Required.

If JMS_SES_TRANSPORT_MODE is set to Queue, the key specified the name of a queue object.

If JMS_SES_TRANSPORT_MODE is set to Topic, the key specified the name of a topic object.

Legacy Key: NN0T_TIL_OPEN_TSI

Audit Put Transport Name

The name of another transport to receive a copy of the message after a Get is complete.

Legacy Key: NNOT_AUDIT_TRANSPORT_FOR_GETS

Audit Get Transport Name

 

The name of another transport to receive a copy of the message after a Put is complete.

Legacy Key: NNOT_AUDIT_TRANSPORT_FOR_PUTS

Target Encoding

 

Specifies the target encoding that will be used on get message operations. This key only has effect when JMS_TEXT is being used as the JMS body type.

Legacy Key: NNOT_TIL_GET_TO_CODE_PAGE

 

Common Transport Keys

The information in the table identifies configuration parameters used in the Endpoint Wizard for each type of transport mechanism used. The specific key name is provided when it is used within the GUI to reference these parameters.

Transport Name

Description

Name

Name and description of the new configuration object for use in the GUI for selecting the appropriate service.

Session Name

NNOT_TIL_OPEN_SESSION_ID

Name of the session associated with the transport instance.

Transport Name

NNOT_TIL_OPEN_TSI

Name of the transport specific instance name. Required.

Blocking Timeout

NNOT_TIL_GET_BLOCKING_TIMEOUT

Amount of time in milliseconds to wait for a message to arrive before the process performs another put or get.

The default is for no blocking to occur so the return is immediate.

It is recommended that you set blocking timeout to 2000 (2 seconds).

Message Option Headers

Specifies whether a message put to the transport should contain a message option header.

NNOT_HDR_INCLUDE

NNOT_HDR_EXCLUDE

NNOT_HDR_IF_NEEDED