Sun Java System Application Server Enterprise Edition 8.1 2005Q2 Administration Reference

- Previous: B
- Next: D

# C

## cluster

Defines a cluster.

### Superelements

clusters

### Subelements

The following table describes subelements for the `cluster` element.

Table 1–21 `cluster` Subelements

Element | Required | Description
--- | --- | ---
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.

### Attributes

The following table describes attributes for the `cluster` element.

Table 1–22 `cluster` Attributes

Attribute | Default | Description
--- | --- | ---
`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.

## cluster-ref

References a cluster.

### Superelements

lb-config

### Subelements

The following table describes subelements for the `cluster-ref` element.

Table 1–23 `cluster-ref` Subelements

Element | Required | Description
--- | --- | ---
health-checker | zero or one | Defines a health checker for the referenced cluster.

### Attributes

The following table describes attributes for the `cluster-ref` element.

Table 1–24 `cluster-ref` Attributes

Attribute | Default | Description
--- | --- | ---
`ref` | none | References the `name` attribute of a cluster element.

## clusters

Contains clusters.

### Superelements

domain

### Subelements

The following table describes subelements for the `clusters` element.

Table 1–25 `clusters` Subelements

Element | Required | Description
--- | --- | ---
cluster | zero or more | Defines a cluster.

## config

Defines a configuration, which is a collection of settings that controls how a server instance functions.

### Superelements

configs

### Subelements

The following table describes subelements for the `config` element.

Table 1–26 `config` Subelements

Element | Required | Description
--- | --- | ---
http-service | only one | Configures the HTTP service.
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 JavaBeansTM (EJBTM) container.
mdb-container | only one | Configures the message-driven bean (MDB) 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 J2EE security service.
transaction-service | only one | Configures the transaction service.
monitoring-service | only one | Configures the monitoring service.
java-config | only one | Configures the Java Virtual Machine (JVMTM).
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.
system-property | zero or more | Specifies a system property.
property | zero or more | Specifies a property or a variable.

### Attributes

The following table describes attributes for the `config` element.

Table 1–27 `config` Attributes

Attribute | Default | Description
--- | --- | ---
`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.

## configs

Contains configurations.

### Superelements

domain

### Subelements

The following table describes subelements for the `configs` element.

Table 1–28 `configs` Subelements

Element | Required | Description
--- | --- | ---
config | one or more | Defines a configuration.

## connection-pool

Defines a pool of client HTTP connections.

### Superelements

http-service

### Subelements

none

### Attributes

The following table describes attributes for the `connection-pool` element.

Table 1–29 `connection-pool` Attributes

Attribute | Default | Description
--- | --- | ---
`queue-size-in-bytes` | `4096` | (optional) Specifies the number of outstanding connections an http-listener can have.
`max-pending-count` | `4096` | (optional) Specifies the maximum number of pending connections on an http-listener.
`receive-buffer-size-in-bytes` | `4096` | (optional) Specifies the size of the receive buffer for all http-listener elements.
`send-buffer-size-in-bytes` | `8092` | (optional) Specifies the size of the send buffer for all http-listener elements.

## connector-connection-pool

Defines a connector connection pool.

### Superelements

resources

### Subelements

The following table describes subelements for the `connector-connection-pool` element.

Table 1–30 `connector-connection-pool` Subelements

Element | Required | Description
--- | --- | ---
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.

### Attributes

The following table describes attributes for the `connector-connection-pool` element.

Table 1–31 `connector-connection-pool` Attributes

Attribute | Default | Description
--- | --- | ---
`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 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-time-out-in-seconds` interval. An idle connection is one that has not been used for a period of `idle-time-out-in-seconds` .
`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.

### Properties

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 this element override the `ManagedConnectionFactory` JavaBean configuration settings.

The following table describes the `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 Sun Java System Message Queue), see the Message Queue administration material.

Table 1–32 `connector-connection-pool` Properties

Property | Default | Description
--- | --- | ---
`AddressList` | none | Specifies a list of host/port combinations of the Sun Java System Message Queue. 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 Sun Java System Message Queue. For JMS resources of the Type `javax.jms.TopicConnectionFactory` or `javax.jms.QueueConnectionFactory`.
`Password` | `guest` | Specifies the password for connecting to the Sun Java System Message Queue. 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.

Note –

All JMS administered object resource properties that worked with version 7 of the Application Server are supported for backward compatibility.

## connector-module

Specifies a deployed connector module.

### Superelements

applications

### Subelements

The following table describes subelements for the `connector-module` element.

Table 1–33 `connector-module` Subelements

Element | Required | Description
--- | --- | ---
description | zero or one | Contains a text description of this element.

### Attributes

The following table describes attributes for the `connector-module` element.

Table 1–34 `connector-module` Attributes

Attribute | Default | Description
--- | --- | ---
`name` | name of the `.rar` file | The name of the connector module.
`location` | none | The location of the connector module in the Application 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 to a directory.

## connector-resource

Defines the connection factory object of a specific connection definition in a connector (resource adapter).

### Superelements

resources

### Subelements

The following table describes subelements for the `connector-resource` element.

Table 1–35 `connector-resource` Subelements

Element | Required | Description
--- | --- | ---
description | zero or one | Contains a text description of this element.
property | zero or more | Specifies a property or a variable.

### Attributes

The following table describes attributes for the `connector-resource` element.

Table 1–36 `connector-resource` Attributes

Attribute | Default | Description
--- | --- | ---
`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.

## connector-service

Configures the connector service.

### Superelements

config

### Subelements

none

### Attributes

The following table describes attributes for the `connector-service` element.

Table 1–37 `connector-service` Attributes

Attribute | Default | Description
--- | --- | ---
`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 Application Server shutdown continues.

## custom-resource

Defines a custom resource, which specifies a custom server-wide resource object factory. Such object factories implement the `javax.naming.spi.ObjectFactory` interface.

### Superelements

resources

### Subelements

The following table describes subelements for the `custom-resource` element.

Table 1–38 `custom-resource` Subelements

Element | Required | Description
--- | --- | ---
description | zero or one | Contains a text description of this element.
property | zero or more | Specifies a property or a variable.

### Attributes

The following table describes attributes for the `custom-resource` element.

Table 1–39 `custom-resource` Attributes

Attribute | Default | Description
--- | --- | ---
`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.

- Previous: B
- Next: D

- © 2010, Oracle Corporation and/or its affiliates