org.exolab.jms.config
Class RdbmsDatabaseConfiguration

java.lang.Object
  |
  +--org.exolab.jms.config.RdbmsDatabaseConfiguration

All Implemented Interfaces:

java.io.Serializable

public class RdbmsDatabaseConfiguration

extends java.lang.Object

implements java.io.Serializable

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

RdbmsDatabaseConfiguration()

Method Summary

void	deleteBatch() Method deleteBatch
void	deleteBatchSize() Method deleteBatchSize
void	deleteEvictionInterval() Method deleteEvictionInterval
void	deleteMaxActive() Method deleteMaxActive
void	deleteMaxIdle() Method deleteMaxIdle
void	deleteMinIdleTime() Method deleteMinIdleTime
void	deleteTestBeforeUse() Method deleteTestBeforeUse
boolean	getBatch() Returns the value of field 'batch'.
int	getBatchSize() Returns the value of field 'batchSize'.
java.lang.String	getClazz() Returns the value of field 'clazz'.
java.lang.String	getDriver() Returns the value of field 'driver'.
int	getEvictionInterval() Returns the value of field 'evictionInterval'.
int	getMaxActive() Returns the value of field 'maxActive'.
int	getMaxIdle() Returns the value of field 'maxIdle'.
int	getMinIdleTime() Returns the value of field 'minIdleTime'.
java.lang.String	getPassword() Returns the value of field 'password'.
boolean	getTestBeforeUse() Returns the value of field 'testBeforeUse'.
java.lang.String	getTestQuery() Returns the value of field 'testQuery'.
java.lang.String	getUrl() Returns the value of field 'url'.
java.lang.String	getUser() Returns the value of field 'user'.
boolean	hasBatch() Method hasBatch
boolean	hasBatchSize() Method hasBatchSize
boolean	hasEvictionInterval() Method hasEvictionInterval
boolean	hasMaxActive() Method hasMaxActive
boolean	hasMaxIdle() Method hasMaxIdle
boolean	hasMinIdleTime() Method hasMinIdleTime
boolean	hasTestBeforeUse() Method hasTestBeforeUse
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
void	setBatch(boolean batch) Sets the value of field 'batch'.
void	setBatchSize(int batchSize) Sets the value of field 'batchSize'.
void	setClazz(java.lang.String clazz) Sets the value of field 'clazz'.
void	setDriver(java.lang.String driver) Sets the value of field 'driver'.
void	setEvictionInterval(int evictionInterval) Sets the value of field 'evictionInterval'.
void	setMaxActive(int maxActive) Sets the value of field 'maxActive'.
void	setMaxIdle(int maxIdle) Sets the value of field 'maxIdle'.
void	setMinIdleTime(int minIdleTime) Sets the value of field 'minIdleTime'.
void	setPassword(java.lang.String password) Sets the value of field 'password'.
void	setTestBeforeUse(boolean testBeforeUse) Sets the value of field 'testBeforeUse'.
void	setTestQuery(java.lang.String testQuery) Sets the value of field 'testQuery'.
void	setUrl(java.lang.String url) Sets the value of field 'url'.
void	setUser(java.lang.String user) Sets the value of field 'user'.
static RdbmsDatabaseConfiguration	unmarshal(java.io.Reader reader) Method unmarshal
void	validate() Method validate

Methods inherited from class java.lang.Object

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

Constructor Detail

RdbmsDatabaseConfiguration

public RdbmsDatabaseConfiguration()

Method Detail

deleteBatch

public void deleteBatch()

Method deleteBatch

deleteBatchSize

public void deleteBatchSize()

Method deleteBatchSize

deleteEvictionInterval

public void deleteEvictionInterval()

Method deleteEvictionInterval

deleteMaxActive

public void deleteMaxActive()

Method deleteMaxActive

deleteMaxIdle

public void deleteMaxIdle()

Method deleteMaxIdle

