com.metamatrix.common.pooling.api
Class ResourcePoolPropertyNames

java.lang.Object
  com.metamatrix.common.pooling.api.ResourcePoolPropertyNames

public final class ResourcePoolPropertyNames
extends java.lang.Object

Field Summary

static java.lang.String	ALLOW_SHRINKING The environment property name that indicates if shrinking of the resource pool is allowed.
static java.lang.String	EXTEND_MAXIMUM_POOL_SIZE_MODE The environment property name for enabling the resource pool size to grow beyond the MAXIMUM_RESOURCE_POOL_SIZE.
static java.lang.String	EXTEND_MAXIMUM_POOL_SIZE_PERCENT The environment property name for the percentage of growth the resource pool should be allowed to grow above the MAXIMUM_RESOURCE_POOL_SIZE.
static java.lang.String	LIVE_AND_UNUSED_TIME The environment property name for the amount of time that will have to pass where a resource has not been used and therefore should be considered for removal from the pool.
static java.lang.String	MAXIMUM_RESOURCE_POOL_SIZE The environment property name for the maximum number of resource instances (i.e., number of objects) that will be active at one time in the pool.
static java.lang.String	MINIMUM_RESOURCE_POOL_SIZE The environment property name for the minimum number of resource instances (i.e., number of objects) that will always be active in the pool.
static java.lang.String	NUM_OF_CONCURRENT_USERS The environment property name for the number of users that can share the same resource at the same time (i.e., concurrent users).
static java.lang.String	RESOURCE_ADAPTER_CLASS_NAME The environment property name that defines the ResourceAdapter class that will be instantiated to create resource object instances
static java.lang.String	RESOURCE_POOL_CLASS_NAME The environment property name that defines the ResourcePool class that will be instantiated to manage a specific resource pool.
static java.lang.String	SHRINK_INCREMENT The environment property name that indicates the maximum number of resources in the pool that will be removed at one time.
static java.lang.String	SHRINK_PERIOD The environment property name for the intervals between when the clean-up thread tries to shrink the pool.
static java.lang.String	WAIT_TIME_FOR_RESOURCE The environment property name for how long a request for a resource will wait for one to become available.

Constructor Summary

ResourcePoolPropertyNames()

Method Summary

static java.util.Collection

getNames()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RESOURCE_ADAPTER_CLASS_NAME

public static final java.lang.String RESOURCE_ADAPTER_CLASS_NAME

The environment property name that defines the ResourceAdapter class that will be instantiated to create resource object instances

See Also:

Constant Field Values

RESOURCE_POOL_CLASS_NAME

public static final java.lang.String RESOURCE_POOL_CLASS_NAME

The environment property name that defines the ResourcePool class that will be instantiated to manage a specific resource pool.

See Also:

Constant Field Values

MINIMUM_RESOURCE_POOL_SIZE

public static final java.lang.String MINIMUM_RESOURCE_POOL_SIZE

The environment property name for the minimum number of resource instances (i.e., number of objects) that will always be active in the pool.

This is an optional property and the value must be the string form of an integer. The default value is "1" .

See Also:

Constant Field Values

MAXIMUM_RESOURCE_POOL_SIZE

public static final java.lang.String MAXIMUM_RESOURCE_POOL_SIZE

The environment property name for the maximum number of resource instances (i.e., number of objects) that will be active at one time in the pool.

This is an optional property and the value must be the string form of an integer. The default value is "5" .

See Also:

Constant Field Values

NUM_OF_CONCURRENT_USERS

public static final java.lang.String NUM_OF_CONCURRENT_USERS

The environment property name for the number of users that can share the same resource at the same time (i.e., concurrent users). This property, in most cases, should be user specified. This is because each resource, unless it cannot be shared, may have it's limitations as to the number of concurrent users (e.g., JDBC Connections) and could impact performance.

This is an optional property and the value must be the string form of an integer. The default value is "1" .

See Also:

Constant Field Values

SHRINK_PERIOD

public static final java.lang.String SHRINK_PERIOD

The environment property name for the intervals between when the clean-up thread tries to shrink the pool.

This is an optional property and it corresponds to the number of milliseconds between checks. The value must be the string form of an integer and the default value is "300000" or 5 minutes.

See Also:

Constant Field Values

ALLOW_SHRINKING

public static final java.lang.String ALLOW_SHRINKING

The environment property name that indicates if shrinking of the resource pool is allowed. SHRINK_PERIOD

This is an optional property and it corresponds to either true or false. The value must be the string form and the default value is "true".

See Also:

Constant Field Values

SHRINK_INCREMENT

public static final java.lang.String SHRINK_INCREMENT

The environment property name that indicates the maximum number of resources in the pool that will be removed at one time. This is only applicable if shrinking is allowed. ALLOW_SHRINKING SHRINK_PERIOD

This is an optional property and and the value must be the string form of an integer. The default value is "0", which indicates no limit to the number of resources that can be removed in order to return to the minimum pool size.

See Also:

Constant Field Values

LIVE_AND_UNUSED_TIME

public static final java.lang.String LIVE_AND_UNUSED_TIME

The environment property name for the amount of time that will have to pass where a resource has not been used and therefore should be considered for removal from the pool. The property might be set higher in the case where the resource is one that will be asked for over-and-over so that the resouce is not removed and recreated as often. However, in the case where the resource is not asked for as often or rarely, then a higher setting would be appropriate so that unneeded resources are not held in memory.

To assist in determining what the setting should be, try a multiple of SHRINK_PERIOD. If the resource pool is being checked for shrinkage every 5 minutes, then every other time (i.e., 10 minutes) the resource will be checked for being alive and unused.

This is an optional property and it corresponds to the number of milliseconds between checks. The value must be the string form of an integer and the default value is "600000" or 10 minutes.

See Also:

Constant Field Values

WAIT_TIME_FOR_RESOURCE

public static final java.lang.String WAIT_TIME_FOR_RESOURCE

The environment property name for how long a request for a resource will wait for one to become available.

If the NUM_OF_CONCURRENT_USERS cannot be increased, nor can the MAXIMUM_RESOURCE_POOL_SIZE be increased, then there would be a possible need for increasing the wait time. But try tuning the other properties first, otherwise the wait time for the user will be increased.

This is an optional property and it corresponds to the number of milliseconds between checks. The value must be the string form of an integer and the default value is "30000" or 30 seconds.

See Also:

Constant Field Values

EXTEND_MAXIMUM_POOL_SIZE_MODE

public static final java.lang.String EXTEND_MAXIMUM_POOL_SIZE_MODE

The environment property name for enabling the resource pool size to grow beyond the MAXIMUM_RESOURCE_POOL_SIZE. If the property is set to true>, this will allow the resource pool to grow upto the EXTEND_MAXIMUM_POOL_SIZE. This feature is beneficial for server side pools so that they can continue operating without crashing during abnormal peak times.

This is an optional property and it corresponds to either true or false. The value must be the string form and the default value is "false".

See Also:

Constant Field Values

EXTEND_MAXIMUM_POOL_SIZE_PERCENT

public static final java.lang.String EXTEND_MAXIMUM_POOL_SIZE_PERCENT

The environment property name for the percentage of growth the resource pool should be allowed to grow above the MAXIMUM_RESOURCE_POOL_SIZE.

This is an optional property and the value must be the string form of an double. There default value for this property is "1.000" such that the pool will grow %100 percent in size above the maximum pool size.

See Also:

Constant Field Values

Constructor Detail

ResourcePoolPropertyNames

public ResourcePoolPropertyNames()

Method Detail

getNames

public static java.util.Collection getNames()