ConnectorConnectionPool (Connectors Private APIs for GlassFish Containers 4.0 API)

All Superinterfaces:

org.jvnet.hk2.config.ConfigBeanProxy, javax.validation.Payload, org.jvnet.hk2.config.types.PropertyBag, com.sun.enterprise.config.serverbeans.Resource, com.sun.enterprise.config.serverbeans.ResourcePool
```
@ResourceTypeOrder(deploymentOrder=CONNECTOR_POOL)
@UniqueResourceNameConstraint(message="{resourcename.isnot.unique}",
                              payload=ConnectorConnectionPool.class)
public interface ConnectorConnectionPool
extends org.jvnet.hk2.config.ConfigBeanProxy, com.sun.enterprise.config.serverbeans.Resource, com.sun.enterprise.config.serverbeans.ResourcePool, org.jvnet.hk2.config.types.PropertyBag
```
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

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class ConnectorConnectionPool.Duck

Nested Classes
Modifier and Type	Interface and Description
`static class`	`ConnectorConnectionPool.Duck`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getAssociateWithThread()` Gets the value of the associateWithThread property.
`String`	`getConnectionCreationRetryAttempts()` Gets the value of the connectionCreationRetryAttempts property.
`String`	`getConnectionCreationRetryIntervalInSeconds()` Gets the value of the connectionCreationRetryIntervalInSeconds property.
`String`	`getConnectionDefinitionName()` Gets the value of the connectionDefinitionName property.
`String`	`getConnectionLeakReclaim()` Gets the value of the connectionLeakReclaim property.
`String`	`getConnectionLeakTimeoutInSeconds()` Gets the value of the connectionLeakTimeoutInSeconds property.
`String`	`getDescription()` Gets the value of the description property.
`String`	`getFailAllConnections()` Gets the value of the failAllConnections property.
`String`	`getIdentity()`
`String`	`getIdleTimeoutInSeconds()` Gets the value of the idleTimeoutInSeconds property.
`String`	`getIsConnectionValidationRequired()` Gets the value of the isConnectionValidationRequired property.
`String`	`getLazyConnectionAssociation()` Gets the value of the lazyConnectionAssociation property.
`String`	`getLazyConnectionEnlistment()` Gets the value of the lazyConnectionEnlistment property.
`String`	`getMatchConnections()` Gets the value of the matchConnections property.
`String`	`getMaxConnectionUsageCount()` Gets the value of the maxConnectionUsageCount property.
`String`	`getMaxPoolSize()` Gets the value of the maxPoolSize property.
`String`	`getMaxWaitTimeInMillis()` Gets the value of the maxWaitTimeInMillis property.
`String`	`getPooling()` Gets the value of the pooling property.
`String`	`getPoolResizeQuantity()` Gets the value of the poolResizeQuantity property.
`List<org.jvnet.hk2.config.types.Property>`	`getProperty()` Properties as per `PropertyBag` Properties are used to override the ManagedConnectionFactory javabean configuration settings.
`String`	`getResourceAdapterName()` Gets the value of the resourceAdapterName property.
`List<SecurityMap>`	`getSecurityMap()` Gets the value of the securityMap property.
`String`	`getSteadyPoolSize()` Gets the value of the steadyPoolSize property.
`String`	`getTransactionSupport()` Gets the value of the transactionSupport property.
`String`	`getValidateAtmostOncePeriodInSeconds()` Gets the value of the validateAtmostOncePeriodInSeconds property.
`void`	`setAssociateWithThread(String value)` Sets the value of the associateWithThread property.
`void`	`setConnectionCreationRetryAttempts(String value)` Sets the value of the connectionCreationRetryAttempts property.
`void`	`setConnectionCreationRetryIntervalInSeconds(String value)` Sets the value of the connectionCreationRetryIntervalInSeconds property.
`void`	`setConnectionDefinitionName(String value)` Sets the value of the connectionDefinitionName property.
`void`	`setConnectionLeakReclaim(String value)` Sets the value of the connectionLeakReclaim property.
`void`	`setConnectionLeakTimeoutInSeconds(String value)` Sets the value of the connectionLeakTimeoutInSeconds property.
`void`	`setDescription(String value)` Sets the value of the description property.
`void`	`setFailAllConnections(String value)` Sets the value of the failAllConnections property.
`void`	`setIdleTimeoutInSeconds(String value)` Sets the value of the idleTimeoutInSeconds property.
`void`	`setIsConnectionValidationRequired(String value)` Sets the value of the isConnectionValidationRequired property.
`void`	`setLazyConnectionAssociation(String value)` Sets the value of the lazyConnectionAssociation property.
`void`	`setLazyConnectionEnlistment(String value)` Sets the value of the lazyConnectionEnlistment property.
`void`	`setMatchConnections(String value)` Sets the value of the matchConnections property.
`void`	`setMaxConnectionUsageCount(String value)` Sets the value of the maxConnectionUsageCount property.
`void`	`setMaxPoolSize(String value)` Sets the value of the maxPoolSize property.
`void`	`setMaxWaitTimeInMillis(String value)` Sets the value of the maxWaitTimeInMillis property.
`void`	`setPooling(String value)` Sets the value of the pooling property.
`void`	`setPoolResizeQuantity(String value)` Sets the value of the poolResizeQuantity property.
`void`	`setResourceAdapterName(String value)` Sets the value of the resourceAdapterName property.
`void`	`setSteadyPoolSize(String value)` Sets the value of the steadyPoolSize property.
`void`	`setTransactionSupport(String value)` Sets the value of the transactionSupport property.
`void`	`setValidateAtmostOncePeriodInSeconds(String value)` Sets the value of the validateAtmostOncePeriodInSeconds property.

Methods inherited from interface com.sun.enterprise.config.serverbeans.ResourcePool
getName, getPing, setName, setPing

Methods inherited from interface com.sun.enterprise.config.serverbeans.Resource
getDeploymentOrder, getObjectType, setDeploymentOrder, setObjectType

Methods inherited from interface org.jvnet.hk2.config.ConfigBeanProxy
createChild, deepCopy, getParent, getParent

Methods inherited from interface org.jvnet.hk2.config.types.PropertyBag
getProperty, getPropertyValue, getPropertyValue

- Method Detail
  - getResourceAdapterName
```
@NotNull
String getResourceAdapterName()
```
    Gets the value of the resourceAdapterName property. This is the name of resource adapter. Name of .rar file is taken as the unique name for the resource adapter.
    
    Parameters:
    value - allowed object is String
  - setResourceAdapterName
```
void setResourceAdapterName(String value)
                            throws PropertyVetoException
