org.mule.db.commons.api.config

Class DbPoolingProfile

java.lang.Object

org.mule.db.commons.api.config.DbPoolingProfile

All Implemented Interfaces:

org.mule.runtime.api.config.DatabasePoolingProfile

@Alias(value="pooling-profile")
public class DbPoolingProfile
extends Object
implements org.mule.runtime.api.config.DatabasePoolingProfile

Pooling configuration for JDBC Data Sources capable of pooling connections

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
DbPoolingProfile() Creates a new instance of DbPoolingProfile
DbPoolingProfile(int minPoolSize, int maxPoolSize, int acquireIncrement, int preparedStatementCacheSize, int maxWait, TimeUnit maxWaitUnit, int maxIdleTime, int maxStatements, boolean testConnectionOnCheckout, Map<String,Object> additionalProperties) Creates a new instance of DbPoolingProfile with the given arguments.
DbPoolingProfile(int minPoolSize, int maxPoolSize, int acquireIncrement, int preparedStatementCacheSize, int maxWait, TimeUnit maxWaitUnit, int maxIdleTime, Map<String,Object> additionalProperties) Creates a new instance of DbPoolingProfile with the given arguments.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getAcquireIncrement()
Map<String,Object>	getAdditionalProperties()
int	getMaxIdleTime()
int	getMaxPoolSize()
int	getMaxStatements()
int	getMaxWait()
TimeUnit	getMaxWaitUnit()
int	getMinPoolSize()
int	getPreparedStatementCacheSize()
boolean	getTestConnectionOnCheckout()
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

DbPoolingProfile

public DbPoolingProfile()

Creates a new instance of DbPoolingProfile

DbPoolingProfile

public DbPoolingProfile(int minPoolSize,
                        int maxPoolSize,
                        int acquireIncrement,
                        int preparedStatementCacheSize,
                        int maxWait,
                        TimeUnit maxWaitUnit,
                        int maxIdleTime,
                        Map<String,Object> additionalProperties)

Creates a new instance of DbPoolingProfile with the given arguments.

Parameters:

minPoolSize - Minimum number of connections a pool maintains at any given time

maxPoolSize - Maximum number of connections a pool maintains at any given time

acquireIncrement - Determines how many connections at a time to try to acquire when the pool is exhausted

preparedStatementCacheSize - Determines how many statements are cached per pooled connection. Setting this to zero will disable statement caching

maxWait - The amount of time a client trying to obtain a connection waits for it to be acquired when the pool is exhausted. Zero (default) means wait indefinitely

maxWaitUnit - A TimeUnit which qualifies the maxWait.

maxIdleTime - Determines how many seconds a Connection can remain pooled but unused before being discarded. Zero means idle connections never expire.

additionalProperties - Additional properties used to configure pooling profile.

DbPoolingProfile

public DbPoolingProfile(int minPoolSize,
                        int maxPoolSize,
                        int acquireIncrement,
                        int preparedStatementCacheSize,
                        int maxWait,
                        TimeUnit maxWaitUnit,
                        int maxIdleTime,
                        int maxStatements,
                        boolean testConnectionOnCheckout,
                        Map<String,Object> additionalProperties)

Creates a new instance of DbPoolingProfile with the given arguments.

Parameters:

minPoolSize - Minimum number of connections a pool maintains at any given time

maxPoolSize - Maximum number of connections a pool maintains at any given time

acquireIncrement - Determines how many connections at a time to try to acquire when the pool is exhausted

preparedStatementCacheSize - Determines how many statements are cached per pooled connection. Setting this to zero will disable statement caching

maxWait - The amount of time a client trying to obtain a connection waits for it to be acquired when the pool is exhausted. Zero (default) means wait indefinitely

maxWaitUnit - A TimeUnit which qualifies the maxWait.

maxIdleTime - Determines how many seconds a Connection can remain pooled but unused before being discarded. Zero means idle connections never expire.

maxStatements - Defines the total number PreparedStatements a DataSource will cache. The pool will destroy the least-recently-used PreparedStatement when it hits this limit. When set to 0 statement caching is turned off.

testConnectionOnCheckout - If set to true, an operation will be performed at every connection checkout to verify that the connection is valid. A better choice is to verify connections periodically using c3p0.idleConnectionTestPeriod. In order to improve performance, we recommend that you set this property to 'false'.

additionalProperties - Additional properties used to configure pooling profile.

Method Detail

getMaxPoolSize

public int getMaxPoolSize()

Specified by:

getMaxPoolSize in interface org.mule.runtime.api.config.DatabasePoolingProfile

getMinPoolSize

public int getMinPoolSize()

Specified by:

getMinPoolSize in interface org.mule.runtime.api.config.DatabasePoolingProfile

getAcquireIncrement

public int getAcquireIncrement()

Specified by:

getAcquireIncrement in interface org.mule.runtime.api.config.DatabasePoolingProfile

getPreparedStatementCacheSize

public int getPreparedStatementCacheSize()

Specified by:

getPreparedStatementCacheSize in interface org.mule.runtime.api.config.DatabasePoolingProfile

getMaxWait

public int getMaxWait()

Specified by:

getMaxWait in interface org.mule.runtime.api.config.DatabasePoolingProfile

getMaxWaitUnit

public TimeUnit getMaxWaitUnit()

Specified by:

getMaxWaitUnit in interface org.mule.runtime.api.config.DatabasePoolingProfile

getMaxIdleTime

public int getMaxIdleTime()

getMaxStatements

public int getMaxStatements()

getTestConnectionOnCheckout

public boolean getTestConnectionOnCheckout()

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object