| /* |
| * Copyright 1999-2001,2004 The Apache Software Foundation. |
| * |
| * Licensed 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.catalina.startup; |
| |
| |
| import java.lang.reflect.Constructor; |
| |
| import org.apache.catalina.Container; |
| import org.apache.catalina.Loader; |
| import org.apache.tomcat.util.digester.Digester; |
| import org.apache.tomcat.util.digester.Rule; |
| import org.apache.tomcat.util.digester.RuleSetBase; |
| import org.xml.sax.Attributes; |
| |
| |
| /** |
| * <p><strong>RuleSet</strong> for processing the contents of a |
| * Context or DefaultContext definition element. To enable parsing of a |
| * DefaultContext, be sure to specify a prefix that ends with "/Default".</p> |
| * |
| * @author Craig R. McClanahan |
| * @version $Revision$ $Date$ |
| */ |
| |
| public class ContextRuleSet extends RuleSetBase { |
| |
| |
| // ----------------------------------------------------- Instance Variables |
| |
| |
| /** |
| * The matching pattern prefix to use for recognizing our elements. |
| */ |
| protected String prefix = null; |
| |
| |
| /** |
| * Should the context be created. |
| */ |
| protected boolean create = true; |
| |
| |
| // ------------------------------------------------------------ Constructor |
| |
| |
| /** |
| * Construct an instance of this <code>RuleSet</code> with the default |
| * matching pattern prefix. |
| */ |
| public ContextRuleSet() { |
| |
| this(""); |
| |
| } |
| |
| |
| /** |
| * Construct an instance of this <code>RuleSet</code> with the specified |
| * matching pattern prefix. |
| * |
| * @param prefix Prefix for matching pattern rules (including the |
| * trailing slash character) |
| */ |
| public ContextRuleSet(String prefix) { |
| |
| super(); |
| this.namespaceURI = null; |
| this.prefix = prefix; |
| |
| } |
| |
| |
| /** |
| * Construct an instance of this <code>RuleSet</code> with the specified |
| * matching pattern prefix. |
| * |
| * @param prefix Prefix for matching pattern rules (including the |
| * trailing slash character) |
| */ |
| public ContextRuleSet(String prefix, boolean create) { |
| |
| super(); |
| this.namespaceURI = null; |
| this.prefix = prefix; |
| this.create = create; |
| |
| } |
| |
| |
| // --------------------------------------------------------- Public Methods |
| |
| |
| /** |
| * <p>Add the set of Rule instances defined in this RuleSet to the |
| * specified <code>Digester</code> instance, associating them with |
| * our namespace URI (if any). This method should only be called |
| * by a Digester instance.</p> |
| * |
| * @param digester Digester instance to which the new Rule instances |
| * should be added. |
| */ |
| public void addRuleInstances(Digester digester) { |
| |
| if (create) { |
| if (!isDefaultContext()) { |
| digester.addObjectCreate(prefix + "Context", |
| "org.apache.catalina.core.StandardContext", |
| "className"); |
| } else { |
| digester.addObjectCreate(prefix + "Context", |
| "org.apache.catalina.core.StandardDefaultContext", |
| "className"); |
| } |
| } |
| digester.addSetProperties(prefix + "Context"); |
| if (!isDefaultContext()) { |
| digester.addRule(prefix + "Context", |
| new CopyParentClassLoaderRule()); |
| if (create) { |
| digester.addRule(prefix + "Context", |
| new LifecycleListenerRule |
| ("org.apache.catalina.startup.ContextConfig", |
| "configClass")); |
| digester.addSetNext(prefix + "Context", |
| "addChild", |
| "org.apache.catalina.Container"); |
| } |
| } else { |
| digester.addSetNext(prefix + "Context", |
| "addDefaultContext", |
| "org.apache.catalina.DefaultContext"); |
| } |
| |
| digester.addCallMethod(prefix + "Context/InstanceListener", |
| "addInstanceListener", 0); |
| |
| digester.addObjectCreate(prefix + "Context/Listener", |
| null, // MUST be specified in the element |
| "className"); |
| digester.addSetProperties(prefix + "Context/Listener"); |
| digester.addSetNext(prefix + "Context/Listener", |
| "addLifecycleListener", |
| "org.apache.catalina.LifecycleListener"); |
| |
| digester.addRule(prefix + "Context/Loader", |
| new CreateLoaderRule |
| ("org.apache.catalina.loader.WebappLoader", |
| "className")); |
| digester.addSetProperties(prefix + "Context/Loader"); |
| digester.addSetNext(prefix + "Context/Loader", |
| "setLoader", |
| "org.apache.catalina.Loader"); |
| |
| digester.addObjectCreate(prefix + "Context/Manager", |
| "org.apache.catalina.session.StandardManager", |
| "className"); |
| digester.addSetProperties(prefix + "Context/Manager"); |
| digester.addSetNext(prefix + "Context/Manager", |
| "setManager", |
| "org.apache.catalina.Manager"); |
| |
| digester.addObjectCreate(prefix + "Context/Manager/Store", |
| null, // MUST be specified in the element |
| "className"); |
| digester.addSetProperties(prefix + "Context/Manager/Store"); |
| digester.addSetNext(prefix + "Context/Manager/Store", |
| "setStore", |
| "org.apache.catalina.Store"); |
| |
| digester.addObjectCreate(prefix + "Context/Parameter", |
| "org.apache.catalina.deploy.ApplicationParameter"); |
| digester.addSetProperties(prefix + "Context/Parameter"); |
| digester.addSetNext(prefix + "Context/Parameter", |
| "addApplicationParameter", |
| "org.apache.catalina.deploy.ApplicationParameter"); |
| |
| digester.addObjectCreate(prefix + "Context/Realm", |
| null, // MUST be specified in the element |
| "className"); |
| digester.addSetProperties(prefix + "Context/Realm"); |
| digester.addSetNext(prefix + "Context/Realm", |
| "setRealm", |
| "org.apache.catalina.Realm"); |
| |
| digester.addObjectCreate(prefix + "Context/Resources", |
| "org.apache.naming.resources.FileDirContext", |
| "className"); |
| digester.addSetProperties(prefix + "Context/Resources"); |
| digester.addSetNext(prefix + "Context/Resources", |
| "setResources", |
| "javax.naming.directory.DirContext"); |
| |
| digester.addObjectCreate(prefix + "Context/Valve", |
| null, // MUST be specified in the element |
| "className"); |
| digester.addSetProperties(prefix + "Context/Valve"); |
| digester.addSetNext(prefix + "Context/Valve", |
| "addValve", |
| "org.apache.catalina.Valve"); |
| |
| digester.addCallMethod(prefix + "Context/WatchedResource", |
| "addWatchedResource", 0); |
| |
| digester.addCallMethod(prefix + "Context/WrapperLifecycle", |
| "addWrapperLifecycle", 0); |
| |
| digester.addCallMethod(prefix + "Context/WrapperListener", |
| "addWrapperListener", 0); |
| |
| } |
| |
| |
| // ------------------------------------------------------ Protected Methods |
| |
| |
| /** |
| * Are we processing a DefaultContext element? |
| */ |
| protected boolean isDefaultContext() { |
| |
| return (prefix.endsWith("/Default")); |
| |
| } |
| |
| |
| } |
| |
| |
| // ----------------------------------------------------------- Private Classes |
| |
| |
| /** |
| * Rule that creates a new <code>Loader</code> instance, with the parent |
| * class loader associated with the top object on the stack (which must be |
| * a <code>Container</code>), and pushes it on to the stack. |
| */ |
| |
| final class CreateLoaderRule extends Rule { |
| |
| public CreateLoaderRule(String loaderClass, String attributeName) { |
| |
| this.loaderClass = loaderClass; |
| this.attributeName = attributeName; |
| |
| } |
| |
| private String attributeName; |
| |
| private String loaderClass; |
| |
| public void begin(String namespace, String name, Attributes attributes) |
| throws Exception { |
| |
| // Look up the required parent class loader |
| ClassLoader parentClassLoader = null; |
| Object ojb = digester.peek(); |
| if (ojb instanceof Container) { |
| parentClassLoader = ((Container)ojb).getParentClassLoader(); |
| } |
| |
| // Instantiate a new Loader implementation object |
| String className = loaderClass; |
| if (attributeName != null) { |
| String value = attributes.getValue(attributeName); |
| if (value != null) |
| className = value; |
| } |
| Class clazz = Class.forName(className); |
| Class types[] = { ClassLoader.class }; |
| Object args[] = { parentClassLoader }; |
| Constructor constructor = clazz.getDeclaredConstructor(types); |
| Loader loader = (Loader) constructor.newInstance(args); |
| |
| // Push the new loader onto the stack |
| digester.push(loader); |
| if (digester.getLogger().isDebugEnabled()) |
| digester.getLogger().debug("new " + loader.getClass().getName()); |
| |
| } |
| |
| public void end(String namespace, String name) |
| throws Exception { |
| |
| Loader loader = (Loader) digester.pop(); |
| if (digester.getLogger().isDebugEnabled()) |
| digester.getLogger().debug("pop " + loader.getClass().getName()); |
| |
| } |
| |
| |
| } |