```
    Sets the value of the resourceAdapterName property.
    
    Parameters:
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getConnectionDefinitionName
```
@NotNull
String getConnectionDefinitionName()
```
    Gets the value of the connectionDefinitionName property. Unique name, identifying one connection-definition in a Resource Adapter. Currently this is ConnectionFactory type.
    
    Returns:
    possible object is String
  - setConnectionDefinitionName
```
void setConnectionDefinitionName(String value)
                                 throws PropertyVetoException
```
    Sets the value of the connectionDefinitionName property.
    
    Parameters:
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getSteadyPoolSize
```
@Min(value=0L)
String getSteadyPoolSize()
```
    Gets the value of the steadyPoolSize property. Minimum and initial number of connections maintained in the pool
    
    Returns:
    possible object is String
  - setSteadyPoolSize
```
void setSteadyPoolSize(String value)
                       throws PropertyVetoException
```
    Sets the value of the steadyPoolSize property.
    
    Parameters:
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getMaxPoolSize
```
@Min(value=1L)
String getMaxPoolSize()
```
    Gets the value of the maxPoolSize property. Maximum number of conections that can be created
    
    Returns:
    possible object is String
  - setMaxPoolSize
```
void setMaxPoolSize(String value)
                    throws PropertyVetoException
```
    Sets the value of the maxPoolSize property.
    
    Parameters:
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getMaxWaitTimeInMillis
```
@Min(value=0L)
String getMaxWaitTimeInMillis()
```
    Gets the value of the maxWaitTimeInMillis property. 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.
    
    Returns:
    possible object is String
  - setMaxWaitTimeInMillis
```
void setMaxWaitTimeInMillis(String value)
                            throws PropertyVetoException
```
    Sets the value of the maxWaitTimeInMillis property.
    
    Parameters:
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getPoolResizeQuantity
```
@Min(value=1L)
String getPoolResizeQuantity()
```
    Gets the value of the poolResizeQuantity property. 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.
    
    Returns:
    possible object is String
  - setPoolResizeQuantity
```
void setPoolResizeQuantity(String value)
                           throws PropertyVetoException
```
    Sets the value of the poolResizeQuantity property.
    
    Parameters:
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getIdleTimeoutInSeconds
```
@Min(value=1L)
@Max(value=2147483647L)
String getIdleTimeoutInSeconds()
```
    Gets the value of the idleTimeoutInSeconds property. 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.
    
    Returns:
    possible object is String
  - setIdleTimeoutInSeconds
```
void setIdleTimeoutInSeconds(String value)
                             throws PropertyVetoException
```
    Sets the value of the idleTimeoutInSeconds property.
    
    Parameters:
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getFailAllConnections
```
String getFailAllConnections()
```
    Gets the value of the failAllConnections property. 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.
    
    Returns:
    possible object is String
  - setFailAllConnections
```
void setFailAllConnections(String value)
                           throws PropertyVetoException
