Sun Java System Application Server 9.1 Administration Reference

jms-service

Configures the built-in Java Message Service (JMS) that is managed by the Application Server.

Superelements

config

Subelements

The following table describes subelements for the jms-service element.

Table 1–95 jms-service Subelements

Element 

Required 

Description 

jms-host

zero or more 

Specifies a host. 

property

zero or more 

Specifies a property or a variable. 

Attributes

The following table describes attributes for the jms-service element.

Table 1–96 jms-service Attributes

Attribute 

Default 

Description 

init-timeout-in-seconds

60

(optional) Specifies the amount of time the server instance waits at startup for its configured default JMS host to respond. If there is no response, startup is aborted. If set to 0, the server instance waits indefinitely.

type

EMBEDDED (DAS) or LOCAL (other server instances)

Specifies the type of JMS service: 

  • EMBEDDED means the JMS provider is started in the same JVM as the Application Server, and the networking stack is bypassed.

    Lazy initialization starts the default embedded broker on the first access of JMS services rather than at Application Server startup. EMBEDDED mode is not a supported configuration for a cluster.

  • LOCAL means the JMS provider is started along with the Application Server.

    The LOCAL setting implicitly sets up a 1:1 relationship between an Application Server instance and a Message Queue broker. When you create an Application Server cluster, a Message Queue cluster is automatically created as well. During cluster creation, each instance in the Application Server cluster is automatically configured with a broker in the Message Queue cluster, and a unique broker port is determined.

  • REMOTE means the JMS provider is remote and is not started by the Application Server.

start-args

none 

(optional) Specifies the string of arguments supplied for startup of the corresponding JMS instance. 

default-jms-host

none 

Specifies the name of the default jms-host. If type is set to LOCAL, this jms-host is automatically started at Application Server startup.

reconnect-interval-in-seconds

5 (developer profile)

60 (cluster and enterprise profiles)

(optional) Specifies the interval between reconnect attempts. 

reconnect-attempts

3

(optional) Specifies the number of reconnect attempts. 

reconnect-enabled

true

(optional) If true, reconnection is enabled. The JMS service automatically tries to reconnect to the JMS provider when the connection is broken.

When the connection is broken, depending on the message processing stage, the onMessage() method might not be able to complete successfully or the transaction might be rolled back due to a JMS exception. When the JMS service reestablishes the connection, JMS message redelivery semantics apply.

addresslist-behavior

random

(optional) Specifies whether the reconnection logic selects the broker from the imqAddressList in a random or sequential (priority) fashion.

addresslist-iterations

3

(optional) Specifies the number of times the reconnection logic iterates over the imqAddressList if addresslist-behavior is set to PRIORITY.

mq-scheme

mq

(optional) Specifies the scheme for establishing connection with the broker. For example, specify http for connecting to the broker over HTTP.

mq-service

jms

(optional) Specifies the type of broker service. If a broker supports SSL, the type of service can be ssljms.

Properties

The following table describes properties for the jms-service element.

Table 1–97 jms-service Properties

Property 

Default 

Description 

instance-name

imqbroker

Specifies the full Sun Java System Message Queue broker instance name.

instance-name-suffix

none 

Specifies a suffix to add to the full Message Queue broker instance name. The suffix is separated from the instance name by an underscore character (_). For example, if the instance name is imqbroker, appending the suffix xyz changes the instance name to imqbroker_xyz.

append-version

false

If true, appends the major and minor version numbers, preceded by underscore characters (_), to the full Message Queue broker instance name. For example, if the instance name is imqbroker , appending the version numbers changes the instance name to imqbroker_8_0.

user-name

guest

Specifies the user name for creating the JMS connection. Needed only if the default username/password of guest/guest is not available in the broker. 

password

guest

Specifies the password for creating the JMS connection. Needed only if the default username/password of guest/guest is not available in the broker.