deleteMinIdleTime

public void deleteMinIdleTime()

Method deleteMinIdleTime

deleteTestBeforeUse

public void deleteTestBeforeUse()

Method deleteTestBeforeUse

getBatch

public boolean getBatch()

Returns the value of field 'batch'. The field 'batch' has the following description: Determines whether or not to batch SQL requests. This will only be useful in certain scenarios (i.e small to medium message size). This can be controlled with the batchSize parameter.

Returns:

the value of field 'batch'.

getBatchSize

public int getBatchSize()

Returns the value of field 'batchSize'. The field 'batchSize' has the following description: The number of SQL requests to batch before committing them to the database.

Returns:

the value of field 'batchSize'.

getClazz

public java.lang.String getClazz()

Returns the value of field 'clazz'. The field 'clazz' has the following description: The connection manager, which pools connections to the underlying database.

Returns:

the value of field 'clazz'.

getDriver

public java.lang.String getDriver()

Returns the value of field 'driver'. The field 'driver' has the following description: The JDBC driver, which must be XA compliant, used to access the database.

Returns:

the value of field 'driver'.

getEvictionInterval

public int getEvictionInterval()

Returns the value of field 'evictionInterval'. The field 'evictionInterval' has the following description: Specifies the interval, in seconds, between checking idle connections. Idle connections are removed after minIdleTime seconds, or if testQuery is specified and the query fails.

Returns:

the value of field 'evictionInterval'.

getMaxActive

public int getMaxActive()

Returns the value of field 'maxActive'. The field 'maxActive' has the following description: The maximum no. of active connections that can be allocated from the connection pool, or zero for no limit.

Returns:

the value of field 'maxActive'.

getMaxIdle

public int getMaxIdle()

Returns the value of field 'maxIdle'. The field 'maxIdle' has the following description: The maximum no. of connections that can sit idle in the connection pool, before connections are evicted.

Returns:

the value of field 'maxIdle'.

getMinIdleTime

public int getMinIdleTime()

Returns the value of field 'minIdleTime'. The field 'minIdleTime' has the following description: Specifies the minimum time that a connection may remain idle before it may be evicted. Use "0" to disable eviction of idle connections.

Returns:

the value of field 'minIdleTime'.

getPassword

public java.lang.String getPassword()

Returns the value of field 'password'. The field 'password' has the following description: The user password.

Returns:

the value of field 'password'.

getTestBeforeUse

public boolean getTestBeforeUse()

Returns the value of field 'testBeforeUse'. The field 'testBeforeUse' has the following description: If true, each connection is tested before being used, using testQuery. If a connection fails, it is discarded, and another connection allocated. This ensures a higher reliability, at the cost of performance.

Returns:

the value of field 'testBeforeUse'.

getTestQuery

public java.lang.String getTestQuery()

Returns the value of field 'testQuery'. The field 'testQuery' has the following description: Specifies an SQL query to validate connections. This query should return at least one row, and be fast to execute.

Returns:

the value of field 'testQuery'.

getUrl

public java.lang.String getUrl()

Returns the value of field 'url'. The field 'url' has the following description: The JDBC url.

Returns:

the value of field 'url'.

getUser

public java.lang.String getUser()

Returns the value of field 'user'. The field 'user' has the following description: The database user.

Returns:

the value of field 'user'.

hasBatch

public boolean hasBatch()

Method hasBatch

hasBatchSize

public boolean hasBatchSize()

Method hasBatchSize

hasEvictionInterval

public boolean hasEvictionInterval()

Method hasEvictionInterval

hasMaxActive

public boolean hasMaxActive()

Method hasMaxActive

hasMaxIdle

public boolean hasMaxIdle()

Method hasMaxIdle

hasMinIdleTime

public boolean hasMinIdleTime()

Method hasMinIdleTime

hasTestBeforeUse

public boolean hasTestBeforeUse()

Method hasTestBeforeUse