```
    Sets the value of the failAllConnections property.
    
    Parameters:
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getTransactionSupport
```
String getTransactionSupport()
```
    Gets the value of the transactionSupport property. Indicates the level of transaction support that this pool will have. Possible values are "XATransaction", "LocalTransaction" & "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 or equal transaction level than specified in the RA, but not higher level
    
    Returns:
    possible object is String
  - setTransactionSupport
```
void setTransactionSupport(String value)
                           throws PropertyVetoException
```
    Sets the value of the transactionSupport property.
    
    Parameters:
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getIsConnectionValidationRequired
```
String getIsConnectionValidationRequired()
```
    Gets the value of the isConnectionValidationRequired property. This attribute specifies if the connection that is about to be returned is to be validated by the container,
    
    Returns:
    possible object is String
  - setIsConnectionValidationRequired
```
void setIsConnectionValidationRequired(String value)
                                       throws PropertyVetoException
```
    Sets the value of the isConnectionValidationRequired property.
    
    Parameters:
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getValidateAtmostOncePeriodInSeconds
```
@Min(value=0L)
String getValidateAtmostOncePeriodInSeconds()
```
    Gets the value of the validateAtmostOncePeriodInSeconds property. Used to set the time-interval within which a connection is validated atmost once. Default is 0 which implies that it is not enabled.
    
    Returns:
    possible object is String
  - setValidateAtmostOncePeriodInSeconds
```
void setValidateAtmostOncePeriodInSeconds(String value)
                                          throws PropertyVetoException
```
    Sets the value of the validateAtmostOncePeriodInSeconds property.
    
    Parameters:
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getConnectionLeakTimeoutInSeconds
```
@Min(value=0L)
String getConnectionLeakTimeoutInSeconds()
```
    Gets the value of the connectionLeakTimeoutInSeconds property. 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, which implies there is no leak detection, by default. A positive non-zero value turns on leak detection. Note however that, this attribute only detects if there is a connection leak. The connection can be reclaimed only if connection-leak-reclaim is set to true.
    
    Returns:
    possible object is String
  - setConnectionLeakTimeoutInSeconds
```
void setConnectionLeakTimeoutInSeconds(String value)
                                       throws PropertyVetoException
```
    Sets the value of the connectionLeakTimeoutInSeconds property.
    
    Parameters:
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getConnectionLeakReclaim
```
String getConnectionLeakReclaim()
```
    Gets the value of the connectionLeakReclaim property. If enabled, connection will be reusable (put back into pool) after connection-leak-timeout-in-seconds occurs.
    
    Returns:
    possible object is String
  - setConnectionLeakReclaim
```
void setConnectionLeakReclaim(String value)
                              throws PropertyVetoException
```
    Sets the value of the connectionLeakReclaim property.
    
    Parameters:
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getConnectionCreationRetryAttempts
```
String getConnectionCreationRetryAttempts()
```
    Gets the value of the connectionCreationRetryAttempts property. The number of attempts to create a new connection. Default is 0, which implies no retries.
    
    Returns:
    possible object is String
  - setConnectionCreationRetryAttempts
```
void setConnectionCreationRetryAttempts(String value)
                                        throws PropertyVetoException
```
    Sets the value of the connectionCreationRetryAttempts property.
    
    Parameters:
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getConnectionCreationRetryIntervalInSeconds
```
String getConnectionCreationRetryIntervalInSeconds()
```
    Gets the value of the connectionCreationRetryIntervalInSeconds property. 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.
    
    Returns:
    possible object is String
  - setConnectionCreationRetryIntervalInSeconds
```
void setConnectionCreationRetryIntervalInSeconds(String value)
                                                 throws PropertyVetoException
```
    Sets the value of the connectionCreationRetryIntervalInSeconds property.
    
    Parameters:
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getLazyConnectionEnlistment
```
String getLazyConnectionEnlistment()
```
    Gets the value of the lazyConnectionEnlistment property. 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.
    
    Returns:
    possible object is String
  - setLazyConnectionEnlistment
```
void setLazyConnectionEnlistment(String value)
                                 throws PropertyVetoException
```
    Sets the value of the lazyConnectionEnlistment property.
    
    Parameters:
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getLazyConnectionAssociation
```
String getLazyConnectionAssociation()
```
    Gets the value of the lazyConnectionAssociation property. 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 reuse of the physical connections. Default value is false.
    
    Returns:
    possible object is String
  - setLazyConnectionAssociation
```
void setLazyConnectionAssociation(String value)
                                  throws PropertyVetoException
