connector-connection-pool
Defines a connector connection pool.
Superelements
resources (glassfish-resources.xml)
Subelements
The following table describes subelements for the connector-connection-pool element.
Table C-35 connector-connection-pool Subelements
|
|
|
|
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. |
|
Attributes
The following table describes attributes for the connector-connection-pool element. Changing the
following attributes requires a server restart or the redeployment or disabling and re-enabling
of applications that refer to the resource: resource-adapter-name, connection-definition-name, transaction-support, associate-with-thread, lazy-connection-association, and lazy-connection-enlistment.
Table C-36 connector-connection-pool Attributes
|
|
|
|
none |
Specifies
the name of the connection pool. A connector-resource element’s pool-name attribute refers
to this name. |
|
none |
Specifies the name of the deployed connector module
or application. 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. |
|
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:
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. |
validate-atmost-once-period-in-seconds |
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. |
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. |
|
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. |
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. |
|
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 associated thread pool. 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. |
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. |
|
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. |
|
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 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 GlassFish Server
Message Queue software. For a complete list of the available properties (called administered object attributes
in the Message Queue software), see the Oracle GlassFish Server Message Queue 4.5 Administration Guide.
Changes to connector-connection-pool properties require a server restart.
Table C-37 connector-connection-pool Properties
|
|
|
|
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. |
|
Note - All JMS administered object resource properties that worked with version 7 of the
GlassFish Server are supported for backward compatibility.