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–20 config Subelements
Element |
Required |
Description |
---|---|---|
only one |
Configures the HTTP service. |
|
only one |
Configures the communication network for the Enterprise Server. |
|
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 JavaTM 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. |
|
only one |
Configures the Virtual Machine for the Java platform (JVMTM software). |
|
only one |
Configures thread pools. |
|
zero or more |
Specifies a system property. |
|
zero or more |
Specifies a property or a variable. |
|
zero or one |
Configures the JRuby container. |
The following table describes attributes for the config element.
Table 1–21 config Attributes
Attribute |
Default |
Description |
---|---|---|
server-config |
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–22 configs Subelements
Element |
Required |
Description |
---|---|---|
only one |
Defines a configuration. |
This element is not supported. If this element is present in the domain.xml file, its attributes are remapped to other elements and then it is deleted. For remapping details, see the Attributes table for this element.
none
The following table describes attributes for the connection-pool element.
Table 1–23 connection-pool Attributes
Attribute |
Default |
Description |
---|---|---|
4096 |
Remapped to the max-queue-size attribute of the thread-pool element. |
|
4096 |
Remapped to the max-connections-count attribute of the transport element. |
|
4096 |
Remapped to the request-body-buffer-size-bytes attribute of the http element. |
|
8192 |
Remapped to the send-buffer-size-bytes attribute of the http element. |
Defines a connector connection pool.
The following table describes subelements for the connector-connection-pool element.
Table 1–24 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. In addition, when you change a connector-connection-pool configuration, you should also redeploy or disable and re-enable the referring modules and applications.
Table 1–25 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 application element. 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 |
Specifies the time interval within which a connection is validated at most once. Minimizes the number of validation calls. A value of zero allows unlimited validation calls. |
|
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. |
|
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 connections to be saved as ThreadLocal in the calling thread. Connections get reclaimed only when the calling thread dies or when the calling thread is not in use and the pool has run out of connections. If false, the thread must obtain a connection from the pool each time the thread requires a connection. This attribute associates connections with a thread such that when the same thread is in need of connections, it can reuse the connections already associated with that thread. In this case, the overhead of getting connections from the pool is avoided. However, when this value is set to true, you should verify that the value of the max-pool-size attribute is comparable to the max-thread-pool-size attribute of the thread-pool element. If the max-thread-pool-size value is much higher than the max-pool-size value, a lot of time is spent associating connections with a new thread after dissociating them from an older one. Use this attribute in cases where the thread pool should reuse connections to avoid this overhead. |
|
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. By limiting the maximum number of times a connection can be reused, you can avoid statement leaks if the application does not close statements. |
|
false |
(optional) Specifies whether to ping the pool during pool creation or reconfiguration to identify and warn of any erroneous attribute values. |
|
true |
(optional) If false, disables connection pooling. |
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 GlassFish Message Queue software. For a complete list of the available properties (called administered object attributes in the Message Queue software), see the Sun GlassFish Message Queue 4.4 Administration Guide.
Changes to connector-connection-pool properties require a server restart.
Table 1–26 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 |
Specifies that validating idle connections is preferable to closing them. This property has no effect on non-idle connections. If set to true, idle connections are validated during pool resizing, and only those found to be invalid are destroyed and recreated. If false, all idle connections are destroyed and recreated during pool resizing. |
|
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 Enterprise Server are supported for backward compatibility.
This element is deprecated. Use an application element instead.
Specifies a deployed connector module.
The following table describes subelements for the connector-module element.
Table 1–27 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–28 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–29 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–30 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–31 connector-service Attributes
Configures a context parameter for a web module at deployment time. This is an alternative to setting a context-param in the web.xml file. To override a context-param in the web.xml file, set the ignore-descriptor-item attribute to true.
The following table describes subelements for the context-param element.
Table 1–32 context-param Subelements
Element |
Required |
Description |
---|---|---|
only one |
Contains a context parameter name. |
|
only one |
Contains a context parameter value. |
|
zero or one |
Contains a text description of this element. |
The following table describes attributes for the context-param element.
Table 1–33 context-param Attributes
Attribute |
Default |
Description |
---|---|---|
false |
(optional) If true, specifies that if the same context parameter occurs in the deployment descriptor it is ignored. |
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–34 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–35 custom-resource Attributes