Sun Java System Application Server Platform Edition 9 Administration Reference

C

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–20 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 JavaBeans^TM (EJB^TM) 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 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).
thread-pools	only one	Configures thread pools.
alert-service	zero or one	Configures the alert 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.

Attributes

The following table describes attributes for the config element.

Table 1–21 config Attributes


Attribute	Default	Description
`name`	`server-config`	Specifies the name of the configuration. For the Platform Edition, the default is the only value allowed.
`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. In the Platform Edition, there is only one configuration.

Superelements

domain

Subelements

The following table describes subelements for the configs element.

Table 1–22 configs Subelements


Element	Required	Description
config	only one	Defines a configuration.

connection-pool

Defines a pool of client HTTP connections used by the http-listener subelements of the parent http-service element.

Superelements

http-service

Subelements

none

Attributes

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

Table 1–23 connection-pool Attributes


Attribute	Default	Description
`queue-size-in-bytes`	`4096`	(optional) Specifies the size in bytes of the connection queue for http-listener elements.
`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–24 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–25 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 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.

Properties

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 this 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 3.7 UR1 Administration Guide.

Table 1–26 connector-connection-pool Properties


Property	Default	Description
`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`	`true`	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.
`LazyConnectionAssociation`	`true`	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.
`AssociateWithThread`	`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.
`MatchConnections`	`true`	If `true`, enables connection matching. You can set to `false` if connections are homogeneous.

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–27 connector-module 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-module element.

Table 1–28 connector-module Attributes


Attribute	Default	Description
`name`	`.rar` file name	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–29 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–30 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–31 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–32 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–33 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.