org.rhq.common.jbossas.client.controller

Class DatasourceJBossASClient

java.lang.Object

org.rhq.common.jbossas.client.controller.JBossASClient

org.rhq.common.jbossas.client.controller.DatasourceJBossASClient

public class DatasourceJBossASClient
extends JBossASClient

Provides convenience methods associated with datasource management.

Author:

John Mazzitelli

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONNECTION_PROPERTIES
static String	DATA_SOURCE
static String	JDBC_DRIVER
static String	OP_ENABLE
static String	SUBSYSTEM_DATASOURCES
static String	XA_DATA_SOURCE
static String	XA_DATASOURCE_PROPERTIES

Fields inherited from class org.rhq.common.jbossas.client.controller.JBossASClient

ADD, ADDRESS, BATCH, BATCH_STEPS, FAILURE_DESCRIPTION, log, NAME, OPERATION, OUTCOME, OUTCOME_SUCCESS, PERSISTENT, READ_ATTRIBUTE, READ_RESOURCE, REMOVE, RESULT, SUBSYSTEM, SYSTEM_PROPERTY, VALUE, WRITE_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
DatasourceJBossASClient(org.jboss.as.controller.client.ModelControllerClient client)

Method Summary

Methods

Modifier and Type	Method and Description
org.jboss.dmr.ModelNode	createNewDatasourceRequest(String name, int blockingTimeoutWaitMillis, String connectionUrlExpression, String driverName, String exceptionSorterClassName, int idleTimeoutMinutes, boolean jta, int minPoolSize, int maxPoolSize, int preparedStatementCacheSize, String securityDomain, String staleConnectionCheckerClassName, String transactionIsolation, String validConnectionCheckerClassName, boolean validateOnMatch, Map<String,String> connectionProperties) Returns a ModelNode that can be used to create a datasource.
org.jboss.dmr.ModelNode	createNewDatasourceRequest(String name, String connectionUrlExpression, String driverName, boolean jta, Map<String,String> connectionProperties)
org.jboss.dmr.ModelNode	createNewJdbcDriverRequest(String name, String moduleName, String driverXaClassName) Returns a ModelNode that can be used to create a JDBC driver configuration for use by datasources.
org.jboss.dmr.ModelNode	createNewXADatasourceRequest(String name, int blockingTimeoutWaitMillis, String driverName, String xaDataSourceClass, String exceptionSorterClassName, int idleTimeoutMinutes, int minPoolSize, int maxPoolSize, Boolean noRecovery, Boolean noTxSeparatePool, int preparedStatementCacheSize, String recoveryPluginClassName, String securityDomain, String staleConnectionCheckerClassName, String transactionIsolation, String validConnectionCheckerClassName, Map<String,String> xaDatasourceProperties) Returns a ModelNode that can be used to create an XA datasource.
void	enableDatasource(String name)
void	enableXADatasource(String name)
boolean	isDatasource(String datasourceName) Checks to see if there is already a datasource with the given name.
boolean	isDatasourceEnabled(String name)
boolean	isJDBCDriver(String jdbcDriverName) Checks to see if there is already a JDBC driver with the given name.
boolean	isXADatasource(String datasourceName) Checks to see if there is already a XA datasource with the given name.
boolean	isXADatasourceEnabled(String name)
void	removeDatasource(String name) Completely removes the named datasource.

Methods inherited from class org.rhq.common.jbossas.client.controller.JBossASClient

createBatchRequest, createReadAttributeRequest, createReadAttributeRequest, createRequest, createRequest, createWriteAttributeRequest, execute, findNodeInList, getFailureDescription, getModelControllerClient, getResultListAsStrings, getResults, getStringAttribute, getStringAttribute, isSuccess, readResource, readResource, remove, setPossibleExpression

Methods inherited from class java.lang.Object

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

Field Detail

SUBSYSTEM_DATASOURCES

public static final String SUBSYSTEM_DATASOURCES

See Also:

Constant Field Values

DATA_SOURCE

public static final String DATA_SOURCE

See Also:

Constant Field Values

XA_DATA_SOURCE

public static final String XA_DATA_SOURCE

See Also:

Constant Field Values

JDBC_DRIVER

public static final String JDBC_DRIVER

See Also:

Constant Field Values

CONNECTION_PROPERTIES

public static final String CONNECTION_PROPERTIES

See Also:

Constant Field Values

XA_DATASOURCE_PROPERTIES

public static final String XA_DATASOURCE_PROPERTIES

See Also:

Constant Field Values

OP_ENABLE

public static final String OP_ENABLE

See Also:

Constant Field Values

Constructor Detail

DatasourceJBossASClient

public DatasourceJBossASClient(org.jboss.as.controller.client.ModelControllerClient client)

Method Detail

removeDatasource

public void removeDatasource(String name)
                      throws Exception

Completely removes the named datasource. If the datasource does not exist, this returns silently (in other words, no exception is thrown). Note that no distinguishing between XA and non-XA datasource is needed - if any datasource (XA or non-XA) exists with the given name, it will be removed.

Parameters:

name - the name of the datasource to remove

Throws:

Exception

