/**
* 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.geronimo.tomcat;
import java.net.URI;
import java.net.URL;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Hashtable;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import javax.management.MalformedObjectNameException;
import javax.management.ObjectName;
import javax.management.j2ee.statistics.Stats;
import javax.naming.directory.DirContext;
import javax.transaction.TransactionManager;
import javax.transaction.UserTransaction;
import org.apache.InstanceManager;
import org.apache.catalina.Context;
import org.apache.catalina.LifecycleListener;
import org.apache.catalina.Manager;
import org.apache.catalina.Realm;
import org.apache.catalina.Valve;
import org.apache.catalina.core.StandardContext;
import org.apache.catalina.ha.CatalinaCluster;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.apache.geronimo.connector.outbound.connectiontracking.TrackedConnectionAssociator;
import org.apache.geronimo.gbean.AbstractName;
import org.apache.geronimo.gbean.GBeanInfo;
import org.apache.geronimo.gbean.GBeanInfoBuilder;
import org.apache.geronimo.gbean.GBeanLifecycle;
import org.apache.geronimo.j2ee.RuntimeCustomizer;
import org.apache.geronimo.j2ee.annotation.Holder;
import org.apache.geronimo.j2ee.j2eeobjectnames.NameFactory;
import org.apache.geronimo.j2ee.management.impl.InvalidObjectNameException;
import org.apache.geronimo.kernel.Kernel;
import org.apache.geronimo.kernel.ObjectNameUtil;
import org.apache.geronimo.management.J2EEApplication;
import org.apache.geronimo.management.J2EEServer;
import org.apache.geronimo.management.StatisticsProvider;
import org.apache.geronimo.management.geronimo.WebContainer;
import org.apache.geronimo.management.geronimo.WebModule;
import org.apache.geronimo.naming.enc.EnterpriseNamingContext;
import org.apache.geronimo.security.jacc.RunAsSource;
import org.apache.geronimo.security.SecurityNames;
import org.apache.geronimo.security.jaas.ConfigurationFactory;
import org.apache.geronimo.tomcat.cluster.CatalinaClusterGBean;
import org.apache.geronimo.tomcat.stats.ModuleStats;
import org.apache.geronimo.tomcat.util.SecurityHolder;
import org.apache.geronimo.transaction.GeronimoUserTransaction;
import org.apache.geronimo.webservices.WebServiceContainer;
import org.apache.geronimo.webservices.WebServiceContainerFactory;
import org.apache.naming.resources.DirContextURLStreamHandler;
/**
* Wrapper for a WebApplicationContext that sets up its J2EE environment.
*
* @version $Rev: 804089 $ $Date: 2009-08-14 14:29:52 +0800 (Fri, 14 Aug 2009) $
*/
public class TomcatWebAppContext implements GBeanLifecycle, TomcatContext, WebModule, StatisticsProvider {
private static final Logger log = LoggerFactory.getLogger(TomcatWebAppContext.class);
protected final TomcatContainer container;
private final ClassLoader classLoader;
protected Context context = null;
private String path = null;
private String docBase = null;
private String virtualServer = null;
private final Realm realm;
private final List valveChain;
private final List listenerChain;
private final CatalinaCluster catalinaCluster;
private final Manager manager;
private final boolean crossContext;
private final String workDir;
private final boolean disableCookies;
private final UserTransaction userTransaction;
private final javax.naming.Context componentContext;
private final Kernel kernel;
private final Set unshareableResources;
private final Set applicationManagedSecurityResources;
private final TrackedConnectionAssociator trackedConnectionAssociator;
private final SecurityHolder securityHolder;
private final J2EEServer server;
private final Map webServices;
private final String objectName;
private final String originalSpecDD;
private final URL configurationBaseURL;
private final Holder holder;
private final RuntimeCustomizer contextCustomizer;
private String displayName;
// JSR 77
private final String j2EEServer;
private final String j2EEApplication;
// statistics
private ModuleStats statsProvider;
private boolean reset = true;
private final Valve clusteredValve;
public TomcatWebAppContext(
ClassLoader classLoader,
String objectName,
String originalSpecDD,
URL configurationBaseUrl,
SecurityHolder securityHolder,
String virtualServer,
Map componentContext,
Set unshareableResources,
Set applicationManagedSecurityResources,
TransactionManager transactionManager,
TrackedConnectionAssociator trackedConnectionAssociator,
TomcatContainer container,
RunAsSource runAsSource,
ConfigurationFactory configurationFactory,
ObjectRetriever tomcatRealm,
ObjectRetriever clusteredValveRetriever,
ValveGBean tomcatValveChain,
LifecycleListenerGBean lifecycleListenerChain,
CatalinaClusterGBean cluster,
ObjectRetriever managerRetriever,
boolean crossContext,
String workDir,
boolean disableCookies,
String displayName,
Map webServices,
Holder holder,
RuntimeCustomizer contextCustomizer,
J2EEServer server,
J2EEApplication application,
Kernel kernel)
throws Exception {
assert classLoader != null;
assert configurationBaseUrl != null;
assert transactionManager != null;
assert trackedConnectionAssociator != null;
assert componentContext != null;
assert container != null;
if (null != clusteredValveRetriever) {
clusteredValve = (Valve) clusteredValveRetriever.getInternalObject();
} else {
clusteredValve = null;
}
this.objectName = objectName;
URI root;
// TODO is there a simpler way to do this?
if (configurationBaseUrl.getProtocol().equalsIgnoreCase("file")) {
root = new URI("file", configurationBaseUrl.getPath(), null);
} else {
root = URI.create(configurationBaseUrl.toString());
}
this.setDocBase(root.getPath());
this.container = container;
this.originalSpecDD = originalSpecDD;
this.virtualServer = virtualServer;
this.securityHolder = securityHolder;
userTransaction = new GeronimoUserTransaction(transactionManager);
this.componentContext = EnterpriseNamingContext.createEnterpriseNamingContext(componentContext, userTransaction, kernel, classLoader);
this.unshareableResources = unshareableResources;
this.applicationManagedSecurityResources = applicationManagedSecurityResources;
this.trackedConnectionAssociator = trackedConnectionAssociator;
this.server = server;
if (securityHolder != null) {
securityHolder.setRunAsSource(runAsSource == null? RunAsSource.NULL: runAsSource);
securityHolder.setConfigurationFactory(configurationFactory);
}
this.configurationBaseURL = configurationBaseUrl;
this.holder = holder == null? new Holder(): holder;
this.contextCustomizer = contextCustomizer;
if (tomcatRealm != null){
realm = (Realm)tomcatRealm.getInternalObject();
if (realm == null){
throw new IllegalArgumentException("tomcatRealm must be an instance of org.apache.catalina.Realm.");
}
} else{
realm = null;
}
this.displayName = displayName;
//Add the valve list
if (tomcatValveChain != null){
ArrayList<Valve> chain = new ArrayList<Valve>();
ValveGBean valveGBean = tomcatValveChain;
while(valveGBean != null){
chain.add((Valve)valveGBean.getInternalObject());
valveGBean = valveGBean.getNextValve();
}
valveChain = chain;
} else {
valveChain = null;
}
//Add the Lifecycle Listener list
if (lifecycleListenerChain != null){
ArrayList<LifecycleListener> chain = new ArrayList<LifecycleListener>();
LifecycleListenerGBean listenerGBean = lifecycleListenerChain;
while(listenerGBean != null){
chain.add((LifecycleListener)listenerGBean.getInternalObject());
listenerGBean = listenerGBean.getNextListener();
}
listenerChain = chain;
} else {
listenerChain = null;
}
//Add the cluster
if (cluster != null) {
catalinaCluster = (CatalinaCluster) cluster.getInternalObject();
} else {
catalinaCluster = null;
}
//Add the manager
if (managerRetriever != null) {
this.manager = (Manager) managerRetriever.getInternalObject();
} else {
this.manager = null;
}
this.crossContext = crossContext;
this.workDir = workDir;
this.disableCookies = disableCookies;
this.webServices = createWebServices(webServices, kernel);
this.classLoader = classLoader;
this.kernel = kernel;
if (objectName != null) {
ObjectName myObjectName = ObjectNameUtil.getObjectName(objectName);
verifyObjectName(myObjectName);
j2EEServer = myObjectName.getKeyProperty(NameFactory.J2EE_SERVER);
j2EEApplication = myObjectName.getKeyProperty(NameFactory.J2EE_APPLICATION);
} else {
// StandardContext uses default value of these as "none"
j2EEServer = null;
j2EEApplication = null;
}
}
private Map createWebServices(Map webServiceFactoryMap, Kernel kernel) throws Exception {
Map webServices = new HashMap();
if (webServiceFactoryMap != null) {
for (Iterator iterator = webServiceFactoryMap.entrySet().iterator(); iterator.hasNext();) {
Map.Entry entry = (Map.Entry) iterator.next();
String servletName = (String) entry.getKey();
AbstractName factoryName = (AbstractName) entry.getValue();
WebServiceContainerFactory webServiceContainerFactory = (WebServiceContainerFactory) kernel.getGBean(factoryName);
WebServiceContainer webServiceContainer = webServiceContainerFactory.getWebServiceContainer();
webServices.put(servletName, webServiceContainer);
}
}
return webServices;
}
public String getObjectName() {
return objectName;
}
public String getJ2EEApplication() {
return j2EEApplication;
}
public String getJ2EEServer() {
return j2EEServer;
}
public boolean isStateManageable() {
return true;
}
public boolean isStatisticsProvider() {
return true;
}
public boolean isEventProvider() {
return true;
}
public URL getWARDirectory() {
return configurationBaseURL;
}
public String getWARName() {
//todo: make this return something more consistent
try {
return ObjectName.getInstance(objectName).getKeyProperty(NameFactory.J2EE_NAME);
} catch (MalformedObjectNameException e) {
return null;
}
}
public WebContainer getContainer() {
return container;
}
public String getServer() {
return server == null? null: server.getObjectName();
}
public String getDocBase() {
return docBase;
}
public void setDocBase(String docBase) {
this.docBase = docBase;
}
public UserTransaction getUserTransaction() {
return userTransaction;
}
public javax.naming.Context getJndiContext() {
return componentContext;
}
public String getVirtualServer() {
return virtualServer;
}
public ClassLoader getClassLoader() {
return classLoader;
}
public Kernel getKernel() {
return kernel;
}
public boolean isDisableCookies() {
return disableCookies;
}
public Context getContext() {
return context;
}
public void setContext(Context context) {
this.context = context;
}
public String getContextPath() {
return path;
}
public void setContextPath(String path) {
this.path = path.startsWith("/") ? path : "/" + path;
}
public SecurityHolder getSecurityHolder() {
return securityHolder;
}
public Set getApplicationManagedSecurityResources() {
return applicationManagedSecurityResources;
}
public TrackedConnectionAssociator getTrackedConnectionAssociator() {
return trackedConnectionAssociator;
}
public Set getUnshareableResources() {
return unshareableResources;
}
public Realm getRealm() {
return realm;
}
public Valve getClusteredValve() {
return clusteredValve;
}
public List getValveChain() {
return valveChain;
}
public List getLifecycleListenerChain() {
return listenerChain;
}
public CatalinaCluster getCluster() {
return catalinaCluster;
}
public Manager getManager() {
return manager;
}
public boolean isCrossContext() {
return crossContext;
}
public String getWorkDir() {
return workDir;
}
public Map getWebServices(){
return webServices;
}
public InstanceManager getInstanceManager() {
return new TomcatInstanceManager(holder, classLoader, componentContext);
}
public RuntimeCustomizer getRuntimeCustomizer() {
return contextCustomizer;
}
public String[] getServlets(){
String[] result = null;
if ((context != null) && (context instanceof StandardContext)) {
result = ((StandardContext) context).getServlets();
}
return result;
}
public String getDisplayName(){
return displayName;
}
public void setDisplayName(String displayName) {
this.displayName = displayName;
}
/**
* ObjectName must match this pattern: <p/>
* domain:j2eeType=WebModule,name=MyName,J2EEServer=MyServer,J2EEApplication=MyApplication
*/
private void verifyObjectName(ObjectName objectName) {
if (objectName.isPattern()) {
throw new InvalidObjectNameException(
"ObjectName can not be a pattern", objectName);
}
Hashtable keyPropertyList = objectName.getKeyPropertyList();
if (!NameFactory.WEB_MODULE.equals(keyPropertyList.get("j2eeType"))) {
throw new InvalidObjectNameException(
"WebModule object name j2eeType property must be 'WebModule'",
objectName);
}
if (!keyPropertyList.containsKey(NameFactory.J2EE_NAME)) {
throw new InvalidObjectNameException(
"WebModule object must contain a name property", objectName);
}
if (!keyPropertyList.containsKey(NameFactory.J2EE_SERVER)) {
throw new InvalidObjectNameException(
"WebModule object name must contain a J2EEServer property",
objectName);
}
if (!keyPropertyList.containsKey(NameFactory.J2EE_APPLICATION)) {
throw new InvalidObjectNameException(
"WebModule object name must contain a J2EEApplication property",
objectName);
}
if (keyPropertyList.size() != 4) {
throw new InvalidObjectNameException(
"WebModule object name can only have j2eeType, name, J2EEApplication, and J2EEServer properties",
objectName);
}
}
public String[] getJavaVMs() {
return server == null? new String[0]: server.getJavaVMs();
}
public String getDeploymentDescriptor() {
return originalSpecDD;
}
// JSR 77 statistics - The static values are initialized at the time of
// creration, getStats return fresh value everytime
public Stats getStats() {
if (reset) {
reset = false;
return statsProvider.getStats();
}
else return statsProvider.updateStats();
}
public void resetStats() {
reset = true;
}
public void doStart() throws Exception {
// See the note of TomcatContainer::addContext
container.addContext(this);
// Is it necessary - doesn't Tomcat Embedded take care of it?
// super.start();
//register the classloader <> dir context association so that tomcat's jndi based getResources works.
DirContext resources = context.getResources();
if (resources == null) {
throw new IllegalStateException("JNDI environment was not set up correctly due to previous error");
}
DirContextURLStreamHandler.bind(classLoader, resources);
if (context instanceof StandardContext)
statsProvider = new ModuleStats((StandardContext)context);
log.debug("TomcatWebAppContext started for " + path);
}
public void doStop() throws Exception {
statsProvider = null;
container.removeContext(this);
DirContextURLStreamHandler.unbind(classLoader);
// No more logging will occur for this ClassLoader. Inform the LogFactory to avoid a memory leak.
// LogFactory.release(classLoader);
log.debug("TomcatWebAppContext stopped");
}
public void doFail() {
statsProvider = null;
container.removeContext(this);
// No more logging will occur for this ClassLoader. Inform the LogFactory to avoid a memory leak.
// LogFactory.release(classLoader);
log.warn("TomcatWebAppContext failed");
}
public static final GBeanInfo GBEAN_INFO;
public static final String GBEAN_REF_CLUSTERED_VALVE_RETRIEVER = "ClusteredValveRetriever";
public static final String GBEAN_REF_MANAGER_RETRIEVER = "ManagerRetriever";
static {
GBeanInfoBuilder infoBuilder = GBeanInfoBuilder.createStatic("Tomcat WebApplication Context", TomcatWebAppContext.class, NameFactory.WEB_MODULE);
infoBuilder.addAttribute("classLoader", ClassLoader.class, false);
infoBuilder.addAttribute("objectName", String.class, false);
infoBuilder.addAttribute("deploymentDescriptor", String.class, true);
infoBuilder.addAttribute("configurationBaseUrl", URL.class, true);
infoBuilder.addAttribute("contextPath", String.class, true);
infoBuilder.addAttribute("securityHolder", SecurityHolder.class, true);
infoBuilder.addAttribute("virtualServer", String.class, true);
infoBuilder.addAttribute("componentContext", Map.class, true);
infoBuilder.addAttribute("unshareableResources", Set.class, true);
infoBuilder.addAttribute("applicationManagedSecurityResources", Set.class, true);
infoBuilder.addReference("TransactionManager", TransactionManager.class, NameFactory.JTA_RESOURCE);
infoBuilder.addReference("TrackedConnectionAssociator", TrackedConnectionAssociator.class, NameFactory.JCA_CONNECTION_TRACKER);
infoBuilder.addReference("Container", TomcatContainer.class, GBeanInfoBuilder.DEFAULT_J2EE_TYPE);
infoBuilder.addReference("RunAsSource", RunAsSource.class, SecurityNames.JACC_MANAGER);
infoBuilder.addReference("ConfigurationFactory", ConfigurationFactory.class);
infoBuilder.addReference("TomcatRealm", ObjectRetriever.class);
infoBuilder.addReference(GBEAN_REF_CLUSTERED_VALVE_RETRIEVER, ObjectRetriever.class);
infoBuilder.addReference("TomcatValveChain", ValveGBean.class);
infoBuilder.addReference("LifecycleListenerChain", LifecycleListenerGBean.class, LifecycleListenerGBean.J2EE_TYPE);
infoBuilder.addReference("Cluster", CatalinaClusterGBean.class, CatalinaClusterGBean.J2EE_TYPE);
infoBuilder.addReference(GBEAN_REF_MANAGER_RETRIEVER, ObjectRetriever.class);
infoBuilder.addAttribute("crossContext", boolean.class, true);
infoBuilder.addAttribute("workDir", String.class, true);
infoBuilder.addAttribute("disableCookies", boolean.class, true);
infoBuilder.addAttribute("webServices", Map.class, true);
infoBuilder.addAttribute("holder", Holder.class, true);
infoBuilder.addReference("ContextCustomizer", RuntimeCustomizer.class, GBeanInfoBuilder.DEFAULT_J2EE_TYPE);
infoBuilder.addReference("J2EEServer", J2EEServer.class);
infoBuilder.addReference("J2EEApplication", J2EEApplication.class);
infoBuilder.addAttribute("kernel", Kernel.class, false);
infoBuilder.addAttribute("displayName", String.class, true);
infoBuilder.addInterface(WebModule.class);
infoBuilder.setConstructor(new String[] {
"classLoader",
"objectName",
"deploymentDescriptor",
"configurationBaseUrl",
"securityHolder",
"virtualServer",
"componentContext",
"unshareableResources",
"applicationManagedSecurityResources",
"TransactionManager",
"TrackedConnectionAssociator",
"Container",
"RunAsSource",
"ConfigurationFactory",
"TomcatRealm",
GBEAN_REF_CLUSTERED_VALVE_RETRIEVER,
"TomcatValveChain",
"LifecycleListenerChain",
"Cluster",
GBEAN_REF_MANAGER_RETRIEVER,
"crossContext",
"workDir",
"disableCookies",
"displayName",
"webServices",
"holder",
"ContextCustomizer",
"J2EEServer",
"J2EEApplication",
"kernel"
}
);
GBEAN_INFO = infoBuilder.getBeanInfo();
}
public static GBeanInfo getGBeanInfo() {
return GBEAN_INFO;
}
}