com.sun.appserv.management.config
Interface ConnectorConnectionPoolConfig

All Superinterfaces:

AMX, AMXConfig, AMXMBeanLogging, ConfigElement, Container, Description, NamedConfigElement, NotificationBroadcaster, NotificationEmitter, PropertiesAccess, RefConfigReferent, ResourceRefConfigReferent

public interface ConnectorConnectionPoolConfig
extends NamedConfigElement, Description, PropertiesAccess, Container, ResourceRefConfigReferent

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.

Field Summary

static String

J2EE_TYPE The j2eeType as returned by AMX.getJ2EEType().

Fields inherited from interface com.sun.appserv.management.config.AMXConfig

CONFIG_CREATED_NOTIFICATION_TYPE, CONFIG_OBJECT_NAME_KEY, CONFIG_REMOVED_NOTIFICATION_TYPE

Fields inherited from interface com.sun.appserv.management.base.AMX

FULL_TYPE_DELIM, GROUP_CONFIGURATION, GROUP_JSR77, GROUP_MONITORING, GROUP_OTHER, GROUP_UTILITY, J2EE_TYPE_KEY, JMX_DOMAIN, NAME_KEY, NO_NAME, NOTIFICATION_PREFIX, NULL_NAME

Fields inherited from interface com.sun.appserv.management.config.Description

DESCRIPTION_KEY

Fields inherited from interface com.sun.appserv.management.config.PropertiesAccess

PROPERTY_PREFIX

Fields inherited from interface com.sun.appserv.management.base.Container

ATTR_CONTAINEE_J2EE_TYPES

Method Summary

SecurityMapConfig	createSecurityMapConfig(String name, String backendPrincipalUsername, String backendPrincipalPassword, String[] principals, String[] userGroups) At least one of 'principals' and 'userGroups' must be non-null.
String	getConnectionDefinitionName() Unique name, identifying one connection-definition in a Resource Adapter.
boolean	getConnectionValidationRequired() Specifies if the connection that is about to be returned is to be validated by the container.
boolean	getFailAllConnections() Indicates if all connections in the pool must be closed should a single connection fail validation.
String	getIdleTimeoutInSeconds() Maximum time in seconds, that a connection can remain idle in the pool.
String	getMaxPoolSize() Maximum number of conections that can be created.
String	getMaxWaitTimeInMillis() Amount of time the caller will wait before getting a connection timeout.
String	getPoolResizeQuantity() Number of connections to be removed when idle-timeout-in-seconds timer expires.
String	getResourceAdapterName() Name of resource adapter.
Map<String,SecurityMapConfig>	getSecurityMapConfigMap()
String	getSteadyPoolSize() Minimum and initial number of connections maintained in the pool.
String	getTransactionSupport() Indicates the level of transaction support that this pool will have.
void	removeSecurityMapConfig(String name) Remove the specified SecurityMapConfig.
void	setConnectionDefinitionName(String value) See getConnectionDefinitionName().
void	setConnectionValidationRequired(boolean required) See getConnectionValidationRequired().
void	setFailAllConnections(boolean value) See getFailAllConnections().
void	setIdleTimeoutInSeconds(String value) See getIdleTimeoutInSeconds().
void	setMaxPoolSize(String value) See getMaxPoolSize().
void	setMaxWaitTimeInMillis(String value) See getMaxWaitTimeInMillis().
void	setPoolResizeQuantity(String value) See getPoolResizeQuantity().
void	setResourceAdapterName(String value) See getResourceAdapterName().
void	setSteadyPoolSize(String value) See getSteadyPoolSize().
void	setTransactionSupport(String value) See getTransactionSupport().

Methods inherited from interface com.sun.appserv.management.base.AMX

getContainer, getDomainRoot, getFullType, getGroup, getJ2EEType, getName, isDAS

Methods inherited from interface javax.management.NotificationEmitter

removeNotificationListener

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Methods inherited from interface com.sun.appserv.management.base.AMXMBeanLogging

getMBeanLoggerName, getMBeanLogLevel, setMBeanLogLevel

Methods inherited from interface com.sun.appserv.management.config.Description

getDescription, setDescription

Methods inherited from interface com.sun.appserv.management.config.PropertiesAccess

createProperty, existsProperty, getProperties, getPropertyNames, getPropertyValue, removeProperty, setPropertyValue

Methods inherited from interface com.sun.appserv.management.base.Container

getByNameContaineeSet, getContainee, getContainee, getContaineeJ2EETypes, getContaineeMap, getContaineeSet, getContaineeSet, getContaineeSet, getMultiContaineeMap

Field Detail

J2EE_TYPE

static final String J2EE_TYPE

The j2eeType as returned by AMX.getJ2EEType().

See Also:

Constant Field Values

Method Detail

getConnectionValidationRequired

boolean getConnectionValidationRequired()

Specifies if the connection that is about to be returned is to be validated by the container.

setConnectionValidationRequired

void setConnectionValidationRequired(boolean required)

See getConnectionValidationRequired().

getConnectionDefinitionName

String getConnectionDefinitionName()

Unique name, identifying one connection-definition in a Resource Adapter. Currently this is ConnectionFactory type.

setConnectionDefinitionName

void setConnectionDefinitionName(String value)

See getConnectionDefinitionName().

getFailAllConnections

boolean getFailAllConnections()

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.

setFailAllConnections

void setFailAllConnections(boolean value)

See getFailAllConnections().

getIdleTimeoutInSeconds

String getIdleTimeoutInSeconds()

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.

setIdleTimeoutInSeconds

void setIdleTimeoutInSeconds(String value)

See getIdleTimeoutInSeconds().

getMaxPoolSize

String getMaxPoolSize()

Maximum number of conections that can be created.

setMaxPoolSize

void setMaxPoolSize(String value)

See getMaxPoolSize().

getMaxWaitTimeInMillis

String getMaxWaitTimeInMillis()

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.

setMaxWaitTimeInMillis

void setMaxWaitTimeInMillis(String value)

See getMaxWaitTimeInMillis().

getPoolResizeQuantity

String getPoolResizeQuantity()

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.

setPoolResizeQuantity

void setPoolResizeQuantity(String value)

See getPoolResizeQuantity().

getResourceAdapterName

String getResourceAdapterName()

Name of resource adapter. Name of .rar file is taken as the unique name for the resource adapter.

setResourceAdapterName

void setResourceAdapterName(String value)

See getResourceAdapterName().

getSteadyPoolSize

String getSteadyPoolSize()

Minimum and initial number of connections maintained in the pool.

setSteadyPoolSize

void setSteadyPoolSize(String value)

See getSteadyPoolSize().

getTransactionSupport

String getTransactionSupport()

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 Also:

TransactionSupportValues

setTransactionSupport

void setTransactionSupport(String value)

See getTransactionSupport().

getSecurityMapConfigMap

Map<String,SecurityMapConfig> getSecurityMapConfigMap()

Returns:

Map of all SecurityMapConfig contained in this item.

createSecurityMapConfig

SecurityMapConfig createSecurityMapConfig(String name,
                                          String backendPrincipalUsername,
                                          String backendPrincipalPassword,
                                          String[] principals,
                                          String[] userGroups)

At least one of 'principals' and 'userGroups' must be non-null.

removeSecurityMapConfig

void removeSecurityMapConfig(String name)

Remove the specified SecurityMapConfig.