/*
* JBoss, Home of Professional Open Source.
* Copyright 2011, Red Hat, Inc., and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.as.connector.subsystems.datasources;
import static org.jboss.as.connector.ConnectorLogger.DS_DEPLOYER_LOGGER;
import static org.jboss.as.connector.ConnectorMessages.MESSAGES;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.AccessController;
import java.security.PrivilegedAction;
import java.sql.Driver;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.naming.Reference;
import javax.resource.ResourceException;
import javax.resource.spi.ManagedConnectionFactory;
import javax.sql.DataSource;
import org.jboss.as.connector.registry.DriverRegistry;
import org.jboss.as.connector.registry.InstalledDriver;
import org.jboss.as.connector.util.Injection;
import org.jboss.jca.adapters.jdbc.BaseWrapperManagedConnectionFactory;
import org.jboss.jca.adapters.jdbc.local.LocalManagedConnectionFactory;
import org.jboss.jca.adapters.jdbc.spi.ClassLoaderPlugin;
import org.jboss.jca.adapters.jdbc.xa.XAManagedConnectionFactory;
import org.jboss.jca.common.api.metadata.common.Extension;
import org.jboss.jca.common.api.metadata.ds.CommonDataSource;
import org.jboss.jca.common.api.metadata.ds.DataSources;
import org.jboss.jca.common.api.metadata.ds.DsSecurity;
import org.jboss.jca.common.api.metadata.ds.Statement;
import org.jboss.jca.common.api.metadata.ds.TimeOut;
import org.jboss.jca.common.api.metadata.ds.Validation;
import org.jboss.jca.common.api.metadata.ds.XaDataSource;
import org.jboss.jca.common.api.metadata.ra.ConfigProperty;
import org.jboss.jca.common.api.validator.ValidateException;
import org.jboss.jca.common.metadata.ds.DatasourcesImpl;
import org.jboss.jca.common.metadata.ds.DriverImpl;
import org.jboss.jca.core.api.connectionmanager.ccm.CachedConnectionManager;
import org.jboss.jca.core.api.management.ManagementRepository;
import org.jboss.jca.core.connectionmanager.ConnectionManager;
import org.jboss.jca.core.spi.mdr.NotFoundException;
import org.jboss.jca.core.spi.transaction.TransactionIntegration;
import org.jboss.jca.deployers.DeployersLogger;
import org.jboss.jca.deployers.common.AbstractDsDeployer;
import org.jboss.jca.deployers.common.CommonDeployment;
import org.jboss.jca.deployers.common.DeployException;
import org.jboss.logging.Logger;
import org.jboss.msc.inject.Injector;
import org.jboss.msc.service.Service;
import org.jboss.msc.service.ServiceContainer;
import org.jboss.msc.service.ServiceName;
import org.jboss.msc.service.StartContext;
import org.jboss.msc.service.StartException;
import org.jboss.msc.service.StopContext;
import org.jboss.msc.value.InjectedValue;
import org.jboss.security.SubjectFactory;
/**
* Base service for managing a data-source.
* @author John Bailey
* @author maeste
*/
public abstract class AbstractDataSourceService implements Service<DataSource> {
public static final ServiceName SERVICE_NAME_BASE = ServiceName.JBOSS.append("data-source");
private static final DeployersLogger DEPLOYERS_LOGGER = Logger.getMessageLogger(DeployersLogger.class, AS7DataSourceDeployer.class.getName());
protected final InjectedValue<TransactionIntegration> transactionIntegrationValue = new InjectedValue<TransactionIntegration>();
private final InjectedValue<Driver> driverValue = new InjectedValue<Driver>();
private final InjectedValue<ManagementRepository> managementRepositoryValue = new InjectedValue<ManagementRepository>();
private final InjectedValue<SubjectFactory> subjectFactory = new InjectedValue<SubjectFactory>();
private final InjectedValue<DriverRegistry> driverRegistry = new InjectedValue<DriverRegistry>();
private final InjectedValue<CachedConnectionManager> ccmValue = new InjectedValue<CachedConnectionManager>();
private final String jndiName;
protected CommonDeployment deploymentMD;
private javax.sql.DataSource sqlDataSource;
protected AbstractDataSourceService(final String jndiName) {
this.jndiName = jndiName;
}
public synchronized void start(StartContext startContext) throws StartException {
try {
final ServiceContainer container = startContext.getController().getServiceContainer();
deploymentMD = getDeployer().deploy(container);
if (deploymentMD.getCfs().length != 1) {
throw MESSAGES.cannotStartDs();
}
sqlDataSource = (javax.sql.DataSource) deploymentMD.getCfs()[0];
DS_DEPLOYER_LOGGER.debugf("Adding datasource: %s", deploymentMD.getCfJndiNames()[0]);
} catch (Throwable t) {
throw MESSAGES.deploymentError(t, jndiName);
}
}
protected abstract AS7DataSourceDeployer getDeployer() throws ValidateException ;
public synchronized void stop(StopContext stopContext) {
if (deploymentMD != null) {
if (deploymentMD.getDataSources() != null && managementRepositoryValue.getValue() != null) {
for (org.jboss.jca.core.api.management.DataSource mgtDs : deploymentMD.getDataSources()) {
managementRepositoryValue.getValue().getDataSources().remove(mgtDs);
}
}
if (deploymentMD.getConnectionManagers() != null) {
for (ConnectionManager cm : deploymentMD.getConnectionManagers()) {
cm.shutdown();
}
}
}
sqlDataSource = null;
}
public CommonDeployment getDeploymentMD() {
return deploymentMD;
}
public synchronized DataSource getValue() throws IllegalStateException, IllegalArgumentException {
return sqlDataSource;
}
public Injector<TransactionIntegration> getTransactionIntegrationInjector() {
return transactionIntegrationValue;
}
public Injector<Driver> getDriverInjector() {
return driverValue;
}
public Injector<ManagementRepository> getManagementRepositoryInjector() {
return managementRepositoryValue;
}
public Injector<DriverRegistry> getDriverRegistryInjector() {
return driverRegistry;
}
public Injector<SubjectFactory> getSubjectFactoryInjector() {
return subjectFactory;
}
public Injector<CachedConnectionManager> getCcmInjector() {
return ccmValue;
}
protected String buildConfigPropsString(Map<String, String> configProps) {
final StringBuffer valueBuf = new StringBuffer();
for (Map.Entry<String, String> connProperty : configProps.entrySet()) {
valueBuf.append(connProperty.getKey());
valueBuf.append("=");
valueBuf.append(connProperty.getValue());
valueBuf.append(";");
}
return valueBuf.toString();
}
protected TransactionIntegration getTransactionIntegration() {
AccessController.doPrivileged(new SetContextLoaderAction(TransactionIntegration.class.getClassLoader()));
try {
return transactionIntegrationValue.getValue();
} finally {
AccessController.doPrivileged(CLEAR_ACTION);
}
}
private static final SetContextLoaderAction CLEAR_ACTION = new SetContextLoaderAction(null);
private static class SetContextLoaderAction implements PrivilegedAction<Void> {
private final ClassLoader classLoader;
public SetContextLoaderAction(final ClassLoader classLoader) {
this.classLoader = classLoader;
}
public Void run() {
Thread.currentThread().setContextClassLoader(classLoader);
return null;
}
}
protected class AS7DataSourceDeployer extends AbstractDsDeployer {
private final org.jboss.jca.common.api.metadata.ds.DataSource dataSourceConfig;
private final XaDataSource xaDataSourceConfig;
private ServiceContainer serviceContainer;
public AS7DataSourceDeployer(XaDataSource xaDataSourceConfig) {
super();
this.xaDataSourceConfig = xaDataSourceConfig;
this.dataSourceConfig = null;
}
public AS7DataSourceDeployer(org.jboss.jca.common.api.metadata.ds.DataSource dataSourceConfig) {
super();
this.dataSourceConfig = dataSourceConfig;
this.xaDataSourceConfig = null;
}
public CommonDeployment deploy(ServiceContainer serviceContainer) throws DeployException {
try {
if (serviceContainer == null) {
throw new DeployException(MESSAGES.nullVar("ServiceContainer"));
}
this.serviceContainer = serviceContainer;
HashMap<String, org.jboss.jca.common.api.metadata.ds.Driver> drivers = new HashMap<String, org.jboss.jca.common.api.metadata.ds.Driver>(
1);
DataSources dataSources = null;
if (dataSourceConfig != null) {
String driverName = dataSourceConfig.getDriver();
InstalledDriver installedDriver = driverRegistry.getValue().getInstalledDriver(driverName);
if (installedDriver != null) {
String moduleName = installedDriver.getModuleName() != null ? installedDriver.getModuleName().getName()
: null;
org.jboss.jca.common.api.metadata.ds.Driver driver = new DriverImpl(installedDriver.getDriverName(),
installedDriver.getMajorVersion(), installedDriver.getMinorVersion(),
moduleName, installedDriver.getDriverClassName(),
installedDriver.getDataSourceClassName(), installedDriver.getXaDataSourceClassName());
drivers.put(driverName, driver);
dataSources = new DatasourcesImpl(Arrays.asList(dataSourceConfig), null, drivers);
}
} else if (xaDataSourceConfig != null) {
String driverName = xaDataSourceConfig.getDriver();
InstalledDriver installedDriver = driverRegistry.getValue().getInstalledDriver(driverName);
if (installedDriver != null) {
String moduleName = installedDriver.getModuleName() != null ? installedDriver.getModuleName().getName()
: null;
org.jboss.jca.common.api.metadata.ds.Driver driver = new DriverImpl(installedDriver.getDriverName(),
installedDriver.getMajorVersion(), installedDriver.getMinorVersion(), moduleName,
installedDriver.getDriverClassName(),
installedDriver.getDataSourceClassName(), installedDriver.getXaDataSourceClassName());
drivers.put(driverName, driver);
dataSources = new DatasourcesImpl(null, Arrays.asList(xaDataSourceConfig), drivers);
}
}
CommonDeployment c = createObjectsAndInjectValue(new URL("file://DataSourceDeployment"), jndiName,
"uniqueJdbcLocalId", "uniqueJdbcXAId", dataSources, AbstractDataSourceService.class.getClassLoader());
return c;
} catch (MalformedURLException e) {
throw MESSAGES.cannotDeploy(e);
} catch (ValidateException e) {
throw MESSAGES.cannotDeployAndValidate(e);
}
}
@Override
protected ClassLoader getDeploymentClassLoader(String uniqueId) {
return driverValue.getValue().getClass().getClassLoader();
}
@Override
protected String[] bindConnectionFactory(String deployment, final String jndi, Object cf) throws Throwable {
// AS7-2222: Just hack it
if (cf instanceof javax.resource.Referenceable) {
((javax.resource.Referenceable)cf).setReference(new Reference(jndi));
}
// don't register because it's one during add operation
return new String[] { jndi };
}
@Override
protected Object initAndInject(String className, List<? extends ConfigProperty> configs, ClassLoader cl)
throws DeployException {
try {
Class clz = Class.forName(className, true, cl);
Object o = clz.newInstance();
if (configs != null) {
Injection injector = new Injection();
for (ConfigProperty cpmd : configs) {
if (cpmd.isValueSet()) {
boolean setValue = true;
if (cpmd instanceof org.jboss.jca.common.api.metadata.ra.ra16.ConfigProperty16) {
org.jboss.jca.common.api.metadata.ra.ra16.ConfigProperty16 cpmd16 = (org.jboss.jca.common.api.metadata.ra.ra16.ConfigProperty16) cpmd;
if (cpmd16.getConfigPropertyIgnore() != null && cpmd16.getConfigPropertyIgnore().booleanValue())
setValue = false;
}
if (setValue)
injector.inject(cpmd.getConfigPropertyType().getValue(), cpmd.getConfigPropertyName()
.getValue(), cpmd.getConfigPropertyValue().getValue(), o);
}
}
}
return o;
} catch (Throwable t) {
throw MESSAGES.deploymentFailed(t, className);
}
}
@Override
protected SubjectFactory getSubjectFactory(String securityDomain) throws DeployException {
if (securityDomain == null || securityDomain.trim().equals("")) {
return null;
} else {
return subjectFactory.getValue();
}
}
@Override
public CachedConnectionManager getCachedConnectionManager() {
return ccmValue.getValue();
}
@Override
public ManagementRepository getManagementRepository() {
return managementRepositoryValue.getValue();
}
@Override
protected void initAndInjectClassLoaderPlugin(ManagedConnectionFactory mcf, CommonDataSource dsMetadata)
throws DeployException {
((BaseWrapperManagedConnectionFactory) mcf).setClassLoaderPlugin(new ClassLoaderPlugin() {
@Override
public ClassLoader getClassLoader() {
return driverValue.getValue().getClass().getClassLoader();
}
});
}
@Override
public TransactionIntegration getTransactionIntegration() {
AccessController.doPrivileged(new SetContextLoaderAction(TransactionIntegration.class.getClassLoader()));
try {
return transactionIntegrationValue.getValue();
} finally {
AccessController.doPrivileged(CLEAR_ACTION);
}
}
@Override
protected ManagedConnectionFactory createMcf(XaDataSource arg0, String arg1, ClassLoader arg2)
throws NotFoundException, DeployException {
final MyXaMCF xaManagedConnectionFactory = new MyXaMCF();
if (xaDataSourceConfig.getUrlDelimiter() != null) {
try {
xaManagedConnectionFactory.setURLDelimiter(xaDataSourceConfig.getUrlDelimiter());
} catch (ResourceException e) {
throw MESSAGES.failedToGetUrlDelimiter(e);
}
}
if (xaDataSourceConfig.getXaDataSourceClass() != null) {
xaManagedConnectionFactory.setXADataSourceClass(xaDataSourceConfig.getXaDataSourceClass());
}
if (xaDataSourceConfig.getXaDataSourceProperty() != null) {
xaManagedConnectionFactory.setXaProps(xaDataSourceConfig.getXaDataSourceProperty());
}
if (xaDataSourceConfig.getUrlSelectorStrategyClassName() != null) {
xaManagedConnectionFactory
.setUrlSelectorStrategyClassName(xaDataSourceConfig.getUrlSelectorStrategyClassName());
}
if (xaDataSourceConfig.getXaPool() != null && xaDataSourceConfig.getXaPool().isSameRmOverride() != null) {
xaManagedConnectionFactory.setIsSameRMOverrideValue(xaDataSourceConfig.getXaPool().isSameRmOverride());
}
if (xaDataSourceConfig.getNewConnectionSql() != null) {
xaManagedConnectionFactory.setNewConnectionSQL(xaDataSourceConfig.getNewConnectionSql());
}
if (xaDataSourceConfig.getUrlSelectorStrategyClassName() != null) {
xaManagedConnectionFactory
.setUrlSelectorStrategyClassName(xaDataSourceConfig.getUrlSelectorStrategyClassName());
}
setMcfProperties(xaManagedConnectionFactory, xaDataSourceConfig, xaDataSourceConfig.getStatement());
xaManagedConnectionFactory.setUserTransactionJndiName("java:comp/UserTransaction");
return xaManagedConnectionFactory;
}
@Override
protected ManagedConnectionFactory createMcf(org.jboss.jca.common.api.metadata.ds.DataSource arg0, String arg1,
ClassLoader arg2) throws NotFoundException, DeployException {
final LocalManagedConnectionFactory managedConnectionFactory = new LocalManagedConnectionFactory();
managedConnectionFactory.setUserTransactionJndiName("java:comp/UserTransaction");
managedConnectionFactory.setDriverClass(dataSourceConfig.getDriverClass());
if (dataSourceConfig.getUrlDelimiter() != null) {
try {
managedConnectionFactory.setURLDelimiter(dataSourceConfig.getUrlDelimiter());
} catch (Exception e) {
throw MESSAGES.failedToGetUrlDelimiter(e);
}
}
if (dataSourceConfig.getDataSourceClass() != null) {
managedConnectionFactory.setDataSourceClass(dataSourceConfig.getDataSourceClass());
}
if (dataSourceConfig.getConnectionProperties() != null) {
managedConnectionFactory.setConnectionProperties(buildConfigPropsString(dataSourceConfig
.getConnectionProperties()));
}
if (dataSourceConfig.getConnectionUrl() != null) {
managedConnectionFactory.setConnectionURL(dataSourceConfig.getConnectionUrl());
}
if (dataSourceConfig.getNewConnectionSql() != null) {
managedConnectionFactory.setNewConnectionSQL(dataSourceConfig.getNewConnectionSql());
}
if (dataSourceConfig.getUrlSelectorStrategyClassName() != null) {
managedConnectionFactory.setUrlSelectorStrategyClassName(dataSourceConfig.getUrlSelectorStrategyClassName());
}
setMcfProperties(managedConnectionFactory, dataSourceConfig, dataSourceConfig.getStatement());
return managedConnectionFactory;
}
private void setMcfProperties(final BaseWrapperManagedConnectionFactory managedConnectionFactory,
CommonDataSource dataSourceConfig, final Statement statement) {
if (dataSourceConfig.getTransactionIsolation() != null) {
managedConnectionFactory.setTransactionIsolation(dataSourceConfig.getTransactionIsolation().name());
}
final DsSecurity security = dataSourceConfig.getSecurity();
if (security != null) {
if (security.getUserName() != null) {
managedConnectionFactory.setUserName(security.getUserName());
}
if (security.getPassword() != null) {
managedConnectionFactory.setPassword(security.getPassword());
}
}
final TimeOut timeOut = dataSourceConfig.getTimeOut();
if (timeOut != null) {
if (timeOut.getUseTryLock() != null) {
managedConnectionFactory.setUseTryLock(timeOut.getUseTryLock().intValue());
}
if (timeOut.getQueryTimeout() != null) {
managedConnectionFactory.setQueryTimeout(timeOut.getQueryTimeout().intValue());
}
}
if (statement != null) {
if (statement.getTrackStatements() != null) {
managedConnectionFactory.setTrackStatements(statement.getTrackStatements().name());
}
if (statement.isSharePreparedStatements() != null) {
managedConnectionFactory.setSharePreparedStatements(statement.isSharePreparedStatements());
}
if (statement.getPreparedStatementsCacheSize() != null) {
managedConnectionFactory.setPreparedStatementCacheSize(statement.getPreparedStatementsCacheSize()
.intValue());
}
}
final Validation validation = dataSourceConfig.getValidation();
if (validation != null) {
if (validation.isValidateOnMatch()) {
managedConnectionFactory.setValidateOnMatch(validation.isValidateOnMatch());
}
if (validation.getCheckValidConnectionSql() != null) {
managedConnectionFactory.setCheckValidConnectionSQL(validation.getCheckValidConnectionSql());
}
final Extension validConnectionChecker = validation.getValidConnectionChecker();
if (validConnectionChecker != null) {
if (validConnectionChecker.getClassName() != null) {
managedConnectionFactory.setValidConnectionCheckerClassName(validConnectionChecker.getClassName());
}
if (validConnectionChecker.getConfigPropertiesMap() != null) {
managedConnectionFactory
.setValidConnectionCheckerProperties(buildConfigPropsString(validConnectionChecker
.getConfigPropertiesMap()));
}
}
final Extension exceptionSorter = validation.getExceptionSorter();
if (exceptionSorter != null) {
if (exceptionSorter.getClassName() != null) {
managedConnectionFactory.setExceptionSorterClassName(exceptionSorter.getClassName());
}
if (exceptionSorter.getConfigPropertiesMap() != null) {
managedConnectionFactory.setExceptionSorterProperties(buildConfigPropsString(exceptionSorter
.getConfigPropertiesMap()));
}
}
final Extension staleConnectionChecker = validation.getStaleConnectionChecker();
if (staleConnectionChecker != null) {
if (staleConnectionChecker.getClassName() != null) {
managedConnectionFactory.setStaleConnectionCheckerClassName(staleConnectionChecker.getClassName());
}
if (staleConnectionChecker.getConfigPropertiesMap() != null) {
managedConnectionFactory
.setStaleConnectionCheckerProperties(buildConfigPropsString(staleConnectionChecker
.getConfigPropertiesMap()));
}
}
}
}
// Override this method to change how jndiName is build in AS7
@Override
protected String buildJndiName(String rawJndiName, Boolean javaContext) {
final String jndiName;
if (!rawJndiName.startsWith("java:") && javaContext) {
if (rawJndiName.startsWith("jboss/")) {
// Bind to java:jboss/ namespace
jndiName = "java:" + rawJndiName;
} else {
// Bind to java:/ namespace
jndiName= "java:/" + rawJndiName;
}
} else {
jndiName = rawJndiName;
}
return jndiName;
}
@Override
protected DeployersLogger getLogger() {
return DEPLOYERS_LOGGER;
}
}
private class MyXaMCF extends XAManagedConnectionFactory {
private static final long serialVersionUID = 4876371551002746953L;
public void setXaProps(Map<String, String> inputProperties) {
xaProps.putAll(inputProperties);
}
}
}