C

server-ref

zero or more 

References a server instance that belongs to the cluster. 

resource-ref

zero or more 

References a resource deployed to the cluster. 

application-ref

zero or more 

References an application or module deployed to the cluster. 

system-property

zero or more 

Specifies a system property. 

property

zero or more 

Specifies a property or a variable. 

name

none 

Specifies the name of the cluster. 

config-ref

default config element’s name attribute value, server-config

References the configuration used by the cluster. 

heartbeat-port

none; value automatically generated 

Specifies the communication port the Group Management Service uses to listen for group events. Must be a valid port number. 

heartbeat-address

none; value automatically generated 

Specifies the address the Group Management Service uses to listen for group events. Must be a multicast address. 

heartbeat-enabled

false (developer profile)

true (cluster profile)

(optional) If true, the Group Management Service is started as a lifecycle module in each server instance in the cluster and in the Domain Administration Server. The Domain Administration Server participates in each cluster that has this attribute set to true.

gms-bind-interface-address

none 

Specifies which address the group management service uses on a multi-home machine. If a machine has only one network interface, there is no need to set this property. 

If this property is not set or is set to an invalid value on a multi-home machine, Communications Server uses all available addresses. The primary address is nondeterministic, because the ordering of addresses is specific to the operating system, not the Java network API used to access the network interfaces. 

You can create system-property elements to set this value differently for each server instance in the cluster. For example:

<domain>
    ...
    <clusters>
        <cluster name="cluster1" ... >
            ...
            <property name="gms-bind-interface-address"
                value="${GMS_CLUSTER1_BIND_IF_ADDR}"/>
        </cluster>
        ...
    </clusters>
    ...
    <servers>
        <server name="server1" ... >
            ...
            <system-property name="GMS_CLUSTER1_BIND_IF_ADDR"
                value="123.456.78.910"/>
        </server>
        ...
    </servers>
    ...
</domain>

health-checker

zero or one 

Defines a health checker for the referenced cluster. 

ref

none 

References the name attribute of a cluster element.

lb-policy

round-robin

(optional) Specifies the load balancing policy. Allowed values are: 

• round-robin — The load balancer cycles through the cluster's server instances in a specified order.

• weighted-round-robin — The load balancer cycles through the server instances in a specified order, but routes more requests to instances with greater processing capacity. Processing capacity is represented by values of the lb-weight attribute of each server element referenced by the cluster.

• user-defined — The load balancing policy is defined in a custom module.

lb-policy-module

none 

(optional) Specifies the absolute path to the shared library that implements the user-defined policy. The shared library must exist and be readable on the machine where the load balancer is running. 

Required only if lb-policy is set to user-defined.

cluster

zero or more 

Defines a cluster. 

sip-service

zero or one 

Configures the SIP service. 

http-service

only one 

Configures the HTTP service. 

overload-protection-service

only one 

Configures the overload protection service for HTTP and SIP requests. 

iiop-service

only one 

Configures the IIOP service. 

admin-service

only one 

Determines whether the server to which the configuration applies is an administration server. 

connector-service

zero or one 

Configures the connector service. 

web-container

only one 

Configures the web container. 

ejb-container

only one 

Configures the Enterprise JavaBeans^TM (EJB^TM) container.

mdb-container

only one 

Configures the message-driven bean (MDB) container. 

sip-container

zero or one 

Configures the SIP container. 

jms-service

zero or one 

Configures the Java Message Service (JMS) provider. 

log-service

only one 

Configures the system logging service. 

security-service

only one 

Configures the Java EE security service. 

transaction-service

only one 

Configures the transaction service. 

monitoring-service

only one 

Configures the monitoring service. 

diagnostic-service

zero or one 

Configures the diagnostic service. 

java-config

only one 

Configures the Java Virtual Machine (JVM^TM).

availability-service

zero or one 

Configures the availability service. 

thread-pools

only one 

Configures thread pools. 

alert-service

zero or one 

Configures the alert service. 

group-management-service

zero or one 

Configures the group management service. 

management-rules

zero or one 

Configures self-management rules. 

system-property

zero or more 

Specifies a system property. 

property

zero or more 

Specifies a property or a variable. 

name

server-config (for default instance)

Specifies the name of the configuration. 

dynamic-reconfiguration-enabled

true

