org.apache.catalina.startup.ContextRuleSet Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2012 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Copyright 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.
*/
// Portions Copyright [2019] Payara Foundation and/or affiliates
package org.apache.catalina.startup;
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;
import java.lang.reflect.Constructor;
/**
* RuleSet 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".
*
* @author Craig R. McClanahan
* @version $Revision: 1.6 $ $Date: 2007/08/22 23:38:51 $
*/
public class ContextRuleSet extends RuleSetBase {
// ----------------------------------------------------- Instance Variables
// START GlassFish 2439
/**
* Should the context be created.
*/
protected boolean create = true;
// END GlassFish 2439
/**
* The matching pattern prefix to use for recognizing our elements.
*/
protected String prefix = null;
// ------------------------------------------------------------ Constructor
/**
* Construct an instance of this RuleSet with the default
* matching pattern prefix.
*/
public ContextRuleSet() {
this("");
}
/**
* Construct an instance of this RuleSet with the specified
* matching pattern prefix.
*
* @param prefix Prefix for matching pattern rules (including the
* trailing slash character)
*/
public ContextRuleSet(String prefix) {
super();
this.prefix = prefix;
}
// START GlassFish 2439
/**
* Construct an instance of this RuleSet 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.prefix = prefix;
this.create = create;
}
// END GlassFish 2439
// --------------------------------------------------------- Public Methods
/**
* Add the set of Rule instances defined in this RuleSet to the
* specified Digester instance, associating them with
* our namespace URI (if any). This method should only be called
* by a Digester instance.
*
* @param digester Digester instance to which the new Rule instances
* should be added.
*/
@Override
public void addRuleInstances(Digester digester) {
if (create) {
digester.addObjectCreate(prefix + "Context",
"org.apache.catalina.core.StandardContext", "className");
digester.addSetProperties(prefix + "Context");
} else {
digester.addRule(prefix + "Context", new SetContextPropertiesRule());
}
if (create) {
digester.addRule(prefix + "Context",
new LifecycleListenerRule
(digester,
"org.apache.catalina.startup.ContextConfig",
"configClass"));
digester.addSetNext(prefix + "Context",
"addChild",
"org.apache.catalina.Container");
}
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.addObjectCreate(prefix + "Context/Loader",
"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/ResourceLink",
"org.apache.catalina.deploy.ContextResourceLink");
digester.addSetProperties(prefix + "Context/ResourceLink");
digester.addSetNext(prefix + "Context/ResourceLink",
"addResourceLink",
"org.apache.catalina.deploy.ContextResourceLink");
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.glassfish.web.valve.GlassFishValve");
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 Loader instance, with the parent
* class loader associated with the top object on the stack (which must be
* a Container), and pushes it on to the stack.
*/
final class CreateLoaderRule extends Rule {
public CreateLoaderRule(Digester digester, String loaderClass,
String attributeName) {
super(digester);
this.loaderClass = loaderClass;
this.attributeName = attributeName;
}
private final String attributeName;
private final String loaderClass;
@Override
public void begin(Attributes attributes) throws Exception {
// Look up the required parent class loader
Container container = (Container) digester.peek();
ClassLoader parentClassLoader = container.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.getDebug() >= 1)
digester.log("new " + loader.getClass().getName());
}
@Override
public void end() throws Exception {
Loader loader = (Loader) digester.pop();
if (digester.getDebug() >= 1)
digester.log("pop " + loader.getClass().getName());
}
}