FileDocCategorySizeDatePackage
ConnectorConnectionPoolConfig.javaAPI DocGlassfish v2 API14638Fri May 04 22:30:32 BST 2007com.sun.appserv.management.config

ConnectorConnectionPoolConfig

public interface ConnectorConnectionPoolConfig implements com.sun.appserv.management.base.Container, Description, PropertiesAccess, ResourceRefConfigReferent, NamedConfigElement
Configuration for the <connector-connection-pool> element.

connector-connection-pool defines configuration used to create and manage a pool of connections to a EIS. Pool definition is named, and can be referred to by multiple connector-resource elements (See connector-resource).

Each named pool definition results in a pool instantiated at server start-up. Pool is populated when accessed for the first time. If two or more connector-resource elements point to the same connector-connection-pool element, they are using the same pool of connections, at run time.

There can be more than one pool for one connection-definition in one resource-adapter.

NOTE: some getters/setters use int/boolean. This will be corrected at a future time; these methods cannot use the AppServer template facility, whereby an Attribute value can be of the form attr-name=${ATTR_VALUE}. For an example of where/how this facility is used, see the <http-listener> element, which looks like this:

<http-listener id="http-listener-1" address="0.0.0.0" port="${HTTP_LISTENER_PORT}" acceptor-threads="1" security-enabled="false" default-virtual server="server" server-name="" xpowered-by="true" enabled="true">
The 'port' attribute above is set to the value "${HTTP_LISTENER_PORT}", which is a system property. Obviously no method that uses 'boolean' could get or set a String.