(optional) If true, any changes to the system (for example, applications deployed, resources created) are automatically applied to the affected servers without a restart being required. If false, such changes are only picked up by the affected servers when each server restarts.

config

only one (developer profile) 

one or more (cluster profile) 

Defines a configuration. 

queue-size-in-bytes

-1

(optional) Specifies the maximum number of messages that can be queued until threads are available to process them for http-listener or sip-listener elements. A value of -1 specifies no limit.

max-pending-count

4096

(optional) Specifies the maximum number of pending connections on an http-listener or sip-listener. Not implemented if the parent element is sip-service.

receive-buffer-size-in-bytes

4096 (http-service)

socket channel receive buffer size (sip-service)

(optional) Specifies the size of the receive buffer for all http-listener or sip-listener elements. A value of -1 specifies no limit.

send-buffer-size-in-bytes

8192

(optional) Specifies the size of the send buffer for all http-listener or sip-listener elements.

description

zero or one 

Contains a text description of this element. 

security-map

zero or more 

Maps the principal received during servlet or EJB authentication to the credentials accepted by the EIS. 

property

zero or more 

Specifies a property or a variable. 

name

none 

Specifies the name of the connection pool. A connector-resource element’s pool-name attribute refers to this name.

resource-adapter-name

none 

Specifies the name attribute of the deployed connector-module. If no name is specified during deployment, the name of the .rar file is used. If the resource adapter is embedded in an application, then it is app_name#rar_name.

connection-definition-name

none 

Specifies a unique name, identifying a resource adapter’s connection-definition element in the ra.xml file. This is usually the connectionfactory-interface of the connection-definition element.

steady-pool-size

8

(optional) Specifies the initial and minimum number of connections maintained in the pool. 

max-pool-size

32

(optional) Specifies the maximum number of connections that can be created to satisfy client requests. 

max-wait-time-in-millis

60000

(optional) Specifies the amount of time, in milliseconds, that the caller is willing to wait for a connection. If 0, the caller is blocked indefinitely until a resource is available or an error occurs.

pool-resize-quantity

2

(optional) Specifies the number of idle connections to be destroyed if the existing number of connections is above the steady-pool-size (subject to the max-pool-size limit).

This is enforced periodically at the idle-timeout-in-seconds interval. An idle connection is one that has not been used for a period of idle-timeout-in-seconds. When the pool size reaches steady-pool-size, connection removal stops.

idle-timeout-in-seconds

300

(optional) Specifies the maximum time that a connection can remain idle in the pool. After this amount of time, the pool can close this connection. 

fail-all-connections

false

(optional) If true, closes all connections in the pool if a single validation check fails.

transaction-support

none 

(optional) Specifies the transaction support for this connection pool. Overrides the transaction support defined in the resource adapter in a downward compatible way: supports a transaction level lower than or equal to the resource adapter’s, but not higher. Allowed values in descending order are: 

• XATransaction - Supports distributed transactions.

• LocalTransaction - Supports local transactions only.

• NoTransaction - No transaction support.

is-connection-validation-required

false

(optional) Specifies whether connections have to be validated before being given to the application. If a resource’s validation fails, it is destroyed, and a new resource is created and returned. 

connection-leak-timeout-in-seconds

0

Detects potential connection leaks by the application. A connection that is not returned back to the pool by the application within the specified period is assumed to be potentially leaking, and a stack trace of the caller is logged. A zero value disables leak detection. A nonzero value enables leak tracing. 

connection-leak-reclaim

false

If true, the pool will reclaim a connection after connection-leak-timeout-in-seconds occurs.

connection-creation-retry-attempts

0

Specifies the number of attempts to create a new connection. 

connection-creation-retry-interval-in-seconds

10

Specifies the time interval between attempts to create a connection when connection-creation-retry-attempts is greater than 0.

validate-atmost-once-period-in-seconds

60

Specifies the time interval within which a connection is validated at most once. Minimizes the number of validation calls. 

lazy-connection-enlistment

false

If true, a connection is not enlisted in a transaction until it is used. If false, any connection object available to a transaction is enlisted in the transaction.

lazy-connection-association

false

If true, a physical connection is not associated with a logical connection until it is used. If false, a physical connection is associated with a logical connection even before it is used.

associate-with-thread

false

If true, allows a connection to be saved as a ThreadLocal in the calling thread. This connection gets reclaimed only when the calling thread dies or when the calling thread is not in use and the pool has run out of connections.

