/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.openejb.config;
import org.apache.openejb.OpenEJBException;
import org.apache.openejb.Vendor;
import org.apache.openejb.assembler.classic.AppInfo;
import org.apache.openejb.assembler.classic.Assembler;
import org.apache.openejb.assembler.classic.BmpEntityContainerInfo;
import org.apache.openejb.assembler.classic.ClientInfo;
import org.apache.openejb.assembler.classic.CmpEntityContainerInfo;
import org.apache.openejb.assembler.classic.ConnectionManagerInfo;
import org.apache.openejb.assembler.classic.ConnectorInfo;
import org.apache.openejb.assembler.classic.ContainerInfo;
import org.apache.openejb.assembler.classic.ContainerSystemInfo;
import org.apache.openejb.assembler.classic.EjbJarInfo;
import org.apache.openejb.assembler.classic.FacilitiesInfo;
import org.apache.openejb.assembler.classic.HandlerChainInfo;
import org.apache.openejb.assembler.classic.HandlerInfo;
import org.apache.openejb.assembler.classic.JndiContextInfo;
import org.apache.openejb.assembler.classic.ManagedContainerInfo;
import org.apache.openejb.assembler.classic.MdbContainerInfo;
import org.apache.openejb.assembler.classic.OpenEjbConfiguration;
import org.apache.openejb.assembler.classic.OpenEjbConfigurationFactory;
import org.apache.openejb.assembler.classic.ProxyFactoryInfo;
import org.apache.openejb.assembler.classic.ResourceInfo;
import org.apache.openejb.assembler.classic.SecurityServiceInfo;
import org.apache.openejb.assembler.classic.ServiceInfo;
import org.apache.openejb.assembler.classic.SingletonSessionContainerInfo;
import org.apache.openejb.assembler.classic.StatefulSessionContainerInfo;
import org.apache.openejb.assembler.classic.StatelessSessionContainerInfo;
import org.apache.openejb.assembler.classic.TransactionServiceInfo;
import org.apache.openejb.assembler.classic.WebAppInfo;
import org.apache.openejb.config.sys.AbstractService;
import org.apache.openejb.config.sys.ConnectionManager;
import org.apache.openejb.config.sys.Container;
import org.apache.openejb.config.sys.Deployments;
import org.apache.openejb.config.sys.JaxbOpenejb;
import org.apache.openejb.config.sys.JndiProvider;
import org.apache.openejb.config.sys.Openejb;
import org.apache.openejb.config.sys.ProxyFactory;
import org.apache.openejb.config.sys.Resource;
import org.apache.openejb.config.sys.SecurityService;
import org.apache.openejb.config.sys.ServiceProvider;
import org.apache.openejb.config.sys.TransactionManager;
import org.apache.openejb.jee.Application;
import org.apache.openejb.jee.EjbJar;
import org.apache.openejb.jee.Handler;
import org.apache.openejb.jee.HandlerChain;
import org.apache.openejb.jee.HandlerChains;
import org.apache.openejb.jee.ParamValue;
import org.apache.openejb.loader.FileUtils;
import org.apache.openejb.loader.Options;
import org.apache.openejb.loader.SystemInstance;
import org.apache.openejb.util.LogCategory;
import org.apache.openejb.util.Logger;
import org.apache.openejb.util.Messages;
import org.apache.openejb.util.SuperProperties;
import org.apache.openejb.util.URISupport;
import org.apache.openejb.util.URLs;
import javax.ejb.embeddable.EJBContainer;
import java.io.File;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
import static org.apache.openejb.config.DeploymentsResolver.DEPLOYMENTS_CLASSPATH_PROPERTY;
import static org.apache.openejb.config.ServiceUtils.implies;
public class ConfigurationFactory implements OpenEjbConfigurationFactory {
static final String CONFIGURATION_PROPERTY = "openejb.configuration";
static final String CONF_FILE_PROPERTY = "openejb.conf.file";
private static final String DEBUGGABLE_VM_HACKERY_PROPERTY = "openejb.debuggable-vm-hackery";
protected static final String VALIDATION_SKIP_PROPERTY = "openejb.validation.skip";
private static final Logger logger = Logger.getInstance(LogCategory.OPENEJB_STARTUP_CONFIG, ConfigurationFactory.class);
private static final Messages messages = new Messages(ConfigurationFactory.class);
private String configLocation;
private OpenEjbConfiguration sys;
private Openejb openejb;
private DynamicDeployer deployer;
private final DeploymentLoader deploymentLoader;
private final boolean offline;
private static final String CLASSPATH_AS_EAR = "openejb.deployments.classpath.ear";
static final String WEBSERVICES_ENABLED = "openejb.webservices.enabled";
public ConfigurationFactory() {
this(false);
}
public ConfigurationFactory(boolean offline) {
this(offline, (DynamicDeployer) null);
}
public ConfigurationFactory(boolean offline, DynamicDeployer preAutoConfigDeployer) {
this.offline = offline;
this.deploymentLoader = new DeploymentLoader();
Options options = SystemInstance.get().getOptions();
Chain chain = new Chain();
chain.add(new GeneratedClientModules.Add());
chain.add(new ReadDescriptors());
chain.add(new LegacyProcessor());
chain.add(new AnnotationDeployer());
chain.add(new GeneratedClientModules.Prune());
chain.add(new ClearEmptyMappedName());
//START SNIPPET: code
if (!options.get(VALIDATION_SKIP_PROPERTY, false)) {
chain.add(new ValidateModules());
} else {
DeploymentLoader.logger.info("validationDisabled", VALIDATION_SKIP_PROPERTY);
}
//END SNIPPET: code
chain.add(new InitEjbDeployments());
if (options.get(DEBUGGABLE_VM_HACKERY_PROPERTY, false)) {
chain.add(new DebuggableVmHackery());
}
if (options.get(WEBSERVICES_ENABLED, true)) {
chain.add(new WsDeployer());
} else {
chain.add(new RemoveWebServices());
}
chain.add(new CmpJpaConversion());
// By default all vendor support is enabled
Set<Vendor> support = SystemInstance.get().getOptions().getAll("openejb.vendor.config", Vendor.values());
if (support.contains(Vendor.GERONIMO) || SystemInstance.get().hasProperty("openejb.geronimo")) {
chain.add(new OpenEjb2Conversion());
}
if (support.contains(Vendor.GLASSFISH)) {
chain.add(new SunConversion());
}
if (support.contains(Vendor.WEBLOGIC)) {
chain.add(new WlsConversion());
}
if (SystemInstance.get().hasProperty("openejb.geronimo")) {
// must be after CmpJpaConversion since it adds new persistence-context-refs
chain.add(new GeronimoMappedName());
}
if (null != preAutoConfigDeployer) {
chain.add(preAutoConfigDeployer);
}
chain.add(new ConvertDataSourceDefinitions());
chain.add(new CleanEnvEntries());
chain.add(new LinkBuiltInTypes());
if (offline) {
AutoConfig autoConfig = new AutoConfig(this);
autoConfig.autoCreateResources(false);
autoConfig.autoCreateContainers(false);
chain.add(autoConfig);
} else {
chain.add(new AutoConfig(this));
}
chain.add(new ApplyOpenejbJar());
chain.add(new MappedNameBuilder());
chain.add(new ActivationConfigPropertyOverride());
chain.add(new OutputGeneratedDescriptors());
// chain.add(new MergeWebappJndiContext());
this.deployer = chain;
}
public ConfigurationFactory(boolean offline, OpenEjbConfiguration configuration) {
this(offline, (DynamicDeployer) null, configuration);
}
public ConfigurationFactory(boolean offline,
DynamicDeployer preAutoConfigDeployer,
OpenEjbConfiguration configuration) {
this(offline, preAutoConfigDeployer);
sys = configuration;
}
public ConfigurationFactory(boolean offline, Chain deployerChain, OpenEjbConfiguration configuration) {
this.offline = offline;
this.deploymentLoader = new DeploymentLoader();
this.deployer = deployerChain;
this.sys = configuration;
}
public static List<HandlerChainInfo> toHandlerChainInfo(HandlerChains chains) {
List<HandlerChainInfo> handlerChains = new ArrayList<HandlerChainInfo>();
if (chains == null) return handlerChains;
for (HandlerChain handlerChain : chains.getHandlerChain()) {
HandlerChainInfo handlerChainInfo = new HandlerChainInfo();
handlerChainInfo.serviceNamePattern = handlerChain.getServiceNamePattern();
handlerChainInfo.portNamePattern = handlerChain.getPortNamePattern();
handlerChainInfo.protocolBindings.addAll(handlerChain.getProtocolBindings());
for (Handler handler : handlerChain.getHandler()) {
HandlerInfo handlerInfo = new HandlerInfo();
handlerInfo.handlerName = handler.getHandlerName();
handlerInfo.handlerClass = handler.getHandlerClass();
handlerInfo.soapHeaders.addAll(handler.getSoapHeader());
handlerInfo.soapRoles.addAll(handler.getSoapRole());
for (ParamValue param : handler.getInitParam()) {
handlerInfo.initParams.setProperty(param.getParamName(), param.getParamValue());
}
handlerChainInfo.handlers.add(handlerInfo);
}
handlerChains.add(handlerChainInfo);
}
return handlerChains;
}
public static class Chain implements DynamicDeployer {
private final List<DynamicDeployer> chain = new ArrayList<DynamicDeployer>();
public boolean add(DynamicDeployer o) {
return chain.add(o);
}
public AppModule deploy(AppModule appModule) throws OpenEJBException {
for (DynamicDeployer deployer : chain) {
appModule = deployer.deploy(appModule);
}
return appModule;
}
}
public void init(Properties props) throws OpenEJBException {
configLocation = props.getProperty(CONF_FILE_PROPERTY);
if (configLocation == null) {
configLocation = props.getProperty(CONFIGURATION_PROPERTY);
}
configLocation = ConfigUtils.searchForConfiguration(configLocation, props);
if (configLocation != null) {
logger.info("openejb configuration file is '" + configLocation + "'");
props.setProperty(CONFIGURATION_PROPERTY, configLocation);
}
}
protected void install(ContainerInfo serviceInfo) throws OpenEJBException {
if (sys != null) {
sys.containerSystem.containers.add(serviceInfo);
} else if (!offline) {
Assembler assembler = SystemInstance.get().getComponent(Assembler.class);
assembler.createContainer(serviceInfo);
}
}
protected void install(ResourceInfo serviceInfo) throws OpenEJBException {
if (sys != null) {
sys.facilities.resources.add(serviceInfo);
} else if (!offline) {
Assembler assembler = SystemInstance.get().getComponent(Assembler.class);
assembler.createResource(serviceInfo);
}
}
/**
* Main loop that gets executed when OpenEJB starts up Reads config files and produces the basic "AST" the assembler needs to actually build the contianer system
* <p/>
* This method is called by the Assembler once at startup.
*
* @return
* @throws OpenEJBException
*/
public OpenEjbConfiguration getOpenEjbConfiguration() throws OpenEJBException {
if (sys != null) {
return sys;
}
if (configLocation != null) {
openejb = JaxbOpenejb.readConfig(configLocation);
} else {
openejb = JaxbOpenejb.createOpenejb();
}
loadPropertiesDeclaredConfiguration(openejb);
sys = new OpenEjbConfiguration();
sys.containerSystem = new ContainerSystemInfo();
sys.facilities = new FacilitiesInfo();
for (JndiProvider provider : openejb.getJndiProvider()) {
JndiContextInfo info = configureService(provider, JndiContextInfo.class);
sys.facilities.remoteJndiContexts.add(info);
}
sys.facilities.securityService = configureService(openejb.getSecurityService(), SecurityServiceInfo.class);
sys.facilities.transactionService = configureService(openejb.getTransactionManager(), TransactionServiceInfo.class);
List<ResourceInfo> resources = new ArrayList<ResourceInfo>();
for (Resource resource : openejb.getResource()) {
ResourceInfo resourceInfo = configureService(resource, ResourceInfo.class);
resources.add(resourceInfo);
}
Collections.sort(resources, new ResourceInfoComparator(resources));
sys.facilities.resources.addAll(resources);
// ConnectionManagerInfo service = configureService(openejb.getConnectionManager(), ConnectionManagerInfo.class);
// sys.facilities.connectionManagers.add(service);
if (openejb.getProxyFactory() != null) {
sys.facilities.intraVmServer = configureService(openejb.getProxyFactory(), ProxyFactoryInfo.class);
}
for (Container declaration : openejb.getContainer()) {
ContainerInfo info = createContainerInfo(declaration);
sys.containerSystem.containers.add(info);
}
List<String> declaredApps = getDeclaredApps();
for (String pathname : declaredApps) {
try {
try {
final File jarFile;
if (pathname.startsWith("file:/")) {
jarFile = new File(new URI(pathname));
} else {
jarFile = new File(pathname);
}
AppInfo appInfo = configureApplication(jarFile);
sys.containerSystem.applications.add(appInfo);
} catch (URISyntaxException e) {
logger.error("Invalid declaredApp URI '" + pathname + "'", e);
}
} catch (OpenEJBException alreadyHandled) {
}
}
final boolean embedded = SystemInstance.get().hasProperty(EJBContainer.class.getName());
if (SystemInstance.get().getOptions().get(DEPLOYMENTS_CLASSPATH_PROPERTY, !embedded)) {
ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
ArrayList<File> jarFiles = getModulesFromClassPath(declaredApps, classLoader);
String appId = "classpath.ear";
boolean classpathAsEar = SystemInstance.get().getOptions().get(CLASSPATH_AS_EAR, true);
try {
if (classpathAsEar && !jarFiles.isEmpty()) {
AppInfo appInfo = configureApplication(classLoader, appId, jarFiles);
sys.containerSystem.applications.add(appInfo);
} else for (File jarFile : jarFiles) {
AppInfo appInfo = configureApplication(jarFile);
sys.containerSystem.applications.add(appInfo);
}
if (jarFiles.size() == 0) {
logger.warning("config.noModulesFoundToDeploy");
}
} catch (OpenEJBException alreadyHandled) {
}
}
final OpenEjbConfiguration finished = sys;
sys = null;
openejb = null;
return finished;
}
private List<String> getDeclaredApps() {
// make a copy of the list because we update it
List<Deployments> deployments = new ArrayList<Deployments>();
if (openejb != null) {
deployments.addAll(openejb.getDeployments());
}
// resolve jar locations ////////////////////////////////////// BEGIN ///////
FileUtils base = SystemInstance.get().getBase();
List<URL> declaredAppsUrls = new ArrayList<URL>();
try {
for (Deployments deployment : deployments) {
DeploymentsResolver.loadFrom(deployment, base, declaredAppsUrls);
}
} catch (SecurityException ignored) {
}
return toString(declaredAppsUrls);
}
public ArrayList<File> getModulesFromClassPath(List<String> declaredApps, ClassLoader classLoader) {
FileUtils base = SystemInstance.get().getBase();
if (declaredApps == null) {
declaredApps = getDeclaredApps();
}
List<URL> classpathAppsUrls = new ArrayList<URL>();
DeploymentsResolver.loadFromClasspath(base, classpathAppsUrls, classLoader);
ArrayList<File> jarFiles = new ArrayList<File>();
for (URL path : classpathAppsUrls) {
if (declaredApps.contains(URLs.toFilePath(path))) continue;
jarFiles.add(new File(URLs.toFilePath(path)));
}
return jarFiles;
}
private List<String> toString(List<URL> urls) {
List<String> toReturn = new ArrayList<String>(urls.size());
for (URL url : urls) {
try {
toReturn.add(url.toString());
} catch (Exception ignore) {
}
}
return toReturn;
}
public ContainerInfo createContainerInfo(Container container) throws OpenEJBException {
Class<? extends ContainerInfo> infoClass = getContainerInfoType(container.getType());
if (infoClass == null) {
throw new OpenEJBException(messages.format("unrecognizedContainerType", container.getType()));
}
ContainerInfo info = configureService(container, infoClass);
return info;
}
private void loadPropertiesDeclaredConfiguration(Openejb openejb) {
Properties sysProps = new Properties(System.getProperties());
sysProps.putAll(SystemInstance.get().getProperties());
for (Map.Entry<Object, Object> entry : sysProps.entrySet()) {
Object o = entry.getValue();
if (!(o instanceof String)) continue;
if (!((String) o).startsWith("new://")) continue;
String name = (String) entry.getKey();
String value = (String) entry.getValue();
try {
final Object service = toConfigDeclaration(name, value);
openejb.add(service);
} catch (URISyntaxException e) {
logger.error("Error declaring service '" + name + "'. Invalid Service URI '" + value + "'. java.net.URISyntaxException: " + e.getMessage());
} catch (OpenEJBException e) {
logger.error(e.getMessage());
}
}
}
protected Object toConfigDeclaration(String name, String value) throws URISyntaxException, OpenEJBException {
// value = value.replaceFirst("(.)#", "$1%23");
value = value.replaceFirst("(provider=[^#=&]+)#", "$1%23");
URI uri = new URI(value);
final Object service = toConfigDeclaration(name, uri);
return service;
}
public Object toConfigDeclaration(String id, URI uri) throws OpenEJBException {
String serviceType = null;
try {
serviceType = uri.getHost();
Object object = null;
try {
object = JaxbOpenejb.create(serviceType);
} catch (Exception e) {
throw new OpenEJBException("Invalid URI '" + uri + "'. " + e.getMessage());
}
Map<String, String> map = null;
try {
map = URISupport.parseParamters(uri);
} catch (URISyntaxException e) {
throw new OpenEJBException("Unable to parse URI parameters '" + uri + "'. URISyntaxException: " + e.getMessage());
}
if (object instanceof AbstractService) {
AbstractService service = (AbstractService) object;
service.setId(id);
service.setType(map.remove("type"));
service.setProvider(map.remove("provider"));
service.getProperties().putAll(map);
} else if (object instanceof Deployments) {
Deployments deployments = (Deployments) object;
deployments.setDir(map.remove("dir"));
deployments.setJar(map.remove("jar"));
String cp = map.remove("classpath");
if (cp != null) {
String[] paths = cp.split(File.pathSeparator);
List<URL> urls = new ArrayList<URL>();
for (String path : paths) {
urls.add(new File(path).toURI().normalize().toURL());
}
deployments.setClasspath(new URLClassLoader(urls.toArray(new URL[0])));
}
}
return object;
} catch (Exception e) {
throw new OpenEJBException("Error declaring service '" + id + "'. Unable to create Service definition from URI '" + uri.toString() + "'", e);
}
}
public AppInfo configureApplication(File jarFile) throws OpenEJBException {
logger.debug("Beginning load: " + jarFile.getAbsolutePath());
AppInfo appInfo;
try {
AppModule appModule = deploymentLoader.load(jarFile);
appInfo = configureApplication(appModule);
} catch (ValidationFailedException e) {
logger.warning("configureApplication.loadFailed", jarFile.getAbsolutePath(), e.getMessage()); // DO not include the stacktrace in the message
throw e;
} catch (OpenEJBException e) {
// DO NOT REMOVE THE EXCEPTION FROM THIS LOG MESSAGE
// removing this message causes NO messages to be printed when embedded
logger.warning("configureApplication.loadFailed", e, jarFile.getAbsolutePath(), e.getMessage());
throw e;
}
return appInfo;
}
/**
* embedded usage
*
* @param classLoader classloader
* @param id id supplied from embedded properties or null
* @param jarFiles list of ejb modules
* @return configured AppInfo
* @throws OpenEJBException on error
*/
public AppInfo configureApplication(ClassLoader classLoader, String id, List<File> jarFiles) throws OpenEJBException {
AppModule collection = loadApplication(classLoader, id, jarFiles);
AppInfo appInfo;
try {
appInfo = configureApplication(collection);
} catch (ValidationFailedException e) {
logger.warning("configureApplication.loadFailed", collection.getModuleId(), e.getMessage()); // DO not include the stacktrace in the message
throw e;
} catch (OpenEJBException e) {
// DO NOT REMOVE THE EXCEPTION FROM THIS LOG MESSAGE
// removing this message causes NO messages to be printed when embedded
logger.warning("configureApplication.loadFailed", e, collection.getModuleId(), e.getMessage());
throw e;
}
return appInfo;
}
public AppModule loadApplication(ClassLoader classLoader, String id, List<File> jarFiles) throws OpenEJBException {
final boolean standaloneModule = id == null;
if (standaloneModule) {
id = "";
}
Application application = new Application();
application.setApplicationName(id);
AppModule collection = new AppModule(classLoader, id, application, standaloneModule);
Map<String, Object> altDDs = collection.getAltDDs();
for (File jarFile : jarFiles) {
logger.info("Beginning load: " + jarFile.getAbsolutePath());
try {
AppModule module = deploymentLoader.load(jarFile);
collection.getAdditionalLibraries().addAll(module.getAdditionalLibraries());
collection.getClientModules().addAll(module.getClientModules());
collection.getEjbModules().addAll(module.getEjbModules());
collection.getPersistenceModules().addAll(module.getPersistenceModules());
collection.getConnectorModules().addAll(module.getConnectorModules());
collection.getWebModules().addAll(module.getWebModules());
collection.getWatchedResources().addAll(module.getWatchedResources());
// Merge altDDs
for (Map.Entry<String, Object> entry : module.getAltDDs().entrySet()) {
Object existingValue = altDDs.get(entry.getKey());
if (existingValue == null) {
altDDs.put(entry.getKey(), entry.getValue());
} else if (entry.getValue() instanceof Collection) {
if (existingValue instanceof Collection) {
Collection values = (Collection) existingValue;
values.addAll((Collection) entry.getValue());
}
} else if (entry.getValue() instanceof Map) {
if (existingValue instanceof Map) {
Map values = (Map) existingValue;
values.putAll((Map) entry.getValue());
}
}
}
} catch (ValidationFailedException e) {
logger.warning("configureApplication.loadFailed", jarFile.getAbsolutePath(), e.getMessage()); // DO not include the stacktrace in the message
throw e;
} catch (OpenEJBException e) {
// DO NOT REMOVE THE EXCEPTION FROM THIS LOG MESSAGE
// removing this message causes NO messages to be printed when embedded
logger.warning("configureApplication.loadFailed", e, jarFile.getAbsolutePath(), e.getMessage());
throw e;
}
}
return collection;
}
public EjbJarInfo configureApplication(EjbJar ejbJar) throws OpenEJBException {
EjbModule ejbModule = new EjbModule(ejbJar);
return configureApplication(ejbModule);
}
public EjbJarInfo configureApplication(EjbModule ejbModule) throws OpenEJBException {
AppInfo appInfo = configureApplication(new AppModule(ejbModule));
return appInfo.ejbJars.get(0);
}
public ClientInfo configureApplication(ClientModule clientModule) throws OpenEJBException {
AppInfo appInfo = configureApplication(new AppModule(clientModule));
return appInfo.clients.get(0);
}
public ConnectorInfo configureApplication(ConnectorModule connectorModule) throws OpenEJBException {
AppInfo appInfo = configureApplication(new AppModule(connectorModule));
return appInfo.connectors.get(0);
}
public WebAppInfo configureApplication(WebModule webModule) throws OpenEJBException {
AppInfo appInfo = configureApplication(new AppModule(webModule));
return appInfo.webApps.get(0);
}
public AppInfo configureApplication(AppModule appModule) throws OpenEJBException {
logger.info("config.configApp", appModule.getJarLocation());
deployer.deploy(appModule);
AppInfoBuilder appInfoBuilder = new AppInfoBuilder(this);
return appInfoBuilder.build(appModule);
}
private static class DefaultService {
private final Class<? extends Service> type;
private final String id;
public DefaultService(String id, Class<? extends Service> type) {
this.id = id;
this.type = type;
}
}
private static final Map<Class<? extends ServiceInfo>, DefaultService> defaultProviders = new HashMap<Class<? extends ServiceInfo>, DefaultService>();
private static final Map<Class<? extends ServiceInfo>, Class<? extends Service>> types = new HashMap<Class<? extends ServiceInfo>, Class<? extends Service>>();
/**
* This is the magic that allows people to be really vague in their openejb.xml and not specify
* the provider for one of their declared services. We look here for the default service id
*
* We then look in the default provider "namespace" that is setup, which will usually be either one of:
*
* - org.apache.openejb
* - org.apache.openejb.embedded
* - org.apache.openejb.tomcat
* - org.apache.openejb.jetty
*
* As in:
*
* - META-INF/<provider>/service-jar.xml
*
*/
static {
defaultProviders.put(MdbContainerInfo.class, new DefaultService("MESSAGE", Container.class));
defaultProviders.put(ManagedContainerInfo.class, new DefaultService("MANAGED", Container.class));
defaultProviders.put(StatefulSessionContainerInfo.class, new DefaultService("STATEFUL", Container.class));
defaultProviders.put(StatelessSessionContainerInfo.class, new DefaultService("STATELESS", Container.class));
defaultProviders.put(SingletonSessionContainerInfo.class, new DefaultService("SINGLETON", Container.class));
defaultProviders.put(CmpEntityContainerInfo.class, new DefaultService("CMP_ENTITY", Container.class));
defaultProviders.put(BmpEntityContainerInfo.class, new DefaultService("BMP_ENTITY", Container.class));
defaultProviders.put(SecurityServiceInfo.class, new DefaultService("SecurityService", SecurityService.class));
defaultProviders.put(TransactionServiceInfo.class, new DefaultService("TransactionManager", TransactionManager.class));
defaultProviders.put(ConnectionManagerInfo.class, new DefaultService("ConnectionManager", ConnectionManager.class));
defaultProviders.put(ProxyFactoryInfo.class, new DefaultService("ProxyFactory", ProxyFactory.class));
for (Map.Entry<Class<? extends ServiceInfo>, DefaultService> entry : defaultProviders.entrySet()) {
types.put(entry.getKey(), entry.getValue().type);
}
types.put(ResourceInfo.class, Resource.class);
}
public <T extends ServiceInfo> T configureService(Class<? extends T> type) throws OpenEJBException {
return configureService((Service) null, type);
}
private <T extends ServiceInfo> Service getDefaultService(Class<? extends T> type) throws OpenEJBException {
DefaultService defaultService = defaultProviders.get(type);
if (defaultService == null) return null;
Service service;
try {
service = JaxbOpenejb.create(defaultService.type);
service.setType(defaultService.id);
} catch (Exception e) {
String name = (defaultService == null || defaultService.type == null) ? "null" : defaultService.type.getName();
throw new OpenEJBException("Cannot instantiate class " + name, e);
}
return service;
}
/**
* This is the major piece of code that configures services.
* It merges the data from the <ServiceProvider> declaration
* with the data from the openejb.xml file (say <Resource>)
*
* The end result is a canonical (i.e. flattened) ServiceInfo
* The ServiceInfo will be of a specific type (ContainerInfo, ResourceInfo, etc)
*
* @param service
* @param infoType
* @param <T>
* @return
* @throws OpenEJBException
*/
public <T extends ServiceInfo> T configureService(Service service, Class<? extends T> infoType) throws OpenEJBException {
try {
if (infoType == null) throw new NullPointerException("type");
if (service == null) {
service = getDefaultService(infoType);
if (service == null) {
throw new OpenEJBException(messages.format("configureService.noDefaultService", infoType.getName()));
}
}
String providerType = service.getClass().getSimpleName();
ServiceProvider provider = resolveServiceProvider(service, infoType);
if (provider == null) {
List<ServiceProvider> providers = ServiceUtils.getServiceProvidersByServiceType(providerType);
StringBuilder sb = new StringBuilder();
// for (ServiceProvider p : providers) {
// sb.append(System.getProperty("line.separator"));
// sb.append(" <").append(p.getService());
// sb.append(" id=\"").append(service.getId()).append('"');
// sb.append(" provider=\"").append(p.getId()).append("\"/>");
// }
List<String> types = new ArrayList<String>();
for (ServiceProvider p : providers) {
for (String type : p.getTypes()) {
if (types.contains(type)) continue;
types.add(type);
sb.append(System.getProperty("line.separator"));
sb.append(" <").append(p.getService());
sb.append(" id=\"").append(service.getId()).append('"');
sb.append(" type=\"").append(type).append("\"/>");
}
}
String noProviderMessage = messages.format("configureService.noProviderForService", providerType, service.getId(), service.getType(), service.getProvider(), sb.toString());
throw new NoSuchProviderException(noProviderMessage);
}
if (service.getId() == null) service.setId(provider.getId());
Properties overrides = trim(getSystemProperties(service.getId(), provider.getService()));
trim(service.getProperties());
trim(provider.getProperties());
logger.info("configureService.configuring", service.getId(), provider.getService(), provider.getId());
if (logger.isDebugEnabled()) {
for (Map.Entry<Object, Object> entry : service.getProperties().entrySet()) {
Object key = entry.getKey();
Object value = entry.getValue();
if (key instanceof String && "password".equalsIgnoreCase((String) key)) {
value = "<hidden>";
}
logger.debug("[" + key + "=" + value + "]");
}
for (Map.Entry<Object, Object> entry : overrides.entrySet()) {
Object key = entry.getKey();
Object value = entry.getValue();
if (key instanceof String && "password".equalsIgnoreCase((String) key)) {
value = "<hidden>";
}
logger.debug("Override [" + key + "=" + value + "]");
}
}
Properties props = new SuperProperties();
props.putAll(provider.getProperties());
props.putAll(service.getProperties());
props.putAll(overrides);
if (providerType != null && !provider.getService().equals(providerType)) {
throw new OpenEJBException(messages.format("configureService.wrongProviderType", service.getId(), providerType));
}
T info;
try {
info = infoType.newInstance();
} catch (Exception e) {
throw new OpenEJBException(messages.format("configureService.cannotInstantiateClass", infoType.getName()), e);
}
info.service = provider.getService();
info.types.addAll(provider.getTypes());
info.description = provider.getDescription();
info.displayName = provider.getDisplayName();
info.className = provider.getClassName();
info.factoryMethod = provider.getFactoryName();
info.id = service.getId();
info.properties = props;
info.constructorArgs.addAll(parseConstructorArgs(provider));
if (info instanceof ResourceInfo && service instanceof Resource) {
((ResourceInfo) info).jndiName = ((Resource) service).getJndi();
}
specialProcessing(info);
return info;
} catch (NoSuchProviderException e) {
String message = logger.fatal("configureService.failed", e, service.getId());
throw new OpenEJBException(message + ": " + e.getMessage());
} catch (Throwable e) {
String message = logger.fatal("configureService.failed", e, service.getId());
throw new OpenEJBException(message, e);
}
}
private static Properties trim(Properties properties) {
for (Map.Entry<Object, Object> entry : properties.entrySet()) {
Object o = entry.getValue();
if (o instanceof String) {
String value = (String) o;
String trimmed = value.trim();
if (value.length() != trimmed.length()) {
properties.put(entry.getKey(), trimmed);
}
}
}
return properties;
}
private <T extends ServiceInfo> void specialProcessing(T info) {
ServiceInfo serviceInfo = info;
TopicOrQueueDefaults.process(serviceInfo);
}
@SuppressWarnings({"unchecked"})
private ServiceProvider resolveServiceProvider(Service service, Class infoType) throws OpenEJBException {
if (service.getProvider() != null) {
return ServiceUtils.getServiceProvider(service.getProvider());
}
if (service.getType() != null) {
return ServiceUtils.getServiceProviderByType(service.getClass().getSimpleName(), service.getType());
}
if (service.getId() != null) {
try {
return ServiceUtils.getServiceProvider(service.getId());
} catch (NoSuchProviderException e) {
}
}
if (infoType != null) {
Service defaultService = getDefaultService(infoType);
if (defaultService != null) {
return resolveServiceProvider(defaultService, null);
}
}
return null;
}
public <T extends ServiceInfo> T configureService(String id, Class<? extends T> type) throws OpenEJBException {
return configureService(type, id, null, id, null);
}
/**
* Resolving the provider for a particular service follows this algorithm:
*
* 1. Attempt to load the provider specified by the 'providerId'.
* 2. If this fails, throw NoSuchProviderException
* 3. If providerId is null, attempt to load the specified provider using the 'serviceId' as the 'providerId'
* 4. If this fails, check the hardcoded defaults for a default providerId using the supplied 'type'
* 5. If this fails, throw NoSuchProviderException
*/
public <T extends ServiceInfo> T configureService(Class<? extends T> type, String serviceId, Properties declaredProperties, String providerId, String serviceType) throws OpenEJBException {
if (type == null) throw new NullPointerException("type is null");
Class<? extends Service> serviceClass = types.get(type);
if (serviceClass == null) throw new OpenEJBException("Unsupported service info type: " + type.getName());
Service service;
try {
service = serviceClass.newInstance();
} catch (Exception e) {
throw new OpenEJBException(messages.format("configureService.cannotInstantiateClass", serviceClass.getName()), e);
}
service.setId(serviceId);
service.setProvider(providerId);
if (declaredProperties != null) {
service.getProperties().putAll(declaredProperties);
}
return configureService(service, type);
}
protected static Properties getSystemProperties(String serviceId, String serviceType) {
// Override with system properties
final Properties sysProps = new Properties(System.getProperties());
sysProps.putAll(SystemInstance.get().getProperties());
return getOverrides(sysProps, serviceId, serviceType);
}
protected static Properties getOverrides(Properties properties, String serviceId, String serviceType) {
final String fullPrefix = serviceType.toUpperCase() + "." + serviceId + ".";
final String fullPrefix2 = serviceType.toUpperCase() + "." + serviceId + "|";
final String shortPrefix = serviceId + ".";
final String shortPrefix2 = serviceId + "|";
final Properties overrides = new Properties();
for (Map.Entry<Object, Object> entry : properties.entrySet()) {
String name = (String) entry.getKey();
for (String prefix : Arrays.asList(fullPrefix, fullPrefix2, shortPrefix, shortPrefix2)) {
if (name.toLowerCase().startsWith(prefix.toLowerCase())) {
name = name.substring(prefix.length());
// TODO: Maybe use xbean-reflect to get the string value
String value = entry.getValue().toString();
overrides.setProperty(name, value);
break;
}
}
}
return overrides;
}
static Map<String, Class<? extends ContainerInfo>> containerTypes = new HashMap<String, Class<? extends ContainerInfo>>();
static {
containerTypes.put(BeanTypes.SINGLETON, SingletonSessionContainerInfo.class);
containerTypes.put(BeanTypes.MANAGED, ManagedContainerInfo.class);
containerTypes.put(BeanTypes.STATELESS, StatelessSessionContainerInfo.class);
containerTypes.put(BeanTypes.STATEFUL, StatefulSessionContainerInfo.class);
containerTypes.put(BeanTypes.BMP_ENTITY, BmpEntityContainerInfo.class);
containerTypes.put(BeanTypes.CMP_ENTITY, CmpEntityContainerInfo.class);
containerTypes.put(BeanTypes.MESSAGE, MdbContainerInfo.class);
}
protected static Class<? extends ContainerInfo> getContainerInfoType(String ctype) {
return containerTypes.get(ctype);
}
private List<String> parseConstructorArgs(ServiceProvider service) {
String constructor = service.getConstructor();
if (constructor == null) {
return Collections.emptyList();
}
return Arrays.asList(constructor.split("[ ,]+"));
}
protected List<String> getResourceIds() {
return getResourceIds(null);
}
protected List<String> getResourceIds(String type) {
return getResourceIds(type, null);
}
protected List<String> getResourceIds(String type, Properties required) {
List<String> resourceIds = new ArrayList<String>();
if (required == null) required = new Properties();
OpenEjbConfiguration runningConfig = getRunningConfig();
if (runningConfig != null) {
for (ResourceInfo resourceInfo : runningConfig.facilities.resources) {
if (isResourceType(resourceInfo.service, resourceInfo.types, type) && implies(required, resourceInfo.properties)) {
resourceIds.add(resourceInfo.id);
}
}
}
if (sys != null) {
for (ResourceInfo resourceInfo : sys.facilities.resources) {
if (isResourceType(resourceInfo.service, resourceInfo.types, type) && implies(required, resourceInfo.properties)) {
resourceIds.add(resourceInfo.id);
}
}
// The only time we'd have one of these is if we were building
// the above sys instance
if (openejb != null) {
for (Resource resource : openejb.getResource()) {
ArrayList<String> types = new ArrayList<String>();
if (resource.getType() != null) {
types.add(resource.getType());
}
if (isResourceType("Resource", types, type) && implies(required, resource.getProperties())) {
resourceIds.add(resource.getId());
}
}
}
}
return resourceIds;
}
protected ResourceInfo getResourceInfo(String id) {
OpenEjbConfiguration runningConfig = getRunningConfig();
if (runningConfig != null) {
for (ResourceInfo resourceInfo : runningConfig.facilities.resources) {
if (resourceInfo.id == id) {
return resourceInfo;
}
}
}
if (sys != null) {
for (ResourceInfo resourceInfo : sys.facilities.resources) {
if (resourceInfo.id == id) {
return resourceInfo;
}
}
}
return null;
}
private boolean isResourceType(String service, List<String> types, String type) {
if (type == null) return true;
if (service == null) return false;
return types.contains(type);
}
protected List<String> getContainerIds() {
List<String> containerIds = new ArrayList<String>();
OpenEjbConfiguration runningConfig = getRunningConfig();
if (runningConfig != null) {
for (ContainerInfo containerInfo : runningConfig.containerSystem.containers) {
containerIds.add(containerInfo.id);
}
}
if (sys != null) {
for (ContainerInfo containerInfo : sys.containerSystem.containers) {
containerIds.add(containerInfo.id);
}
// The only time we'd have one of these is if we were building
// the above sys instance
if (openejb != null) {
for (Container container : openejb.getContainer()) {
containerIds.add(container.getId());
}
}
}
return containerIds;
}
protected List<ContainerInfo> getContainerInfos() {
List<ContainerInfo> containers = new ArrayList<ContainerInfo>();
OpenEjbConfiguration runningConfig = getRunningConfig();
if (runningConfig != null) {
for (ContainerInfo containerInfo : runningConfig.containerSystem.containers) {
containers.add(containerInfo);
}
}
if (sys != null) {
for (ContainerInfo containerInfo : sys.containerSystem.containers) {
containers.add(containerInfo);
}
}
return containers;
}
private OpenEjbConfiguration getRunningConfig() {
return SystemInstance.get().getComponent(OpenEjbConfiguration.class);
}
private static class TopicOrQueueDefaults {
public static void process(ServiceInfo provider) {
if (!provider.service.equals("Resource")) return;
if (!provider.types.contains("Topic") && !provider.types.contains("Queue")) return;
if (!provider.className.matches("org.apache.activemq.command.ActiveMQ(Topic|Queue)")) return;
String dest = provider.properties.getProperty("destination");
if (dest == null || dest.length() == 0) {
provider.properties.setProperty("destination", provider.id);
}
}
}
public static class ResourceInfoComparator implements Comparator<ResourceInfo> {
private final List<String> ids;
private static final int EQUAL = 0;
private static final int GREATER = 1;
private static final int LESS = -1;
public ResourceInfoComparator(List<ResourceInfo> resources) {
ids = new ArrayList<String>();
for (ResourceInfo info : resources) {
ids.add(info.id);
}
}
public int compare(ResourceInfo a, ResourceInfo b) {
String refA = getReference(a);
String refB = getReference(b);
// both null or the same id
if (refA == null && refB == null ||
refA != null && refA.equals(refB)) {
return EQUAL;
}
// b is referencing a
if (a.id.equals(refB)) {
return LESS;
}
// a is referencing b
if (b.id.equals(refA)) {
return GREATER;
}
// a has a ref and b doesn't
if (refA != null && refB == null) {
return GREATER;
}
// b has a ref and a doesn't
if (refB != null && refA == null) {
return LESS;
}
return EQUAL;
}
public int hasReference(ResourceInfo info) {
for (Object value : info.properties.values()) {
if (ids.contains(value)) return GREATER;
}
return EQUAL;
}
public String getReference(ResourceInfo info) {
for (Object value : info.properties.values()) {
value = ((String) value).trim();
if (ids.contains(value)) return (String) value;
}
return null;
}
}
}