org.openmdx.kernel.application.deploy.spi
Interface Deployment.Pool

All Known Subinterfaces:

Deployment.Bean, Deployment.MessageDrivenBean, Deployment.ResourceAdapter, Deployment.SessionBean

All Known Implementing Classes:

BeanDecorator, BeanDeploymentDescriptor, MessageDrivenBeanDecorator, MessageDrivenBeanDeploymentDescriptor, ResourceAdapterDecorator, ResourceAdapterDeploymentDescriptor, SessionBeanDecorator, SessionBeanDeploymentDescriptor

Enclosing interface:

Deployment

public static interface Deployment.Pool

An openMDX Pool

Method Summary

Integer	getInitialCapacity() The initial-capacity element identifies the initial number of instance which the openMDX Container will attempt to obtain during deployment.
Integer	getMaximumCapacity() The maximum-capacity element identifies the maximum number of managed connections which the openMDX Container will allow.
Long	getMaximumWait() The maximum-wait element defines the time in milliseconds to wait for an instance to be returned to the pool when there are maximum-capacity active instances.

Method Detail

getInitialCapacity

Integer getInitialCapacity()

The initial-capacity element identifies the initial number of instance which the openMDX Container will attempt to obtain during deployment.

The default initial capacity is 1.

Returns:

the initial number of pool instances

getMaximumCapacity

Integer getMaximumCapacity()

The maximum-capacity element identifies the maximum number of managed connections which the openMDX Container will allow. Requests beyond this limit will result in an Exception being returned to the caller.

The default maximum capacity is java.lang.Integer.MAX_VALUE, i.e.2³¹-1.

Returns:

the maximum number of pool instances that are allowed.

getMaximumWait

Long getMaximumWait()

The maximum-wait element defines the time in milliseconds to wait for an instance to be returned to the pool when there are maximum-capacity active instances.

A value of 0 will mean not to wait at all. When a request times out waiting for an instance an Exception is generated and the call aborted.

The default timeout value is java.lang.Long.MAX_VALUE, i.e. 2⁶³-1.

Returns:

time in milliseconds to wait for an instance to be returned to the pool when there are maximum-capacity active instances

See Also:

getMaximumCapacity()