```
    Sets the value of the lazyConnectionAssociation property.
    
    Parameters:
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getAssociateWithThread
```
String getAssociateWithThread()
```
    Gets the value of the associateWithThread property. 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.
    
    Returns:
    possible object is String
  - setAssociateWithThread
```
void setAssociateWithThread(String value)
                            throws PropertyVetoException
```
    Sets the value of the associateWithThread property.
    
    Parameters:
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getPooling
```
String getPooling()
```
    Gets the value of the pooling property. Property to disable pooling for the pool.
    
    Returns:
    possible object is String
  - setPooling
```
void setPooling(String value)
                throws PropertyVetoException
```
    Sets the value of the pooling property.
    
    Parameters:
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getMatchConnections
```
String getMatchConnections()
```
    Gets the value of the matchConnections property. 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.
    
    Returns:
    possible object is String
  - setMatchConnections
```
void setMatchConnections(String value)
                         throws PropertyVetoException
```
    Sets the value of the matchConnections property.
    
    Parameters:
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getMaxConnectionUsageCount
```
@Min(value=0L)
@Max(value=2147483647L)
String getMaxConnectionUsageCount()
```
    Gets the value of the maxConnectionUsageCount property. When specified, connections will be re-used by the pool for the specified number of times after which it will be closed. This is useful for instance, to avoid statement-leaks. Default value is 0, which implies the feature is not enabled.
    
    Returns:
    possible object is String
  - setMaxConnectionUsageCount
```
void setMaxConnectionUsageCount(String value)
                                throws PropertyVetoException
```
    Sets the value of the maxConnectionUsageCount property.
    
    Parameters:
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getDescription
```
String getDescription()
```
    Gets the value of the description property.
    
    Returns:
    possible object is String
  - setDescription
```
void setDescription(String value)
                    throws PropertyVetoException
```
    Sets the value of the description property.
    
    Parameters:
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getSecurityMap
```
@NotNull
List<SecurityMap> getSecurityMap()
```
    Gets the value of the securityMap property.
    
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the securityMap property.
    
    For example, to add a new item, do as follows:
```
    getSecurityMap().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list SecurityMap
  - getProperty
```
@ToDo(priority=IMPORTANT,
      details="Provide PropertyDesc for legal props")
@PropertiesDesc(props={})
List<org.jvnet.hk2.config.types.Property> getProperty()
```
    Properties as per PropertyBag Properties are used to override the ManagedConnectionFactory javabean configuration settings. When one or more of these properties are specified, they are passed as is using set() methods to the Resource Adapter's ManagedConnectionfactory class (specified in ra.xml).
    
    Specified by:
    
    getProperty in interface org.jvnet.hk2.config.types.PropertyBag
  - getIdentity
```
@DuckTyped
String getIdentity()
```
    Specified by:
    
    getIdentity in interface com.sun.enterprise.config.serverbeans.Resource
    
    Specified by:
    
    getIdentity in interface com.sun.enterprise.config.serverbeans.ResourcePool

Interface ConnectorConnectionPool

Nested Class Summary

Method Summary

Methods inherited from interface com.sun.enterprise.config.serverbeans.ResourcePool

Methods inherited from interface com.sun.enterprise.config.serverbeans.Resource

Methods inherited from interface org.jvnet.hk2.config.ConfigBeanProxy

Methods inherited from interface org.jvnet.hk2.config.types.PropertyBag

Method Detail

getResourceAdapterName

setResourceAdapterName

getConnectionDefinitionName

setConnectionDefinitionName

getSteadyPoolSize

setSteadyPoolSize

getMaxPoolSize

setMaxPoolSize

getMaxWaitTimeInMillis

setMaxWaitTimeInMillis

getPoolResizeQuantity

setPoolResizeQuantity

getIdleTimeoutInSeconds

setIdleTimeoutInSeconds

getFailAllConnections

setFailAllConnections

getTransactionSupport

setTransactionSupport

getIsConnectionValidationRequired

setIsConnectionValidationRequired

getValidateAtmostOncePeriodInSeconds

setValidateAtmostOncePeriodInSeconds

getConnectionLeakTimeoutInSeconds

setConnectionLeakTimeoutInSeconds

getConnectionLeakReclaim

setConnectionLeakReclaim

getConnectionCreationRetryAttempts

setConnectionCreationRetryAttempts

getConnectionCreationRetryIntervalInSeconds

setConnectionCreationRetryIntervalInSeconds

getLazyConnectionEnlistment

setLazyConnectionEnlistment

getLazyConnectionAssociation

setLazyConnectionAssociation

getAssociateWithThread

setAssociateWithThread

getPooling

setPooling

getMatchConnections

setMatchConnections

getMaxConnectionUsageCount

setMaxConnectionUsageCount

getDescription

setDescription

getSecurityMap

getProperty

getIdentity