match-connections

true

If true, enables connection matching. You can set to false if connections are homogeneous.

max-connection-usage-count

0

Specifies the number of times a connections is reused by the pool, after which it is closed. A zero value disables this feature. 

AddressList

none 

Specifies a list of host/port combinations of the Message Queue software. For JMS resources of the Type javax.jms.TopicConnectionFactory or javax.jms.QueueConnectionFactory.

ClientId

none 

Specifies the JMS Client Identifier to be associated with a Connection created using the createTopicConnection method of the TopicConnectionFactory class. For JMS resources of the Type javax.jms.TopicConnectionFactory .

Durable subscription names are unique and only valid within the scope of a client identifier. To create or reactivate a durable subscriber, the connection must have a valid client identifier. The JMS specification ensures that client identifiers are unique and that a given client identifier is allowed to be used by only one active connection at a time. 

UserName

guest

Specifies the user name for connecting to the Message Queue software. For JMS resources of the Type javax.jms.TopicConnectionFactory or javax.jms.QueueConnectionFactory.

Password

guest

Specifies the password for connecting to the Message Queue software. For JMS resources of the Type javax.jms.TopicConnectionFactory or javax.jms.QueueConnectionFactory.

ReconnectAttempts

6

Specifies the number of attempts to connect (or reconnect) for each address in the imqAddressList before the client runtime moves on to try the next address in the list. A value of -1 indicates that the number of reconnect attempts is unlimited (the client runtime attempts to connect to the first address until it succeeds).

ReconnectInterval

30000

Specifies the interval between reconnect attempts in milliseconds. This applies to attempts on each address in the imqAddressList and on successive addresses in the list. If too short, this time interval does not give a broker time to recover. If too long, the reconnect might represent an unacceptable delay.

ReconnectEnabled

false

If true, specifies that the client runtime attempts to reconnect to a message server (or the list of addresses in imqAddressList) when a connection is lost.

AddressListBehavior

priority

Specifies whether connection attempts are in the order of addresses in the imqAddressList attribute (priority) or in a random order (random). If many clients are attempting a connection using the same connection factory, use a random order to prevent them from all being connected to the same address.

AddressListIterations

-1

Specifies the number of times the client runtime iterates through the imqAddressList in an effort to establish (or reestablish) a connection. A value of -1 indicates that the number of attempts is unlimited.

LazyConnectionEnlistment

false

Deprecated. Use the equivalent attribute. 

LazyConnectionAssociation

false

Deprecated. Use the equivalent attribute. 

AssociateWithThread

false

Deprecated. Use the equivalent attribute. 

MatchConnections

true

Deprecated. Use the equivalent attribute. 

description

zero or one 

Contains a text description of this element. 

property

zero or more 

Specifies a property or a variable. 

name

none 

The name of the connector module. 

location

none 

The location of the connector module in the Communications Server file system. 

object-type

user

(optional) Defines the type of the resource. Allowed values are: 

• system-all - A system resource for all server instances and the domain application server.

• system-admin - A system resource only for the domain application server.

• system-instance - A system resource for all server instances only.

• user - A user resource.

enabled

true

(optional) Determines whether the connector module is enabled. 

directory-deployed

false

(optional) Specifies whether the application has been deployed as a directory. 

description

zero or one 

Contains a text description of this element. 

property

zero or more 

Specifies a property or a variable. 

jndi-name

none 

Specifies the JNDI name for the resource. 

pool-name

none 

Specifies the name of the associated connector connection pool, defined in a connector-connection-pool element.

object-type

user

(optional) Defines the type of the resource. Allowed values are: 

• system-all - A system resource for all server instances and the domain application server.

• system-admin - A system resource only for the domain application server.

• system-instance - A system resource for all server instances only.

• user - A user resource.

enabled

true

(optional) Determines whether this resource is enabled at runtime. 

shutdown-timeout-in-seconds

30 

(optional) Specifies the maximum time allowed during application server shutdown for the ResourceAdapter.stop() method of a connector module’s instance to complete. Resource adapters that take longer to shut down are ignored, and Communications Server shutdown continues.

ref

none 

References the name attribute of a cluster element.

self-loadbalance

true

(optional) If true, specifies that a configured cluster load balances incoming requests to itself. If true, the parent converged-lb-config element must have exactly one converged-lb-cluster-ref subelement. In this case, the load balancer is an intrinsic component of the participating server instances in the cluster.