Fields Summary
public static final String
J2EE_TYPE
The j2eeType as returned by {@link com.sun.appserv.management.base.AMX#getJ2EEType}.
Constructors Summary
Methods Summary
public SecurityMapConfigcreateSecurityMapConfig(java.lang.String name, java.lang.String backendPrincipalUsername, java.lang.String backendPrincipalPassword, java.lang.String[] principals, java.lang.String[] userGroups)
At least one of 'principals' and 'userGroups' must be non-null.

public java.lang.StringgetAssociateWithThread()
associate-with-thread (boolean)
Associate a connection with the thread such that when the same thread is in need of a connection, it can reuse the connection already associated with that thread, thereby not incurring the overhead of getting a connection from the pool. Default value is false.

since
AppServer 9.1

public java.lang.StringgetConnectionCreationRetryAttempts()
connection-creation-retry-attempts (integer)
The number of attempts to create a new connection. Default is 0, which implies no retries.

since
AppServer 9.1

public java.lang.StringgetConnectionCreationRetryIntervalInSeconds()
connection-creation-retry-interval-in-seconds (integer)
The time interval between retries while attempting to create a connection Default is 10 seconds. Effective when connection-creation-retry-attempts is greater than 0.

since
AppServer 9.1

public java.lang.StringgetConnectionDefinitionName()
Unique name, identifying one connection-definition in a Resource Adapter. Currently this is ConnectionFactory type.

public java.lang.StringgetConnectionLeakReclaim()
connection-leak-reclaim (boolean)
If enabled, connection will be re-usable (put back to pool) after connection-leak-timeout-in-seconds occurs. Default value is false.

since
AppServer 9.1

public java.lang.StringgetConnectionLeakTimeoutInSeconds()
connection-leak-timeout-in-seconds (integer)
To aid user in detecting potential connection leaks by the application. When a connection is not returned back to the pool by the application within the specified period, it is assumed to be a potential leak and stack trace of the caller will be logged. Default is 0 seconds, which implies there is no leak detection, by default. A non-zero value turns on leak tracing.

since
AppServer 9.1

public booleangetConnectionValidationRequired()
Specifies if the connection that is about to be returned is to be validated by the container.

public booleangetFailAllConnections()
Indicates if all connections in the pool must be closed should a single connection fail validation. The default is false. One attempt will be made to re-establish failed connections.

public java.lang.StringgetIdleTimeoutInSeconds()
Maximum time in seconds, that a connection can remain idle in the pool. After this time, the pool implementation can close this connection. Note that this does not control connection timeouts enforced at the database server side. Adminsitrators are advised to keep this timeout shorter than the EIS connection timeout (if such timeouts are configured on the specific EIS), to prevent accumulation of unusable connection in Application Server.

public java.lang.StringgetLazyConnectionAssociation()
lazy-connection-association (boolean)
Connections are lazily associated when an operation is performed on them. Also they are disassociated when the transaction is completed and a component method ends, which helps to reuse the physical connections. Default value is false.

since
AppServer 9.1

public java.lang.StringgetLazyConnectionEnlistment()
lazy-connection-enlistment (boolean)
Enlist a resource to the transaction only when it is actually used in a method, which avoids enlistment of connections, that are not used, in a transaction. This also prevents unnecessary enlistment of connections cached in the calling components. Default value is false.

since
AppServer 9.1

public java.lang.StringgetMatchConnections()
match-connections (boolean)
To switch on/off connection matching for the pool. It can be set to false if the administrator knows that the connections in the pool will always be homogeneous and hence a connection picked from the pool need not be matched by the resource adapter. Default value is true.

since
AppServer 9.1

public java.lang.StringgetMaxConnectionUsageCount()
max-connection-usage-count
When specified, connections will be re-used by the pool for the specified number of times after which it will be closed. eg : To avoid statement-leaks. Default value is 0, which implies the feature is not enabled.

since
AppServer 9.1

public java.lang.StringgetMaxPoolSize()
Maximum number of conections that can be created.

public java.lang.StringgetMaxWaitTimeInMillis()
Amount of time the caller will wait before getting a connection timeout. The default is 60 seconds. A value of 0 will force caller to wait indefinitely.

public java.lang.StringgetPoolResizeQuantity()
Number of connections to be removed when idle-timeout-in-seconds timer expires. Connections that have idled for longer than the timeout are candidates for removal. When the pool size reaches steady-pool-size, the connection removal stops.

public java.lang.StringgetResourceAdapterName()
Name of resource adapter. Name of .rar file is taken as the unique name for the resource adapter.

public java.util.MapgetSecurityMapConfigMap()

return
Map of all SecurityMapConfig contained in this item.

public java.lang.StringgetSteadyPoolSize()
Minimum and initial number of connections maintained in the pool.

public java.lang.StringgetTransactionSupport()
Indicates the level of transaction support that this pool will have. Possible values are "XATransaction", "LocalTransaction" and "NoTransaction". This attribute will override that transaction support attribute in the Resource Adapter in a downward compatible way, i.e it can support a lower/equal transaction level than specified in the RA, but not a higher level.

see
TransactionSupportValues

public java.lang.StringgetValidateAtMostOncePeriodInSeconds()
validate-atmost-once-period-in-seconds (integer)
Used to set the time-interval within which a connection is validated atmost once. Default is 0 seconds, not enabled.

since
AppServer 9.1

public voidremoveSecurityMapConfig(java.lang.String name)
Remove the specified SecurityMapConfig.

public voidsetAssociateWithThread(java.lang.String associate)

see
#getAssociateWithThread
since
AppServer 9.1

public voidsetConnectionCreationRetryAttempts(java.lang.String count)

see
#getConnectionCreationRetryAttempts
since
AppServer 9.1

public voidsetConnectionCreationRetryIntervalInSeconds(java.lang.String seconds)

see
#getConnectionCreationRetryIntervalInSeconds
since
AppServer 9.1

public voidsetConnectionDefinitionName(java.lang.String value)
See {@link #getConnectionDefinitionName}.

public voidsetConnectionLeakReclaim(java.lang.String reclaim)

see
#getConnectionLeakReclaim
since
AppServer 9.1

public voidsetConnectionLeakTimeoutInSeconds(java.lang.String timeout)

see
#getConnectionLeakTimeoutInSeconds
since
AppServer 9.1

public voidsetConnectionValidationRequired(boolean required)
See {@link #getConnectionValidationRequired}.

public voidsetFailAllConnections(boolean value)
See {@link #getFailAllConnections}.

public voidsetIdleTimeoutInSeconds(java.lang.String value)
See {@link #getIdleTimeoutInSeconds}.

public voidsetLazyConnectionAssociation(java.lang.String associate)

see
#getLazyConnectionAssociation
since
AppServer 9.1

public voidsetLazyConnectionEnlistment(java.lang.String enlist)

see
#getLazyConnectionEnlistment
since
AppServer 9.1

public voidsetMatchConnections(java.lang.String match)

see
#getMatchConnections
since
AppServer 9.1

public voidsetMaxConnectionUsageCount(java.lang.String count)

see
#getMaxConnectionUsageCount
since
AppServer 9.1

public voidsetMaxPoolSize(java.lang.String value)
See {@link #getMaxPoolSize}.

public voidsetMaxWaitTimeInMillis(java.lang.String value)
See {@link #getMaxWaitTimeInMillis}.

public voidsetPoolResizeQuantity(java.lang.String value)
See {@link #getPoolResizeQuantity}.

public voidsetResourceAdapterName(java.lang.String value)
See {@link #getResourceAdapterName}.

public voidsetSteadyPoolSize(java.lang.String value)
See {@link #getSteadyPoolSize}.

public voidsetTransactionSupport(java.lang.String value)
See {@link #getTransactionSupport}.

public voidsetValidateAtMostOncePeriodInSeconds(java.lang.String seconds)

see
#getValidateAtMostOncePeriodInSeconds
since
AppServer 9.1