Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.jboss.jca.deployers.common.AbstractDsDeployer Maven / Gradle / Ivy
/*
* IronJacamar, a Java EE Connector Architecture implementation
* Copyright 2008, 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.jca.deployers.common;
import org.jboss.jca.common.api.metadata.Defaults;
import org.jboss.jca.common.api.metadata.common.Credential;
import org.jboss.jca.common.api.metadata.common.FlushStrategy;
import org.jboss.jca.common.api.metadata.common.Recovery;
import org.jboss.jca.common.api.metadata.ds.CommonDataSource;
import org.jboss.jca.common.api.metadata.ds.DataSource;
import org.jboss.jca.common.api.metadata.ds.DataSources;
import org.jboss.jca.common.api.metadata.ds.DsPool;
import org.jboss.jca.common.api.metadata.ds.DsXaPool;
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.spec.ConfigProperty;
import org.jboss.jca.common.api.metadata.spec.XsdString;
import org.jboss.jca.common.metadata.ds.DataSourceImpl;
import org.jboss.jca.common.metadata.ds.XADataSourceImpl;
import org.jboss.jca.common.metadata.spec.ConfigPropertyImpl;
import org.jboss.jca.core.api.bootstrap.CloneableBootstrapContext;
import org.jboss.jca.core.api.connectionmanager.ccm.CachedConnectionManager;
import org.jboss.jca.core.api.connectionmanager.pool.PoolConfiguration;
import org.jboss.jca.core.api.management.ManagementRepository;
import org.jboss.jca.core.bootstrapcontext.BootstrapContextCoordinator;
import org.jboss.jca.core.connectionmanager.ConnectionManager;
import org.jboss.jca.core.connectionmanager.ConnectionManagerFactory;
import org.jboss.jca.core.connectionmanager.pool.api.Pool;
import org.jboss.jca.core.connectionmanager.pool.api.PoolFactory;
import org.jboss.jca.core.connectionmanager.pool.api.PoolStrategy;
import org.jboss.jca.core.connectionmanager.pool.api.PrefillPool;
import org.jboss.jca.core.connectionmanager.pool.capacity.CapacityFactory;
import org.jboss.jca.core.connectionmanager.pool.mcp.ManagedConnectionPoolFactory;
import org.jboss.jca.core.recovery.DefaultRecoveryPlugin;
import org.jboss.jca.core.spi.mdr.NotFoundException;
import org.jboss.jca.core.spi.recovery.RecoveryPlugin;
import org.jboss.jca.core.spi.security.SubjectFactory;
import org.jboss.jca.core.spi.statistics.Statistics;
import org.jboss.jca.core.spi.transaction.TransactionIntegration;
import org.jboss.jca.core.spi.transaction.XAResourceStatistics;
import org.jboss.jca.core.spi.transaction.recovery.XAResourceRecovery;
import org.jboss.jca.core.spi.transaction.recovery.XAResourceRecoveryRegistry;
import org.jboss.jca.deployers.DeployersBundle;
import org.jboss.jca.deployers.DeployersLogger;
import java.lang.reflect.Method;
import java.net.URL;
import java.security.AccessController;
import java.security.PrivilegedAction;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import java.util.regex.Pattern;
import jakarta.resource.spi.ManagedConnectionFactory;
import jakarta.resource.spi.ResourceAdapter;
import jakarta.resource.spi.ResourceAdapterAssociation;
import jakarta.resource.spi.TransactionSupport.TransactionSupportLevel;
import jakarta.resource.spi.security.PasswordCredential;
import javax.security.auth.Subject;
import org.jboss.logging.Messages;
/**
* An abstract deployer implementation for datasources
*
* @author Stefano Maestri
* @author Jesper Pedersen
*/
public abstract class AbstractDsDeployer
{
/** The bundle */
private static DeployersBundle bundle = Messages.getBundle(DeployersBundle.class);
/** log **/
protected DeployersLogger log;
/** The transaction integration */
protected TransactionIntegration transactionIntegration;
/** xaResourceRecoveryRegistry */
protected XAResourceRecoveryRegistry xaResourceRecoveryRegistry;
/** The ManagementRepository */
private ManagementRepository managementRepository = null;
/** Cached connection manager */
private CachedConnectionManager ccm;
/**
* Create a new AbstractDsDeployer.
*/
public AbstractDsDeployer()
{
this.log = getLogger();
this.transactionIntegration = null;
this.ccm = null;
}
/**
* Set the transaction integration
* @param value The value
*/
public void setTransactionIntegration(TransactionIntegration value)
{
transactionIntegration = value;
}
/**
* Get the transaction integration
* @return The value
*/
public TransactionIntegration getTransactionIntegration()
{
return transactionIntegration;
}
/**
* Get the managementRepository.
*
* @return the managementRepository.
*/
public ManagementRepository getManagementRepository()
{
return managementRepository;
}
/**
* Set the managementRepository.
*
* @param managementRepository The managementRepository to set.
*/
public void setManagementRepository(ManagementRepository managementRepository)
{
this.managementRepository = managementRepository;
}
/**
* Set the ccm
* @param value The value
*/
public void setCachedConnectionManager(CachedConnectionManager value)
{
ccm = value;
}
/**
* Get the ccm
* @return The handle
*/
public CachedConnectionManager getCachedConnectionManager()
{
return ccm;
}
/** Get the xAResourceRecoveryRegistry.
*
* @return the xAResourceRecoveryRegistry.
*/
public XAResourceRecoveryRegistry getXAResourceRecoveryRegistry()
{
return xaResourceRecoveryRegistry;
}
/**
* Set the xAResourceRecoveryRegistry.
*
* @param xAResourceRecoveryRegistry The xAResourceRecoveryRegistry to set.
*/
public void setXAResourceRecoveryRegistry(XAResourceRecoveryRegistry xAResourceRecoveryRegistry)
{
xaResourceRecoveryRegistry = xAResourceRecoveryRegistry;
}
/**
*
* create objects and inject value for this depployment. it is a general method returning a {@link CommonDeployment}
* to be used to exchange objects needed to real injection in the container
*
* @param url url
* @param deploymentName deploymentName
* @param uniqueJdbcLocalId uniqueJdbcLocalId
* @param uniqueJdbcXAId uniqueJdbcXAId
* @param parentClassLoader cl
* @param dataSources datasources metadata defined in xml
* @return return the exchange POJO with value useful for injection in the container (fungal or AS)
* @throws DeployException DeployException
*/
protected CommonDeployment createObjectsAndInjectValue(URL url,
String deploymentName,
String uniqueJdbcLocalId,
String uniqueJdbcXAId,
DataSources dataSources,
ClassLoader parentClassLoader)
throws DeployException
{
try
{
if (numberOfDataSources(dataSources) > 1)
{
if (!verifyTypes(dataSources))
throw new DeployException(bundle.deploymentFailed(url.toExternalForm()));
}
List cfs = new ArrayList(1);
List jndis = new ArrayList(1);
List cms = new ArrayList(1);
List recoveryModules = new ArrayList(1);
List mgts =
new ArrayList(1);
String uniqueId = uniqueJdbcLocalId != null ? uniqueJdbcLocalId : uniqueJdbcXAId;
Map props = new HashMap();
ResourceAdapter resourceAdapter = createRa(uniqueId, parentClassLoader);
String resourceAdapterKey = null;
String bootstrapContextIdentifier = null;
if (needsBootstrapContext(dataSources))
bootstrapContextIdentifier = BootstrapContextCoordinator.getInstance().
createIdentifier(resourceAdapter.getClass().getName(),
props,
null);
if (uniqueJdbcLocalId != null)
{
List ds = dataSources.getDataSource();
if (ds != null && ds.size() > 0)
{
ClassLoader jdbcLocalDeploymentCl = getDeploymentClassLoader(uniqueJdbcLocalId);
for (DataSource dataSource : ds)
{
if (log.isTraceEnabled())
log.tracef("DataSource=%s", stripPassword(dataSource.toString()));
if (dataSource.isEnabled())
{
String jndiName = buildJndiName(dataSource.getJndiName(), dataSource.isUseJavaContext());
try
{
org.jboss.jca.core.api.management.DataSource mgtDataSource =
new org.jboss.jca.core.api.management.DataSource(false);
ConnectionManager[] cm = new ConnectionManager[1];
if (dataSource.getDriverClass() == null && dataSource.getDriver() != null &&
dataSource instanceof DataSourceImpl)
{
String driverClass = null;
if (dataSources.getDriver(dataSource.getDriver()) != null)
driverClass = dataSources.getDriver(dataSource.getDriver()).getDriverClass();
if (driverClass != null)
((DataSourceImpl) dataSource).forceDriverClass(driverClass);
}
if (dataSource.getDriverClass() == null && dataSource.getDriver() != null &&
dataSource instanceof DataSourceImpl)
{
String driverName = dataSource.getDriver();
String moduleId = null;
if (dataSources.getDriver(dataSource.getDriver()) != null)
moduleId = dataSources.getDriver(dataSource.getDriver()).getModule();
String driverClass = getDriver(driverName, moduleId);
if (driverClass != null)
((DataSourceImpl) dataSource).forceDriverClass(driverClass);
}
if (dataSource.getDataSourceClass() == null && dataSource.getDriver() != null &&
dataSource instanceof DataSourceImpl)
{
String driverName = dataSource.getDriver();
if (dataSources.getDriver(driverName) != null)
{
String dataSourceClass = dataSources.getDriver(driverName).getDataSourceClass();
if (dataSourceClass != null)
((DataSourceImpl) dataSource).forceDataSourceClass(dataSourceClass);
}
}
Object cf = deployDataSource(dataSource, jndiName,
uniqueJdbcLocalId, cm, resourceAdapter,
mgtDataSource, jdbcLocalDeploymentCl);
bindConnectionFactory(deploymentName, jndiName, cf);
cfs.add(cf);
jndis.add(jndiName);
cms.add(cm[0]);
mgts.add(mgtDataSource);
log.debugf("Adding management datasource: %s", mgtDataSource);
getManagementRepository().getDataSources().add(mgtDataSource);
}
catch (Throwable t)
{
log.error("Error during the deployment of " + jndiName, t);
}
}
}
}
}
else
{
if (dataSources.getDataSource() != null && dataSources.getDataSource().size() > 0)
log.error("Deployment of datasources disabled since jdbc-local.rar couldn't be found");
}
if (uniqueJdbcXAId != null)
{
List xads = dataSources.getXaDataSource();
if (xads != null && xads.size() > 0)
{
ClassLoader jdbcXADeploymentCl = getDeploymentClassLoader(uniqueJdbcXAId);
for (XaDataSource xaDataSource : xads)
{
if (log.isTraceEnabled())
log.tracef("XaDataSource=%s", stripPassword(xaDataSource.toString()));
if (xaDataSource.isEnabled())
{
String jndiName = buildJndiName(xaDataSource.getJndiName(), xaDataSource.isUseJavaContext());
try
{
org.jboss.jca.core.api.management.DataSource mgtDataSource =
new org.jboss.jca.core.api.management.DataSource(true);
XAResourceRecovery[] recovery = new XAResourceRecovery[1];
ConnectionManager[] cm = new ConnectionManager[1];
if (xaDataSource.getXaDataSourceClass() == null && xaDataSource.getDriver() != null &&
xaDataSource instanceof XADataSourceImpl)
{
((XADataSourceImpl) xaDataSource).forceXaDataSourceClass(dataSources.getDriver(
xaDataSource
.getDriver()).getXaDataSourceClass());
}
Object cf = deployXADataSource(xaDataSource,
jndiName, uniqueJdbcXAId, cm, resourceAdapter,
recovery,
mgtDataSource,
jdbcXADeploymentCl);
bindConnectionFactory(deploymentName, jndiName, cf);
cfs.add(cf);
jndis.add(jndiName);
cms.add(cm[0]);
recoveryModules.add(recovery[0]);
mgts.add(mgtDataSource);
log.debugf("Adding management datasource: %s", mgtDataSource);
getManagementRepository().getDataSources().add(mgtDataSource);
}
catch (Throwable t)
{
log.error("Error during the deployment of " + jndiName, t);
}
}
}
}
}
else
{
if (dataSources.getXaDataSource() != null && dataSources.getXaDataSource().size() > 0)
log.error("Deployment of XA datasources disabled since jdbc-xa.rar couldn't be found");
}
resourceAdapterKey = registerResourceAdapterToResourceAdapterRepository(resourceAdapter);
if (bootstrapContextIdentifier != null)
startContext(resourceAdapter, bootstrapContextIdentifier);
return new CommonDeployment(url, deploymentName, true,
resourceAdapter, resourceAdapterKey,
bootstrapContextIdentifier,
cfs.toArray(new Object[cfs.size()]),
jndis.toArray(new String[jndis.size()]),
cms.toArray(new ConnectionManager[cms.size()]),
null, null,
recoveryModules.toArray(new XAResourceRecovery[recoveryModules.size()]),
null,
mgts.toArray(new org.jboss.jca.core.api.management.DataSource[mgts.size()]),
parentClassLoader, log);
}
catch (DeployException de)
{
throw de;
}
catch (Throwable t)
{
throw new DeployException(bundle.deploymentFailed(url.toExternalForm()), t);
}
}
/**
* Build the jndi name
* @param jndiName The jndi name
* @param javaContext The java context
* @return The value
*/
protected String buildJndiName(String jndiName, Boolean javaContext)
{
if (javaContext != null)
{
if (javaContext.booleanValue() && !jndiName.startsWith("java:"))
{
jndiName = "java:" + jndiName;
}
else if (!javaContext.booleanValue() && jndiName.startsWith("java:"))
{
jndiName = jndiName.substring(6);
}
}
return jndiName;
}
/**
* Get the driver
* @param driverName The name of the driver
* @param moduleId The id of the module
* @return The driver class name; or null if not found
*/
protected String getDriver(String driverName, String moduleId)
{
return null;
}
/**
* Get the number of datasource deployments
* @param datasources The datasources
* @return The number
*/
protected int numberOfDataSources(DataSources datasources)
{
return datasources.getDataSource().size() + datasources.getXaDataSource().size();
}
/**
* Verify the types of the datasources
* @param datasources The datasources
* @return True if all datasources fall into the same caterogy, otherwise false
*/
protected boolean verifyTypes(DataSources datasources)
{
boolean hasNonJTA = false;
boolean hasJTA = datasources.getXaDataSource().size() > 0;
for (DataSource ds : datasources.getDataSource())
{
if (ds.isJTA())
{
hasJTA = true;
}
else
{
hasNonJTA = true;
}
}
if (hasJTA && !hasNonJTA)
return true;
if (hasNonJTA && !hasJTA)
return true;
return false;
}
/**
* Needs a BootstrapContext instance
* @param datasources The datasources
* @return True if needs a context
*/
protected boolean needsBootstrapContext(DataSources datasources)
{
if (datasources.getXaDataSource().size() > 0)
return true;
for (DataSource ds : datasources.getDataSource())
{
if (ds.isJTA())
return true;
}
return false;
}
/**
* Deploy a datasource
* @param ds The datasource
* @param jndiName The JNDI name
* @param uniqueId The unique id for the resource adapter
* @param cma The connection manager array
* @param resourceAdapter The resource adapter
* @param mgtDs The management of a datasource
* @param cl The class loader
* @return The connection factory
* @exception Throwable Thrown if an error occurs during deployment
*/
private Object deployDataSource(DataSource ds, String jndiName, String uniqueId, ConnectionManager[] cma,
ResourceAdapter resourceAdapter,
org.jboss.jca.core.api.management.DataSource mgtDs, ClassLoader cl) throws Throwable
{
ManagedConnectionFactory mcf = createMcf(ds, uniqueId, cl);
associateResourceAdapter(resourceAdapter, mcf);
initAndInjectClassLoaderPlugin(mcf, ds);
// Create the pool
PoolConfiguration pc = createPoolConfiguration(ds.getPool(), ds.getTimeOut(), ds.getValidation());
// Check validation
if (ds.getValidation() != null && !pc.isValidateOnMatch() && !pc.isBackgroundValidation())
{
if (ds.getValidation().getValidConnectionChecker() != null ||
ds.getValidation().getCheckValidConnectionSql() != null)
{
log.enablingValidateOnMatch(jndiName);
pc.setValidateOnMatch(true);
}
}
PoolFactory pf = new PoolFactory();
PoolStrategy strategy = PoolStrategy.ONE_POOL;
boolean isCRI = false;
boolean allowMultipleUsers = false;
if (ds.getPool() != null)
{
if (ds.getPool().isAllowMultipleUsers() != null && ds.getPool().isAllowMultipleUsers().booleanValue())
{
strategy = PoolStrategy.POOL_BY_CRI;
allowMultipleUsers = true;
pc.setMinSize(0);
isCRI = true;
}
}
// Security
Credential credential = null;
String securityDomain = null;
if (ds.getSecurity() != null)
{
if (ds.getSecurity().getReauthPlugin() != null)
{
strategy = PoolStrategy.REAUTH;
credential = ds.getSecurity();
securityDomain = credential.getSecurityDomain();
isCRI = false;
}
else if (ds.getSecurity().getSecurityDomain() != null)
{
if (!allowMultipleUsers)
{
strategy = PoolStrategy.POOL_BY_SUBJECT;
}
else
{
strategy = PoolStrategy.POOL_BY_SUBJECT_AND_CRI;
pc.setMinSize(0);
isCRI = true;
}
credential = ds.getSecurity();
securityDomain = credential.getSecurityDomain();
}
}
String mcpClass = ds.getMcp();
if (mcpClass == null)
{
ManagedConnectionPoolFactory mcpf = new ManagedConnectionPoolFactory();
if (mcpf.isOverride())
mcpClass = mcpf.getDefaultImplementation();
}
if (mcpClass == null)
mcpClass = ManagedConnectionPoolFactory.EXPERIMENTAL_IMPLEMENTATION;
Pool pool = pf.create(strategy, mcf, pc, false, true, mcpClass);
// Capacity
if (ds.getPool() != null)
{
if (ds.getPool().getCapacity() != null)
pool.setCapacity(CapacityFactory.create(ds.getPool().getCapacity(), isCRI));
}
// Connection manager properties
Integer allocationRetry = null;
Long allocationRetryWaitMillis = null;
if (ds.getTimeOut() != null)
{
allocationRetry = ds.getTimeOut().getAllocationRetry();
allocationRetryWaitMillis = ds.getTimeOut().getAllocationRetryWaitMillis();
}
// Register data sources
mgtDs.setJndiName(jndiName);
mgtDs.setPoolConfiguration(pc);
mgtDs.setPool(pool);
if (mcf instanceof Statistics)
mgtDs.setStatistics(((Statistics)mcf).getStatistics());
// Flush strategy
FlushStrategy flushStrategy = FlushStrategy.FAILING_CONNECTION_ONLY;
if (ds.getPool() != null)
flushStrategy = ds.getPool().getFlushStrategy();
boolean connectable = ds.isConnectable() == null ? false : ds.isConnectable().booleanValue();
Boolean tracking = ds.isTracking();
Boolean enlistmentTrace = ds.isEnlistmentTrace();
mgtDs.setEnlistmentTrace(enlistmentTrace);
// Select the correct connection manager
ConnectionManagerFactory cmf = new ConnectionManagerFactory();
ConnectionManager cm = null;
if (ds.isJTA())
{
cm = cmf.createTransactional(TransactionSupportLevel.LocalTransaction, pool,
getSubjectFactory(credential, ds.getJndiName()), securityDomain,
ds.isUseCcm(), getCachedConnectionManager(),
true, true, connectable, tracking, mgtDs,
flushStrategy,
allocationRetry, allocationRetryWaitMillis,
getTransactionIntegration(),
null, null, null, null, null);
}
else
{
cm = cmf.createNonTransactional(TransactionSupportLevel.NoTransaction, pool,
getSubjectFactory(credential, ds.getJndiName()), securityDomain,
ds.isUseCcm(), getCachedConnectionManager(),
true, true, connectable, tracking,
flushStrategy, allocationRetry, allocationRetryWaitMillis);
}
cm.setJndiName(jndiName);
cma[0] = cm;
String poolName = null;
if (ds.getPoolName() != null)
{
poolName = ds.getPoolName();
}
if (poolName == null)
poolName = jndiName;
pool.setName(poolName);
injectValue(mcf, "setJndiName", jndiName);
// Spy
if (ds.isSpy())
{
injectValue(mcf, "setSpy", Boolean.TRUE);
}
// JTA
if (ds.isJTA())
{
injectValue(mcf, "setJTA", Boolean.TRUE);
}
else
{
injectValue(mcf, "setJTA", Boolean.FALSE);
}
// Reauth
if (strategy == PoolStrategy.REAUTH)
{
injectValue(mcf, "setReauthEnabled", Boolean.TRUE);
injectValue(mcf, "setReauthPluginClassName", ds.getSecurity().getReauthPlugin().getClassName());
Map mps = ds.getSecurity().getReauthPlugin().getConfigPropertiesMap();
if (mps.size() > 0)
{
StringBuilder reauthPluginProperties = new StringBuilder();
Iterator> entryIterator = mps.entrySet().iterator();
while (entryIterator.hasNext())
{
Map.Entry entry = entryIterator.next();
reauthPluginProperties.append(entry.getKey());
reauthPluginProperties.append("|");
reauthPluginProperties.append(entry.getValue());
if (entryIterator.hasNext())
reauthPluginProperties.append(",");
}
injectValue(mcf, "setReauthPluginProperties", reauthPluginProperties.toString());
}
}
// ConnectionListener
if (ds.getPool() != null)
{
DsPool dsPool = ds.getPool();
if (dsPool.getConnectionListener() != null)
{
injectValue(mcf, "setConnectionListenerClassName", dsPool.getConnectionListener().getClassName());
Map mps = dsPool.getConnectionListener().getConfigPropertiesMap();
if (mps.size() > 0)
{
StringBuilder connectionListenerProperties = new StringBuilder();
Iterator> entryIterator = mps.entrySet().iterator();
while (entryIterator.hasNext())
{
Map.Entry entry = entryIterator.next();
connectionListenerProperties.append(entry.getKey());
connectionListenerProperties.append("|");
connectionListenerProperties.append(entry.getValue());
if (entryIterator.hasNext())
connectionListenerProperties.append(",");
}
injectValue(mcf, "setConnectionListenerProperties", connectionListenerProperties.toString());
}
}
}
// Prefill
if (pool instanceof PrefillPool)
{
PrefillPool pp = (PrefillPool)pool;
SubjectFactory subjectFactory = getSubjectFactory(credential, ds.getJndiName());
Subject subject = null;
if (subjectFactory != null)
subject = createSubject(subjectFactory, securityDomain, mcf, jndiName);
pp.prefill(subject, null, false);
}
if (ds.getDataSourceClass() != null && ds.getConnectionProperties().isEmpty() && ds.getConnectionUrl() != null)
getLogger().connectionPropertiesEmpty(jndiName, ds.getDriverClass(), ds.getConnectionUrl());
// ConnectionFactory
return mcf.createConnectionFactory(cm);
}
/**
* Deploy an XA datasource
* @param ds The datasource
* @param jndiName The JNDI name
* @param uniqueId The unique id for the resource adapter
* @param cma The connection manager array
* @param resourceAdapter The resource adapter
* @param recovery The recovery module
* @param mgtDs The management of a datasource
* @param cl The class loader
* @return The connection factory
* @exception Throwable Thrown if an error occurs during deployment
*/
private Object deployXADataSource(XaDataSource ds, String jndiName, String uniqueId, ConnectionManager[] cma,
ResourceAdapter resourceAdapter, XAResourceRecovery[] recovery,
org.jboss.jca.core.api.management.DataSource mgtDs, ClassLoader cl)
throws Throwable
{
ManagedConnectionFactory mcf = createMcf(ds, uniqueId, cl);
associateResourceAdapter(resourceAdapter, mcf);
initAndInjectClassLoaderPlugin(mcf, ds);
// Create the pool
PoolConfiguration pc = createPoolConfiguration(ds.getXaPool(), ds.getTimeOut(), ds.getValidation());
// Check validation
if (ds.getValidation() != null && !pc.isValidateOnMatch() && !pc.isBackgroundValidation())
{
if (ds.getValidation().getValidConnectionChecker() != null ||
ds.getValidation().getCheckValidConnectionSql() != null)
{
log.enablingValidateOnMatch(jndiName);
pc.setValidateOnMatch(true);
}
}
Boolean noTxSeparatePool = Defaults.NO_TX_SEPARATE_POOL;
if (ds.getXaPool() != null && ds.getXaPool().isNoTxSeparatePool() != null)
noTxSeparatePool = ds.getXaPool().isNoTxSeparatePool();
PoolFactory pf = new PoolFactory();
PoolStrategy strategy = PoolStrategy.ONE_POOL;
boolean isCRI = false;
boolean allowMultipleUsers = false;
if (ds.getXaPool() != null)
{
DsXaPool dsXaPool = ds.getXaPool();
if (dsXaPool.isAllowMultipleUsers() != null && dsXaPool.isAllowMultipleUsers().booleanValue())
{
strategy = PoolStrategy.POOL_BY_CRI;
allowMultipleUsers = true;
pc.setMinSize(0);
isCRI = true;
}
}
// Security
Credential credential = null;
String securityDomain = null;
if (ds.getSecurity() != null)
{
if (ds.getSecurity().getReauthPlugin() != null)
{
strategy = PoolStrategy.REAUTH;
credential = ds.getSecurity();
securityDomain = credential.getSecurityDomain();
isCRI = false;
}
else if (ds.getSecurity().getSecurityDomain() != null)
{
if (!allowMultipleUsers)
{
strategy = PoolStrategy.POOL_BY_SUBJECT;
}
else
{
strategy = PoolStrategy.POOL_BY_SUBJECT_AND_CRI;
pc.setMinSize(0);
isCRI = true;
}
credential = ds.getSecurity();
securityDomain = credential.getSecurityDomain();
}
}
String mcpClass = ds.getMcp();
if (mcpClass == null)
{
ManagedConnectionPoolFactory mcpf = new ManagedConnectionPoolFactory();
if (mcpf.isOverride())
mcpClass = mcpf.getDefaultImplementation();
}
if (mcpClass == null)
mcpClass = ManagedConnectionPoolFactory.EXPERIMENTAL_IMPLEMENTATION;
Pool pool = pf.create(strategy, mcf, pc, noTxSeparatePool.booleanValue(), true, mcpClass);
// Capacity
if (ds.getXaPool() != null)
{
DsXaPool dsXaPool = ds.getXaPool();
if (dsXaPool.getCapacity() != null)
pool.setCapacity(CapacityFactory.create(dsXaPool.getCapacity(), isCRI));
}
// Connection manager properties
Integer allocationRetry = null;
Long allocationRetryWaitMillis = null;
Boolean interleaving = Defaults.INTERLEAVING;
Integer xaResourceTimeout = null;
Boolean isSameRMOverride = Defaults.IS_SAME_RM_OVERRIDE;
Boolean wrapXAResource = Defaults.WRAP_XA_RESOURCE;
Boolean padXid = Defaults.PAD_XID;
if (ds.getTimeOut() != null)
{
allocationRetry = ds.getTimeOut().getAllocationRetry();
allocationRetryWaitMillis = ds.getTimeOut().getAllocationRetryWaitMillis();
xaResourceTimeout = ds.getTimeOut().getXaResourceTimeout();
}
if (ds.getXaPool() != null)
{
interleaving = ds.getXaPool().isInterleaving();
isSameRMOverride = ds.getXaPool().isSameRmOverride();
wrapXAResource = ds.getXaPool().isWrapXaResource();
padXid = ds.getXaPool().isPadXid();
}
pool.setInterleaving(interleaving.booleanValue());
// Register data sources
mgtDs.setJndiName(jndiName);
mgtDs.setPoolConfiguration(pc);
mgtDs.setPool(pool);
if (mcf instanceof Statistics)
mgtDs.setStatistics(((Statistics)mcf).getStatistics());
// Flush strategy
FlushStrategy flushStrategy = FlushStrategy.FAILING_CONNECTION_ONLY;
if (ds.getXaPool() != null)
flushStrategy = ds.getXaPool().getFlushStrategy();
boolean connectable = ds.isConnectable() == null ? false : ds.isConnectable().booleanValue();
Boolean tracking = ds.isTracking();
Boolean enlistmentTrace = ds.isEnlistmentTrace();
mgtDs.setEnlistmentTrace(enlistmentTrace);
// Select the correct connection manager
TransactionSupportLevel tsl = TransactionSupportLevel.XATransaction;
ConnectionManagerFactory cmf = new ConnectionManagerFactory();
ConnectionManager cm =
cmf.createTransactional(tsl, pool, getSubjectFactory(credential, ds.getJndiName()), securityDomain,
ds.isUseCcm(), getCachedConnectionManager(),
true, true, connectable, tracking, mgtDs,
flushStrategy,
allocationRetry, allocationRetryWaitMillis,
getTransactionIntegration(), interleaving,
xaResourceTimeout, isSameRMOverride, wrapXAResource, padXid);
cm.setJndiName(jndiName);
cma[0] = cm;
String poolName = null;
if (ds.getPoolName() != null)
{
poolName = ds.getPoolName();
}
if (poolName == null)
poolName = jndiName;
pool.setName(poolName);
injectValue(mcf, "setJndiName", jndiName);
// Spy
if (ds.isSpy())
{
injectValue(mcf, "setSpy", Boolean.TRUE);
}
// Url property
injectValue(mcf, "setURLProperty", ds.getUrlProperty());
// Reauth
if (strategy == PoolStrategy.REAUTH)
{
injectValue(mcf, "setReauthEnabled", Boolean.TRUE);
injectValue(mcf, "setReauthPluginClassName", ds.getSecurity().getReauthPlugin().getClassName());
Map mps = ds.getSecurity().getReauthPlugin().getConfigPropertiesMap();
if (mps.size() > 0)
{
StringBuilder reauthPluginProperties = new StringBuilder();
Iterator> entryIterator = mps.entrySet().iterator();
while (entryIterator.hasNext())
{
Map.Entry entry = entryIterator.next();
reauthPluginProperties.append(entry.getKey());
reauthPluginProperties.append("|");
reauthPluginProperties.append(entry.getValue());
if (entryIterator.hasNext())
reauthPluginProperties.append(",");
}
injectValue(mcf, "setReauthPluginProperties", reauthPluginProperties.toString());
}
}
// ConnectionListener
if (ds.getXaPool() != null)
{
DsXaPool dsXaPool = ds.getXaPool();
if (dsXaPool.getConnectionListener() != null)
{
injectValue(mcf, "setConnectionListenerClassName", dsXaPool.getConnectionListener().getClassName());
Map mps = dsXaPool.getConnectionListener().getConfigPropertiesMap();
if (mps.size() > 0)
{
StringBuilder connectionListenerProperties = new StringBuilder();
Iterator> entryIterator = mps.entrySet().iterator();
while (entryIterator.hasNext())
{
Map.Entry entry = entryIterator.next();
connectionListenerProperties.append(entry.getKey());
connectionListenerProperties.append("|");
connectionListenerProperties.append(entry.getValue());
if (entryIterator.hasNext())
connectionListenerProperties.append(",");
}
injectValue(mcf, "setConnectionListenerProperties", connectionListenerProperties.toString());
}
}
}
Recovery recoveryMD = ds.getRecovery();
Credential defaultCredential = null;
String defaultUserName = null;
String defaultPassword = null;
String defaultSecurityDomain = null;
if (ds.getSecurity() != null)
{
defaultCredential = ds.getSecurity();
defaultSecurityDomain = defaultCredential.getSecurityDomain();
defaultUserName = defaultCredential.getUserName();
defaultPassword = defaultCredential.getPassword();
}
Credential recoverCredential = defaultCredential;
String recoverSecurityDomain = defaultSecurityDomain;
String recoverUser = defaultUserName;
String recoverPassword = defaultPassword;
XAResourceRecovery recoveryImpl = null;
boolean enableRecovery = false;
if (recoveryMD == null || !recoveryMD.getNoRecovery())
{
// If we have an XAResourceRecoveryRegistry and the deployment is XA
// lets register it for XA Resource Recovery using the "recovery" definition
// Fallback to the standard definitions for
// user name, password. Keep a seperate reference to the security-domain
enableRecovery = true;
if (recoveryMD != null) {
recoverCredential = recoveryMD.getCredential();
}
if (recoverCredential != null)
{
if (recoverCredential.getSecurityDomain() != null)
recoverSecurityDomain = recoverCredential.getSecurityDomain();
if (recoverCredential.getUserName() != null)
recoverUser = recoverCredential.getUserName();
if (recoverCredential.getPassword() != null)
recoverPassword = recoverCredential.getPassword();
}
if (log.isDebugEnabled())
{
log.debug("RecoverUser=" + recoverUser);
log.debug("RecoverSecurityDomain=" + recoverSecurityDomain);
}
if ((recoverUser != null && !recoverUser.trim().equals("") &&
recoverPassword != null && !recoverPassword.trim().equals("")) ||
(recoverSecurityDomain != null && !recoverSecurityDomain.trim().equals("")))
{
RecoveryPlugin plugin = null;
if (recoveryMD != null && recoveryMD.getRecoverPlugin() != null &&
recoveryMD.getRecoverPlugin().getClassName() != null)
{
List configProperties = new ArrayList(recoveryMD.getRecoverPlugin()
.getConfigPropertiesMap().size());
for (Entry property : recoveryMD.getRecoverPlugin().getConfigPropertiesMap()
.entrySet())
{
ConfigProperty c =
new ConfigPropertyImpl(null,
new XsdString(property.getKey(), null),
XsdString.NULL_XSDSTRING,
new XsdString(property.getValue(), null),
Boolean.FALSE, Boolean.FALSE, Boolean.FALSE,
null, false, null, null, null, null);
configProperties.add(c);
}
plugin = (RecoveryPlugin) initAndInject(recoveryMD.getRecoverPlugin().getClassName(),
configProperties, cl);
}
else
{
plugin = new DefaultRecoveryPlugin();
}
XAResourceStatistics xastat = null;
if (pool.getStatistics() != null && pool.getStatistics() instanceof XAResourceStatistics)
{
xastat = (XAResourceStatistics)pool.getStatistics();
}
recoveryImpl =
getTransactionIntegration().createXAResourceRecovery(mcf,
padXid,
isSameRMOverride,
wrapXAResource,
recoverUser,
recoverPassword,
recoverSecurityDomain,
getSubjectFactory(recoverCredential,
ds.getJndiName()),
plugin,
xastat);
}
}
if (enableRecovery && getTransactionIntegration().getRecoveryRegistry() != null)
{
if (recoveryImpl != null)
{
recoveryImpl.setJndiName(cm.getJndiName());
recoveryImpl.initialize();
getTransactionIntegration().getRecoveryRegistry().addXAResourceRecovery(recoveryImpl);
recovery[0] = recoveryImpl;
}
else
{
log.missingRecovery(cm.getJndiName());
}
}
// Prefill
if (pool instanceof PrefillPool)
{
PrefillPool pp = (PrefillPool)pool;
SubjectFactory subjectFactory = getSubjectFactory(credential, ds.getJndiName());
Subject subject = null;
if (subjectFactory != null)
subject = createSubject(subjectFactory, securityDomain, mcf, jndiName);
pp.prefill(subject, null, noTxSeparatePool.booleanValue());
}
// ConnectionFactory
return mcf.createConnectionFactory(cm);
}
/**
* Start the resource adapter
* @param resourceAdapter The resource adapter
* @param bootstrapContextIdentifier The bootstrap context identifier
* @throws DeployException DeployException Thrown if the resource adapter cant be started
*/
@SuppressWarnings("unchecked")
protected void startContext(jakarta.resource.spi.ResourceAdapter resourceAdapter, String bootstrapContextIdentifier)
throws DeployException
{
try
{
CloneableBootstrapContext cbc =
BootstrapContextCoordinator.getInstance().createBootstrapContext(bootstrapContextIdentifier,
null);
cbc.setResourceAdapter(resourceAdapter);
resourceAdapter.start(cbc);
}
catch (Throwable t)
{
throw new DeployException(bundle.unableToStartResourceAdapter(resourceAdapter.getClass().getName()), t);
}
}
/**
* Associate resource adapter with ojects if they implement ResourceAdapterAssociation
* @param resourceAdapter resourceAdapter resourceAdapter The resource adapter
* @param object object object The of possible association object
* @throws DeployException DeployException Thrown if the resource adapter cant be started
*/
@SuppressWarnings("unchecked")
protected void associateResourceAdapter(ResourceAdapter resourceAdapter, Object object)
throws DeployException
{
if (resourceAdapter != null && object != null)
{
if (object instanceof ResourceAdapterAssociation)
{
try
{
ResourceAdapterAssociation raa = (ResourceAdapterAssociation)object;
raa.setResourceAdapter(resourceAdapter);
}
catch (Throwable t)
{
throw new DeployException(bundle.unableToAssociate(object.getClass().getName()), t);
}
}
}
}
/**
* Create Ra
*
* @param uniqueId the uniqueId
* @param cl the classloader
* @return the resource adapter
* @throws NotFoundException in case it's not found in cl
* @throws Exception in case of other error
* @throws DeployException in case of deploy error
*/
protected abstract ResourceAdapter createRa(String uniqueId, ClassLoader cl)
throws NotFoundException, Exception, DeployException;
/**
* Register the ResourceAdapter to the ResourceAdapterRepository. Implementer should provide the implementation
* to get repository and do the registration
* @param instance the instance
* @return The key
*/
protected abstract String
registerResourceAdapterToResourceAdapterRepository(jakarta.resource.spi.ResourceAdapter instance);
/**
* Create Mcf for xads
*
* @param ds the xsds
* @param uniqueId the uniqueId
* @param cl the classloader
* @return the mcf
* @throws NotFoundException in case it's not found in cl
* @throws Exception in case of other errro
* @throws DeployException in case of deoloy error
*/
protected abstract ManagedConnectionFactory createMcf(XaDataSource ds, String uniqueId, ClassLoader cl)
throws NotFoundException, Exception, DeployException;
/**
* Create Mcf for ds
*
* @param ds the xsds
* @param uniqueId the uniqueId
* @param cl the classloader
* @return the mcf
* @throws NotFoundException in case it's not found in cl
* @throws Exception in case of other errro
* @throws DeployException in case of deoloy error
*/
protected abstract ManagedConnectionFactory createMcf(DataSource ds, String uniqueId, ClassLoader cl)
throws NotFoundException, Exception, DeployException;
/**
* Create an instance of the pool configuration based on the input
* @param pp The pool parameters
* @param tp The timeout parameters
* @param vp The validation parameters
* @return The configuration
*/
private PoolConfiguration createPoolConfiguration(org.jboss.jca.common.api.metadata.common.Pool pp,
TimeOut tp, Validation vp)
{
PoolConfiguration pc = new PoolConfiguration();
if (pp != null)
{
if (pp.getMinPoolSize() != null)
pc.setMinSize(pp.getMinPoolSize().intValue());
if (pp.getInitialPoolSize() != null)
pc.setInitialSize(pp.getInitialPoolSize().intValue());
if (pp.getMaxPoolSize() != null)
pc.setMaxSize(pp.getMaxPoolSize().intValue());
if (pp.isPrefill() != null)
pc.setPrefill(pp.isPrefill());
if (pp.isUseStrictMin() != null)
pc.setStrictMin(pp.isUseStrictMin());
if (pp.isFair() != null)
pc.setFair(pp.isFair());
}
if (tp != null)
{
if (tp.getBlockingTimeoutMillis() != null)
pc.setBlockingTimeout(tp.getBlockingTimeoutMillis().longValue());
if (tp.getIdleTimeoutMinutes() != null)
pc.setIdleTimeoutMinutes(tp.getIdleTimeoutMinutes().intValue());
}
if (vp != null)
{
if (vp.isValidateOnMatch() != null)
pc.setValidateOnMatch(vp.isValidateOnMatch().booleanValue());
if (vp.isBackgroundValidation() != null)
pc.setBackgroundValidation(vp.isBackgroundValidation().booleanValue());
if (vp.getBackgroundValidationMillis() != null)
pc.setBackgroundValidationMillis(vp.getBackgroundValidationMillis().intValue());
if (vp.isUseFastFail() != null)
pc.setUseFastFail(vp.isUseFastFail());
}
return pc;
}
/**
* Inject value
* @param o The object
* @param methodName The method name
* @param value The value
* @exception Exception Thrown in case of an error
*/
private void injectValue(Object o, String methodName, Object value) throws Exception
{
// Method has to be public
Method[] methods = SecurityActions.getMethods(o.getClass());
boolean found = false;
for (int i = 0; !found && i < methods.length; i++)
{
Method m = methods[i];
SecurityActions.setAccessible(m);
if (m.getName().equals(methodName) && m.getParameterCount() == 1)
{
m.invoke(o, value);
found = true;
}
}
}
/**
* Strip password
* @param str The string
* @return The result
*/
private String stripPassword(String str)
{
if (str.indexOf("") == -1)
return str;
Pattern pattern = Pattern.compile("[^<]* ");
String[] strs = pattern.split(str);
StringBuilder sb = new StringBuilder();
for (int i = 0; i < strs.length; i++)
{
String s = strs[i];
sb.append(s);
if (i < strs.length - 1)
sb.append("**** ");
}
return sb.toString();
}
/**
* Provide the classloader of the deployment identified by the unique id
* @param uniqueId The
* @return The classloader used by this deployment
*/
protected abstract ClassLoader getDeploymentClassLoader(String uniqueId);
/**
* Bind connection factory into JNDI
* @param deployment The deployment name
* @param cf The connection factory
* @param jndi passed jndi name
* @return The JNDI names bound
* @exception Throwable Thrown if an error occurs
*/
protected abstract String[] bindConnectionFactory(String deployment, String jndi, Object cf) throws Throwable;
/**
* Initialize and inject configuration properties
* @param className The fully qualified class name
* @param configs The configuration properties
* @param cl The class loader
* @return The object
* @throws DeployException Thrown if the object cant be initialized
*/
protected abstract Object initAndInject(String className, List configs, ClassLoader cl)
throws DeployException;
/**
*
* Initialize and inject class loader plugin
*
* @param mcf The managed connection factory
* @param dsMetadata The dataSource metadata
* @throws DeployException Thrown if the object cant be initialized or injected
*/
protected void initAndInjectClassLoaderPlugin(ManagedConnectionFactory mcf, CommonDataSource dsMetadata)
throws DeployException
{
//Default impl is doing nothing, delagating to MCF the default plugin instance creation
}
/**
* Get a subject factory
* @param credential The security credential
* @param jndiName optionally used for authentication context matching
* @return The subject factory; must return null if credential security isn't enabled or if credential
* is {@code null}
* @exception DeployException Thrown if the security info can't be resolved
*/
protected abstract SubjectFactory getSubjectFactory(Credential credential, String jndiName) throws DeployException;
/**
* Get the logger
* @return The value
*/
protected abstract DeployersLogger getLogger();
/**
* Create a subject
* @param subjectFactory The subject factory
* @param securityDomain The security domain
* @param mcf The managed connection factory
* @param jndiName The jndi-name of the data-source
* @return The subject; null in case of an error
*/
protected Subject createSubject(final SubjectFactory subjectFactory,
final String securityDomain,
final ManagedConnectionFactory mcf,
final String jndiName)
{
if (subjectFactory == null)
throw new IllegalArgumentException("SubjectFactory is null");
if (securityDomain == null)
throw new IllegalArgumentException("SecurityDomain is null");
return AccessController.doPrivileged(new PrivilegedAction()
{
public Subject run()
{
try
{
Subject subject = subjectFactory.createSubject(securityDomain);
Set pcs = subject.getPrivateCredentials(PasswordCredential.class);
if (pcs.size() > 0)
{
for (PasswordCredential pc : pcs)
{
pc.setManagedConnectionFactory(mcf);
}
}
if (log.isDebugEnabled())
log.debug("Subject=" + subject);
return subject;
}
catch (Throwable t)
{
log.error("Exception during createSubject() for " + jndiName + ": " + t.getMessage(), t);
}
return null;
}
});
}
}