For production environments, only the true setting is supported.

converged-lb-policy

only one 

Specifies the load balancing policy used by the converged load balancer. 

converged-lb-cluster-ref

one or more; only one if this subelement's selfloadbalance attribute is true; zero if a server-ref is defined

References a cluster. This element contains some attributes related to load balancing. 

server-ref

one or more; zero if a converged-lb-cluster-ref is defined

References a stand-alone server instance, which does not belong to a cluster. The referenced server element contains some attributes related to load balancing.

property

zero or more 

Specifies a property or a variable. 

name

none 

Specifies the name of the converged load balancer configuration. 

load-increase-factor

1

Specifies the factor by which a single recovered server instance is incrementally included in load distribution. Allowed values are decimal numbers between 0 and 1. 

The load factor starts at zero and increases by load-increase-factor every load-factor-increase-period-in-seconds until it reaches 1. For example, if load-increase-factor is set to 0.1 and load-factor-increase-period-in-seconds is set to 60, it takes ten minutes for a recovered instance to be fully included in load distribution.

The load-increase-factor and load-factor-increase-period-in-seconds properties are applicable to all SIP requests and to HTTP requests for converged applications only if data-centric rules are specified.

The load-increase-factor and load-factor-increase-period-in-seconds properties have no effect on the round-robin algorithm, which is applicable to HTTP requests for pure web applications.

load-factor-increase-period-in-seconds

0

Specifies the number of seconds between load factor increases for a recovered server instance. 

If load-factor-increase-period-in-seconds is set to zero, load-increase-factor has no effect. The load factor for the recovered instance becomes 1 immediately.

If load-factor-increase-period-in-seconds is set and load-increase-factor is not set, the recovered instance gets no load for load-factor-increase-period-in-seconds. After load-factor-increase-period-in-seconds lapses, the load factor for the recovered instance becomes 1.

sendUDPResponseFromBackend

false

If true, specifies that UDP responses are sent to the client from the back end instead of the front end, saving an extra network hop.

converged-lb-config

zero or more 

Defines a converged load balancer configuration. 

property

zero or more 

Specifies a property or a variable. 

http

round-robin

(optional) Specifies the load balancing policy for pure HTTP requests. This attribute applies to the HTTP part of converged HTTP/SIP requests if dcr-file is not specified. The only allowed value is round-robin, which means that the load balancer cycles through the cluster's server instances in a specified order.

sip

from-tag,call-id

(optional) Specifies the load balancing policy for SIP requests if dcr-file is not specified. Specifies the parameters on which a consistent hashing policy is applied to obtain the hash key. The default is the only allowed value.

dcr-file

none 

(optional) Specifies the data-centric-rules.xml file path name, which provides the rules for applying consistent hashing on SIP and converged HTTP/SIP requests. By default this file is not specified. If specified, this file takes precedence over the http and sip attributes. This can be an absolute or relative path. A relative path is relative to domain-dir/cluster/config.

If a request doesn't match any DCR file rules, a hash key is generated using from-tag,call-id. For an HTTP request, this is the remote host port and address.

proxy

only one 

Specifies the proxy configuration for the converged load balancer. 

name

none 

Specifies a unique name for the load balancer. 

config-file

domain-dir/cluster/config/converged-loadbalancer.xml

Specifies the load balancer's configuration file, converged-loadbalancer.xml. This can be an absolute or relative path. A relative path is relative to domain-dir/cluster/config.

auto-commit

false

(optional) If true, configuration file changes are propagated to load balancer instances immediately.

converged-lb-config-name

none 

Specifies the name of the converged-lb-config used by the load balancer.

description

zero or one 

Contains a text description of this element. 

property

zero or more 

Specifies a property or a variable. 

jndi-name

none 

Specifies the JNDI name for the resource. 

res-type

none 

Specifies the fully qualified type of the resource. 

factory-class

none 

Specifies the fully qualified name of the user-written factory class, which implements javax.naming.spi.ObjectFactory.

object-type

user

(optional) Defines the type of the resource. Allowed values are: 

• system-all - A system resource for all server instances and the domain application server.

• system-admin - A system resource only for the domain application server.

• system-instance - A system resource for all server instances only.

• user - A user resource.

enabled

true

(optional) Determines whether this resource is enabled at runtime.