isDatasourceEnabled

public boolean isDatasourceEnabled(String name)
                            throws Exception

Throws:

Exception

isXADatasourceEnabled

public boolean isXADatasourceEnabled(String name)
                              throws Exception

Throws:

Exception

enableDatasource

public void enableDatasource(String name)
                      throws Exception

Throws:

Exception

enableXADatasource

public void enableXADatasource(String name)
                        throws Exception

Throws:

Exception

isJDBCDriver

public boolean isJDBCDriver(String jdbcDriverName)
                     throws Exception

Checks to see if there is already a JDBC driver with the given name.

Parameters:

jdbcDriverName - the name to check

Returns:

true if there is a JDBC driver with the given name already in existence

Throws:

Exception

isDatasource

public boolean isDatasource(String datasourceName)
                     throws Exception

Checks to see if there is already a datasource with the given name.

Parameters:

datasourceName - the name to check

Returns:

true if there is a datasource with the given name already in existence

Throws:

Exception

isXADatasource

public boolean isXADatasource(String datasourceName)
                       throws Exception

Checks to see if there is already a XA datasource with the given name.

Parameters:

datasourceName - the name to check

Returns:

true if there is a XA datasource with the given name already in existence

Throws:

Exception

createNewJdbcDriverRequest

public org.jboss.dmr.ModelNode createNewJdbcDriverRequest(String name,
                                                 String moduleName,
                                                 String driverXaClassName)

Returns a ModelNode that can be used to create a JDBC driver configuration for use by datasources. Callers are free to tweek the JDBC driver request that is returned, if they so choose, before asking the client to execute the request. NOTE: the JDBC module must have already been installed in the JBossAS's modules/ location.

Parameters:

name - the name of the JDBC driver (this is not the name of the JDBC jar or the module name, it is just a convenience name of the JDBC driver configuration).

moduleName - the name of the JBossAS module where the JDBC driver is installed

driverXaClassName - the JDBC driver's XA datasource classname (null if XA is not supported)

Returns:

the request to create the JDBC driver configuration.

createNewDatasourceRequest

public org.jboss.dmr.ModelNode createNewDatasourceRequest(String name,
                                                 int blockingTimeoutWaitMillis,
                                                 String connectionUrlExpression,
                                                 String driverName,
                                                 String exceptionSorterClassName,
                                                 int idleTimeoutMinutes,
                                                 boolean jta,
                                                 int minPoolSize,
                                                 int maxPoolSize,
                                                 int preparedStatementCacheSize,
                                                 String securityDomain,
                                                 String staleConnectionCheckerClassName,
                                                 String transactionIsolation,
                                                 String validConnectionCheckerClassName,
                                                 boolean validateOnMatch,
                                                 Map<String,String> connectionProperties)

Returns a ModelNode that can be used to create a datasource. Callers are free to tweak the datasource request that is returned, if they so choose, before asking the client to execute the request.

Parameters:

name -

blockingTimeoutWaitMillis -

connectionUrlExpression -

driverName -

exceptionSorterClassName -

idleTimeoutMinutes -

jta - true if this DS should support transactions; false if not

minPoolSize -

maxPoolSize -

preparedStatementCacheSize -

securityDomain -

staleConnectionCheckerClassName -

transactionIsolation -

validConnectionCheckerClassName -

connectionProperties -

Returns:

the request that can be used to create the datasource

createNewDatasourceRequest

public org.jboss.dmr.ModelNode createNewDatasourceRequest(String name,
                                                 String connectionUrlExpression,
                                                 String driverName,
                                                 boolean jta,
                                                 Map<String,String> connectionProperties)

createNewXADatasourceRequest

public org.jboss.dmr.ModelNode createNewXADatasourceRequest(String name,
                                                   int blockingTimeoutWaitMillis,
                                                   String driverName,
                                                   String xaDataSourceClass,
                                                   String exceptionSorterClassName,
                                                   int idleTimeoutMinutes,
                                                   int minPoolSize,
                                                   int maxPoolSize,
                                                   Boolean noRecovery,
                                                   Boolean noTxSeparatePool,
                                                   int preparedStatementCacheSize,
                                                   String recoveryPluginClassName,
                                                   String securityDomain,
                                                   String staleConnectionCheckerClassName,
                                                   String transactionIsolation,
                                                   String validConnectionCheckerClassName,
                                                   Map<String,String> xaDatasourceProperties)

Returns a ModelNode that can be used to create an XA datasource. Callers are free to tweek the datasource request that is returned, if they so choose, before asking the client to execute the request.

Parameters:

name -

blockingTimeoutWaitMillis -

driverName -

xaDataSourceClass -

exceptionSorterClassName -

idleTimeoutMinutes -

minPoolSize -

maxPoolSize -

noRecovery - optional, left unset if null

noTxSeparatePool - optional, left unset if null

preparedStatementCacheSize -

recoveryPluginClassName - optional, left unset if null

securityDomain -

staleConnectionCheckerClassName - optional, left unset if null

transactionIsolation -

validConnectionCheckerClassName -

xaDatasourceProperties -

Returns:

the request that can be used to create the XA datasource