isValid

public boolean isValid()

Method isValid

marshal

public void marshal(java.io.Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

out -

marshal

public void marshal(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

handler -

setBatch

public void setBatch(boolean batch)

Sets the value of field 'batch'. The field 'batch' has the following description: Determines whether or not to batch SQL requests. This will only be useful in certain scenarios (i.e small to medium message size). This can be controlled with the batchSize parameter.

Parameters:

batch - the value of field 'batch'.

setBatchSize

public void setBatchSize(int batchSize)

Sets the value of field 'batchSize'. The field 'batchSize' has the following description: The number of SQL requests to batch before committing them to the database.

Parameters:

batchSize - the value of field 'batchSize'.

setClazz

public void setClazz(java.lang.String clazz)

Sets the value of field 'clazz'. The field 'clazz' has the following description: The connection manager, which pools connections to the underlying database.

Parameters:

clazz - the value of field 'clazz'.

setDriver

public void setDriver(java.lang.String driver)

Sets the value of field 'driver'. The field 'driver' has the following description: The JDBC driver, which must be XA compliant, used to access the database.

Parameters:

driver - the value of field 'driver'.

setEvictionInterval

public void setEvictionInterval(int evictionInterval)

Sets the value of field 'evictionInterval'. The field 'evictionInterval' has the following description: Specifies the interval, in seconds, between checking idle connections. Idle connections are removed after minIdleTime seconds, or if testQuery is specified and the query fails.

Parameters:

evictionInterval - the value of field 'evictionInterval'

setMaxActive

public void setMaxActive(int maxActive)

Sets the value of field 'maxActive'. The field 'maxActive' has the following description: The maximum no. of active connections that can be allocated from the connection pool, or zero for no limit.

Parameters:

maxActive - the value of field 'maxActive'.

setMaxIdle

public void setMaxIdle(int maxIdle)

Sets the value of field 'maxIdle'. The field 'maxIdle' has the following description: The maximum no. of connections that can sit idle in the connection pool, before connections are evicted.

Parameters:

maxIdle - the value of field 'maxIdle'.

setMinIdleTime

public void setMinIdleTime(int minIdleTime)

Sets the value of field 'minIdleTime'. The field 'minIdleTime' has the following description: Specifies the minimum time that a connection may remain idle before it may be evicted. Use "0" to disable eviction of idle connections.

Parameters:

minIdleTime - the value of field 'minIdleTime'.

setPassword

public void setPassword(java.lang.String password)

Sets the value of field 'password'. The field 'password' has the following description: The user password.

Parameters:

password - the value of field 'password'.

setTestBeforeUse

public void setTestBeforeUse(boolean testBeforeUse)

Sets the value of field 'testBeforeUse'. The field 'testBeforeUse' has the following description: If true, each connection is tested before being used, using testQuery. If a connection fails, it is discarded, and another connection allocated. This ensures a higher reliability, at the cost of performance.

Parameters:

testBeforeUse - the value of field 'testBeforeUse'.

setTestQuery

public void setTestQuery(java.lang.String testQuery)

Sets the value of field 'testQuery'. The field 'testQuery' has the following description: Specifies an SQL query to validate connections. This query should return at least one row, and be fast to execute.

Parameters:

testQuery - the value of field 'testQuery'.

setUrl

public void setUrl(java.lang.String url)

Sets the value of field 'url'. The field 'url' has the following description: The JDBC url.

Parameters:

url - the value of field 'url'.

setUser

public void setUser(java.lang.String user)

Sets the value of field 'user'. The field 'user' has the following description: The database user.

Parameters:

user - the value of field 'user'.

unmarshal

public static RdbmsDatabaseConfiguration unmarshal(java.io.Reader reader)
                                            throws org.exolab.castor.xml.MarshalException,
                                                   org.exolab.castor.xml.ValidationException

Method unmarshal

Parameters:

reader -

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Method validate