Defines a cluster.
Some topics in the documentation pertain to features that are available only in domains that are configured to support clusters. Examples of domains that support clusters are domains that are created with the cluster profile or the enterprise profile. For information about profiles, see Usage Profiles in Sun Java System Application Server 9.1 Administration Guide.
The following table describes subelements for the cluster element.
Table 1–23 cluster Subelements
Element |
Required |
Description |
---|---|---|
zero or more |
References a server instance that belongs to the cluster. |
|
zero or more |
References a resource deployed to the cluster. |
|
zero or more |
References an application or module deployed to the cluster. |
|
zero or more |
Specifies a system property. |
|
zero or more |
Specifies a property or a variable. |
The following table describes attributes for the cluster element.
Table 1–24 cluster Attributes
Attribute |
Default |
Description |
---|---|---|
none |
Specifies the name of the cluster. |
|
default config element’s name attribute value, server-config |
References the configuration used by the cluster. |
|
none; value automatically generated |
Specifies the communication port the Group Management Service uses to listen for group events. Must be a valid port number. |
|
none; value automatically generated |
Specifies the address the Group Management Service uses to listen for group events. Must be a multicast address. |
|
false (developer profile) true (cluster and enterprise profiles) |
(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. |
References a cluster.
Some topics in the documentation pertain to features that are available only in domains that are configured to support clusters. Examples of domains that support clusters are domains that are created with the cluster profile or the enterprise profile. For information about profiles, see Usage Profiles in Sun Java System Application Server 9.1 Administration Guide.
The following table describes subelements for the cluster-ref element.
Table 1–25 cluster-ref Subelements
Element |
Required |
Description |
---|---|---|
zero or one |
Defines a health checker for the referenced cluster. |
The following table describes attributes for the cluster-ref element.
Table 1–26 cluster-ref Attributes
Attribute |
Default |
Description |
---|---|---|
none |
References the name attribute of a cluster element. |
|
round-robin |
(optional) Specifies the load balancing policy. Allowed values are:
|
|
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. |
Contains clusters.
The following table describes subelements for the clusters element.
Table 1–27 clusters Subelements
Element |
Required |
Description |
---|---|---|
zero or more |
Defines a cluster. |
Defines a configuration, which is a collection of settings that controls how a server instance functions.
The following table describes subelements for the config element.
Table 1–28 config Subelements
Element |
Required |
Description |
---|---|---|
only one |
Configures the HTTP service. |
|
only one |
Configures the IIOP service. |
|
only one |
Determines whether the server to which the configuration applies is an administration server. |
|
zero or one |
Configures the connector service. |
|
only one |
Configures the web container. |
|
only one |
Configures the Enterprise JavaBeansTM (EJBTM) container. |
|
only one |
Configures the message-driven bean (MDB) container. |
|
zero or one |
Configures the Java Message Service (JMS) provider. |
|
only one |
Configures the system logging service. |
|
only one |
Configures the Java EE security service. |
|
only one |
Configures the transaction service. |
|
only one |
Configures the monitoring service. |
|
zero or one |
Configures the diagnostic service. |
|
only one |
Configures the Java Virtual Machine (JVMTM). |
|
zero or one |
Configures the availability service. |
|
only one |
Configures thread pools. |
|
zero or one |
Configures the alert service. |
|
zero or one |
Configures the group management service. |
|
zero or one |
Configures self-management rules. |
|
zero or more |
Specifies a system property. |
|
zero or more |
Specifies a property or a variable. |
The following table describes attributes for the config element.
Table 1–29 config Attributes
Attribute |
Default |
Description |
---|---|---|
server-config (for default instance) |
Specifies the name of the configuration. |
|
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. |
Contains configurations.
The following table describes subelements for the configs element.
Table 1–30 configs Subelements
Element |
Required |
Description |
---|---|---|
only one (developer profile) one or more (cluster and enterprise profiles) |
Defines a configuration. |
Defines a pool of client HTTP connections used by the http-listener subelements of the parent http-service element.
none
The following table describes attributes for the connection-pool element.
Table 1–31 connection-pool Attributes
Attribute |
Default |
Description |
---|---|---|
4096 |
(optional) Specifies the size in bytes of the connection queue for http-listener elements. |
|
4096 |
(optional) Specifies the maximum number of pending connections on an http-listener. |
|
4096 |
(optional) Specifies the size of the receive buffer for all http-listener elements. |
|
8092 |
(optional) Specifies the size of the send buffer for all http-listener elements. |
Defines a connector connection pool.
The following table describes subelements for the connector-connection-pool element.
Table 1–32 connector-connection-pool Subelements
Element |
Required |
Description |
---|---|---|
zero or one |
Contains a text description of this element. |
|
zero or more |
Maps the principal received during servlet or EJB authentication to the credentials accepted by the EIS. |
|
zero or more |
Specifies a property or a variable. |
The following table describes attributes for the connector-connection-pool element. Changing the following attributes requires a server restart: resource-adapter-name, connection-definition-name, transaction-support, associate-with-thread, lazy-connection-association, and lazy-connection-enlistment.
Table 1–33 connector-connection-pool Attributes
Attribute |
Default |
Description |
---|---|---|
none |
Specifies the name of the connection pool. A connector-resource element’s pool-name attribute refers to this 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. |
|
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. |
|
8 |
(optional) Specifies the initial and minimum number of connections maintained in the pool. |
|
32 |
(optional) Specifies the maximum number of connections that can be created to satisfy client requests. |
|
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. |
|
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. |
|
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. |
|
false |
(optional) If true, closes all connections in the pool if a single validation check fails. |
|
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:
|
|
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. |
|
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. |
|
false |
If true, the pool will reclaim a connection after connection-leak-timeout-in-seconds occurs. |
|
0 |
Specifies the number of attempts to create a new connection. |
|
10 |
Specifies the time interval between attempts to create a connection when connection-creation-retry-attempts is greater than 0. |
|
60 |
Specifies the time interval within which a connection is validated at most once. Minimizes the number of validation calls. |
|
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. |
|
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. |
|
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. |
|
true |
If true, enables connection matching. You can set to false if connections are homogeneous. |
|
0 |
Specifies the number of times a connections is reused by the pool, after which it is closed. A zero value disables this feature. |
Most properties of the connector-connection-pool element are the names of setter methods of the managedconnectionfactory-class element in the ra.xml file. Properties of the connector-connection-pool element override the ManagedConnectionFactory JavaBean configuration settings.
All but the last four properties in the following table are connector-connection-pool properties of jmsra, the resource adapter used to communicate with the Sun Java System Message Queue software. For a complete list of the available properties (called administered object attributes in the Message Queue software), see theSun Java System Message Queue 4.1 Administration Guide.
Changes to connector-connection-pool properties require a server restart.
Table 1–34 connector-connection-pool Properties
Property |
Default |
Description |
---|---|---|
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. |
|
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. |
|
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. |
|
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. |
false |
Deprecated. Use the equivalent attribute. |
|
false |
Deprecated. Use the equivalent attribute. |
|
false |
Deprecated. Use the equivalent attribute. |
|
true |
Deprecated. Use the equivalent attribute. |
All JMS administered object resource properties that worked with version 7 of the Application Server are supported for backward compatibility.
Specifies a deployed connector module.
The following table describes subelements for the connector-module element.
Table 1–35 connector-module Subelements
Element |
Required |
Description |
---|---|---|
zero or one |
Contains a text description of this element. |
|
zero or more |
Specifies a property or a variable. |
The following table describes attributes for the connector-module element.
Table 1–36 connector-module Attributes
Defines the connection factory object of a specific connection definition in a connector (resource adapter).
The following table describes subelements for the connector-resource element.
Table 1–37 connector-resource Subelements
Element |
Required |
Description |
---|---|---|
zero or one |
Contains a text description of this element. |
|
zero or more |
Specifies a property or a variable. |
The following table describes attributes for the connector-resource element.
Table 1–38 connector-resource Attributes
Attribute |
Default |
Description |
---|---|---|
none |
Specifies the JNDI name for the resource. |
|
none |
Specifies the name of the associated connector connection pool, defined in a connector-connection-pool element. |
|
user |
(optional) Defines the type of the resource. Allowed values are:
|
|
enabled |
true |
(optional) Determines whether this resource is enabled at runtime. |
Configures the connector service.
none
The following table describes attributes for the connector-service element.
Table 1–39 connector-service Attributes
Attribute |
Default |
Description |
---|---|---|
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 Application Server shutdown continues. |
Defines a custom resource, which specifies a custom server-wide resource object factory. Such object factories implement the javax.naming.spi.ObjectFactory interface.
The following table describes subelements for the custom-resource element.
Table 1–40 custom-resource Subelements
Element |
Required |
Description |
---|---|---|
zero or one |
Contains a text description of this element. |
|
zero or more |
Specifies a property or a variable. |
The following table describes attributes for the custom-resource element.
Table 1–41 custom-resource Attributes