Author: remy.maucherat(a)jboss.com Date: 2011-05-13 10:51:45 -0400 (Fri, 13 May 2011) New Revision: 1724 Removed: trunk/java/org/apache/catalina/startup/Catalina.java trunk/java/org/apache/catalina/startup/Embedded.java Log: - Remove the main embedded classes, not used anymore. Deleted: trunk/java/org/apache/catalina/startup/Catalina.java =================================================================== --- trunk/java/org/apache/catalina/startup/Catalina.java 2011-05-12 08:27:03 UTC (rev 1723) +++ trunk/java/org/apache/catalina/startup/Catalina.java 2011-05-13 14:51:45 UTC (rev 1724) @@ -1,111 +0,0 @@ -/* - * 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.catalina.startup; - - -import org.apache.catalina.Lifecycle; -import org.apache.catalina.LifecycleException; -import org.apache.catalina.Server; - - -/** - * Wrapper impl of Embedded. - * - * @author Craig R. McClanahan - * @author Remy Maucherat - * @version $Revision$ $Date$ - */ - -public class Catalina extends Embedded { - - - // ----------------------------------------------------- Instance Variables - - - /** - * The server component we are starting or stopping - */ - protected Server server = null; - - - /** - * Are we starting a new server? - */ - protected boolean starting = false; - - - /** - * Are we stopping an existing server? - */ - protected boolean stopping = false; - - - // ------------------------------------------------------------- Properties - - - public Server getServer() { - return server; - } - - public void setServer(Server server) { - this.server = server; - } - - public void create() { - } - - public void destroy() { - } - - /** - * Start a new server instance. - */ - public void start() { - // Start the new server - if (server instanceof Lifecycle) { - try { - ((Lifecycle) server).start(); - } catch (LifecycleException e) { - log.error("Catalina.start: ", e); - } - } - } - - - /** - * Stop an existing server instance. - */ - public void stop() { - - // Shut down the server - if (server instanceof Lifecycle) { - try { - ((Lifecycle) server).stop(); - } catch (LifecycleException e) { - log.error("Catalina.stop", e); - } - } - - } - - - private static org.jboss.logging.Logger log= - org.jboss.logging.Logger.getLogger( Catalina.class ); - -} Deleted: trunk/java/org/apache/catalina/startup/Embedded.java =================================================================== --- trunk/java/org/apache/catalina/startup/Embedded.java 2011-05-12 08:27:03 UTC (rev 1723) +++ trunk/java/org/apache/catalina/startup/Embedded.java 2011-05-13 14:51:45 UTC (rev 1724) @@ -1,785 +0,0 @@ -/* - * 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.catalina.startup; - - -import java.net.InetAddress; -import java.util.HashMap; - -import org.apache.catalina.Authenticator; -import org.apache.catalina.Container; -import org.apache.catalina.Context; -import org.apache.catalina.Engine; -import org.apache.catalina.Host; -import org.apache.catalina.Lifecycle; -import org.apache.catalina.LifecycleException; -import org.apache.catalina.LifecycleListener; -import org.apache.catalina.Realm; -import org.apache.catalina.Valve; -import org.apache.catalina.connector.Connector; -import org.apache.catalina.core.StandardContext; -import org.apache.catalina.core.StandardEngine; -import org.apache.catalina.core.StandardHost; -import org.apache.catalina.core.StandardService; -import org.apache.catalina.security.SecurityConfig; -import org.apache.catalina.util.LifecycleSupport; -import org.apache.catalina.util.StringManager; -import org.apache.tomcat.util.IntrospectionUtils; -import org.jboss.logging.Logger; - - -/** - * Convenience class to embed a Catalina servlet container environment - * inside another application. You must call the methods of this class in the - * following order to ensure correct operation. - * - * <ul> - * <li>Instantiate a new instance of this class.</li> - * <li>Set the relevant properties of this object itself. In particular, - * you will want to establish the default Logger to be used, as well - * as the default Realm if you are using container-managed security.</li> - * <li>Call <code>createEngine()</code> to create an Engine object, and then - * call its property setters as desired.</li> - * <li>Call <code>createHost()</code> to create at least one virtual Host - * associated with the newly created Engine, and then call its property - * setters as desired. After you customize this Host, add it to the - * corresponding Engine with <code>engine.addChild(host)</code>.</li> - * <li>Call <code>createContext()</code> to create at least one Context - * associated with each newly created Host, and then call its property - * setters as desired. You <strong>SHOULD</strong> create a Context with - * a pathname equal to a zero-length string, which will be used to process - * all requests not mapped to some other Context. After you customize - * this Context, add it to the corresponding Host with - * <code>host.addChild(context)</code>.</li> - * <li>Call <code>addEngine()</code> to attach this Engine to the set of - * defined Engines for this object.</li> - * <li>Call <code>createConnector()</code> to create at least one TCP/IP - * connector, and then call its property setters as desired.</li> - * <li>Call <code>addConnector()</code> to attach this Connector to the set - * of defined Connectors for this object. The added Connector will use - * the most recently added Engine to process its received requests.</li> - * <li>Repeat the above series of steps as often as required (although there - * will typically be only one Engine instance created).</li> - * <li>Call <code>start()</code> to initiate normal operations of all the - * attached components.</li> - * </ul> - * - * After normal operations have begun, you can add and remove Connectors, - * Engines, Hosts, and Contexts on the fly. However, once you have removed - * a particular component, it must be thrown away -- you can create a new one - * with the same characteristics if you merely want to do a restart. - * <p> - * To initiate a normal shutdown, call the <code>stop()</code> method of - * this object. - * <p> - * @see org.apache.catalina.startup.Catalina#main For a complete example - * of how Tomcat is set up and launched as an Embedded application. - * - * @author Craig R. McClanahan - * @version $Revision$ $Date$ - */ - -public class Embedded extends StandardService implements Lifecycle { - private static Logger log = Logger.getLogger(Embedded.class); - - // ----------------------------------------------------------- Constructors - - - /** - * Construct a new instance of this class with default properties. - */ - public Embedded() { - - this(null); - - } - - - /** - * Construct a new instance of this class with specified properties. - * - * @param realm Realm implementation to be inherited by all components - * (unless overridden further down the container hierarchy) - */ - public Embedded(Realm realm) { - - super(); - setRealm(realm); - setSecurityProtection(); - - } - - - // ----------------------------------------------------- Instance Variables - - - /** - * The set of Engines that have been deployed in this server. Normally - * there will only be one. - */ - protected Engine engines[] = new Engine[0]; - - - /** - * Custom mappings of login methods to authenticators - */ - protected HashMap authenticators; - - - /** - * Descriptive information about this server implementation. - */ - protected static final String info = - "org.apache.catalina.startup.Embedded/1.0"; - - - /** - * The lifecycle event support for this component. - */ - protected LifecycleSupport lifecycle = new LifecycleSupport(this); - - - /** - * The default realm to be used by all containers associated with - * this compoennt. - */ - protected Realm realm = null; - - - /** - * The string manager for this package. - */ - protected static StringManager sm = - StringManager.getManager(Constants.Package); - - - /** - * Has this component been started yet? - */ - protected boolean started = false; - - // ------------------------------------------------------------- Properties - - - /** - * Return the default Realm for our Containers. - */ - public Realm getRealm() { - - return (this.realm); - - } - - - /** - * Set the default Realm for our Containers. - * - * @param realm The new default realm - */ - public void setRealm(Realm realm) { - - Realm oldRealm = this.realm; - this.realm = realm; - support.firePropertyChange("realm", oldRealm, this.realm); - - } - - public void setCatalinaHome( String s ) { - System.setProperty( "catalina.home", s); - } - - public void setCatalinaBase( String s ) { - System.setProperty( "catalina.base", s); - } - - public String getCatalinaHome() { - return System.getProperty("catalina.home"); - } - - public String getCatalinaBase() { - return System.getProperty("catalina.base"); - } - - - // --------------------------------------------------------- Public Methods - - /** - * Add a new Connector to the set of defined Connectors. The newly - * added Connector will be associated with the most recently added Engine. - * - * @param connector The connector to be added - * - * @exception IllegalStateException if no engines have been added yet - */ - public synchronized void addConnector(Connector connector) { - - if( log.isDebugEnabled() ) { - log.debug("Adding connector (" + connector.getInfo() + ")"); - } - - // Make sure we have a Container to send requests to - if (engines.length < 1) - throw new IllegalStateException - (sm.getString("embedded.noEngines")); - - /* - * Add the connector. This will set the connector's container to the - * most recently added Engine - */ - super.addConnector(connector); - } - - - /** - * Add a new Engine to the set of defined Engines. - * - * @param engine The engine to be added - */ - public synchronized void addEngine(Engine engine) { - - if( log.isDebugEnabled() ) - log.debug("Adding engine (" + engine.getInfo() + ")"); - - // Add this Engine to our set of defined Engines - Engine results[] = new Engine[engines.length + 1]; - for (int i = 0; i < engines.length; i++) - results[i] = engines[i]; - results[engines.length] = engine; - engines = results; - - // Start this Engine if necessary - if (started && (engine instanceof Lifecycle)) { - try { - ((Lifecycle) engine).start(); - } catch (LifecycleException e) { - log.error("Engine.start", e); - } - } - - this.container = engine; - } - - - /** - * Create, configure, and return a new TCP/IP socket connector - * based on the specified properties. - * - * @param address InetAddress to bind to, or <code>null</code> if the - * connector is supposed to bind to all addresses on this server - * @param port Port number to listen to - * @param secure true if the generated connector is supposed to be - * SSL-enabled, and false otherwise - */ - public Connector createConnector(InetAddress address, int port, - boolean secure) { - return createConnector(address != null? address.toString() : null, - port, secure); - } - - public Connector createConnector(String address, int port, - boolean secure) { - String protocol = "http"; - if (secure) { - protocol = "https"; - } - - return createConnector(address, port, protocol); - } - - - public Connector createConnector(InetAddress address, int port, - String protocol) { - return createConnector(address != null? address.toString() : null, - port, protocol); - } - - public Connector createConnector(String address, int port, - String protocol) { - - Connector connector = null; - - if (address != null) { - /* - * InetAddress.toString() returns a string of the form - * "<hostname>/<literal_IP>". Get the latter part, so that the - * address can be parsed (back) into an InetAddress using - * InetAddress.getByName(). - */ - int index = address.indexOf('/'); - if (index != -1) { - address = address.substring(index + 1); - } - } - - if (log.isDebugEnabled()) { - log.debug("Creating connector for address='" + - ((address == null) ? "ALL" : address) + - "' port='" + port + "' protocol='" + protocol + "'"); - } - - try { - - if (protocol.equals("ajp")) { - connector = new Connector("org.apache.coyote.ajp.AjpProtocol"); - } else if (protocol.equals("memory")) { - connector = new Connector("org.apache.coyote.memory.MemoryProtocolHandler"); - } else if (protocol.equals("http")) { - connector = new Connector("http"); - } else if (protocol.equals("https")) { - connector = new Connector("http"); - connector.setScheme("https"); - connector.setSecure(true); - connector.setProperty("SSLEnabled","true"); - // FIXME !!!! SET SSL PROPERTIES - } else { - connector = new Connector(protocol); - } - - if (address != null) { - IntrospectionUtils.setProperty(connector, "address", - "" + address); - } - IntrospectionUtils.setProperty(connector, "port", "" + port); - - } catch (Exception e) { - log.error("Couldn't create connector."); - } - - return (connector); - - } - - /** - * Create, configure, and return a Context that will process all - * HTTP requests received from one of the associated Connectors, - * and directed to the specified context path on the virtual host - * to which this Context is connected. - * <p> - * After you have customized the properties, listeners, and Valves - * for this Context, you must attach it to the corresponding Host - * by calling: - * <pre> - * host.addChild(context); - * </pre> - * which will also cause the Context to be started if the Host has - * already been started. - * - * @param path Context path of this application ("" for the default - * application for this host, must start with a slash otherwise) - * @param docBase Absolute pathname to the document base directory - * for this web application - * - * @exception IllegalArgumentException if an invalid parameter - * is specified - */ - public Context createContext(String path, String docBase, ContextConfig config) { - - if( log.isDebugEnabled() ) - log.debug("Creating context '" + path + "' with docBase '" + - docBase + "'"); - - StandardContext context = new StandardContext(); - - context.setDocBase(docBase); - context.setPath(path); - - config.setCustomAuthenticators(authenticators); - ((Lifecycle) context).addLifecycleListener(config); - - return (context); - - } - - - /** - * Create, configure, and return an Engine that will process all - * HTTP requests received from one of the associated Connectors, - * based on the specified properties. - */ - public Engine createEngine() { - - if( log.isDebugEnabled() ) - log.debug("Creating engine"); - - StandardEngine engine = new StandardEngine(); - - // Default host will be set to the first host added - engine.setRealm(realm); // Inherited by all children - - return (engine); - - } - - - /** - * Create, configure, and return a Host that will process all - * HTTP requests received from one of the associated Connectors, - * and directed to the specified virtual host. - * <p> - * After you have customized the properties, listeners, and Valves - * for this Host, you must attach it to the corresponding Engine - * by calling: - * <pre> - * engine.addChild(host); - * </pre> - * which will also cause the Host to be started if the Engine has - * already been started. If this is the default (or only) Host you - * will be defining, you may also tell the Engine to pass all requests - * not assigned to another virtual host to this one: - * <pre> - * engine.setDefaultHost(host.getName()); - * </pre> - * - * @param name Canonical name of this virtual host - * @param appBase Absolute pathname to the application base directory - * for this virtual host - * - * @exception IllegalArgumentException if an invalid parameter - * is specified - */ - public Host createHost(String name, String appBase) { - - if( log.isDebugEnabled() ) - log.debug("Creating host '" + name + "' with appBase '" + - appBase + "'"); - - StandardHost host = new StandardHost(); - - host.setAppBase(appBase); - host.setName(name); - - return (host); - - } - - - /** - * Return descriptive information about this Server implementation and - * the corresponding version number, in the format - * <code>&lt;description&gt;/&lt;version&gt;</code>. - */ - public String getInfo() { - - return (info); - - } - - - /** - * Remove the specified Context from the set of defined Contexts for its - * associated Host. If this is the last Context for this Host, the Host - * will also be removed. - * - * @param context The Context to be removed - */ - public synchronized void removeContext(Context context) { - - if( log.isDebugEnabled() ) - log.debug("Removing context[" + context.getPath() + "]"); - - // Is this Context actually among those that are defined? - boolean found = false; - for (int i = 0; i < engines.length; i++) { - Container hosts[] = engines[i].findChildren(); - for (int j = 0; j < hosts.length; j++) { - Container contexts[] = hosts[j].findChildren(); - for (int k = 0; k < contexts.length; k++) { - if (context == (Context) contexts[k]) { - found = true; - break; - } - } - if (found) - break; - } - if (found) - break; - } - if (!found) - return; - - // Remove this Context from the associated Host - if( log.isDebugEnabled() ) - log.debug(" Removing this Context"); - context.getParent().removeChild(context); - - } - - - /** - * Remove the specified Engine from the set of defined Engines, along with - * all of its related Hosts and Contexts. All associated Connectors are - * also removed. - * - * @param engine The Engine to be removed - */ - public synchronized void removeEngine(Engine engine) { - - if( log.isDebugEnabled() ) - log.debug("Removing engine (" + engine.getInfo() + ")"); - - // Is the specified Engine actually defined? - int j = -1; - for (int i = 0; i < engines.length; i++) { - if (engine == engines[i]) { - j = i; - break; - } - } - if (j < 0) - return; - - // Remove any Connector that is using this Engine - if( log.isDebugEnabled() ) - log.debug(" Removing related Containers"); - while (true) { - int n = -1; - for (int i = 0; i < connectors.length; i++) { - if (connectors[i].getContainer() == (Container) engine) { - n = i; - break; - } - } - if (n < 0) - break; - removeConnector(connectors[n]); - } - - // Stop this Engine if necessary - if (engine instanceof Lifecycle) { - if( log.isDebugEnabled() ) - log.debug(" Stopping this Engine"); - try { - ((Lifecycle) engine).stop(); - } catch (LifecycleException e) { - log.error("Engine.stop", e); - } - } - - // Remove this Engine from our set of defined Engines - if( log.isDebugEnabled() ) - log.debug(" Removing this Engine"); - int k = 0; - Engine results[] = new Engine[engines.length - 1]; - for (int i = 0; i < engines.length; i++) { - if (i != j) - results[k++] = engines[i]; - } - engines = results; - - } - - - /** - * Remove the specified Host, along with all of its related Contexts, - * from the set of defined Hosts for its associated Engine. If this is - * the last Host for this Engine, the Engine will also be removed. - * - * @param host The Host to be removed - */ - public synchronized void removeHost(Host host) { - - if( log.isDebugEnabled() ) - log.debug("Removing host[" + host.getName() + "]"); - - // Is this Host actually among those that are defined? - boolean found = false; - for (int i = 0; i < engines.length; i++) { - Container hosts[] = engines[i].findChildren(); - for (int j = 0; j < hosts.length; j++) { - if (host == (Host) hosts[j]) { - found = true; - break; - - } - } - if (found) - break; - } - if (!found) - return; - - // Remove this Host from the associated Engine - if( log.isDebugEnabled() ) - log.debug(" Removing this Host"); - host.getParent().removeChild(host); - - } - - - /* - * Maps the specified login method to the specified authenticator, allowing - * the mappings in org/apache/catalina/startup/Authenticators.properties - * to be overridden. - * - * @param authenticator Authenticator to handle authentication for the - * specified login method - * @param loginMethod Login method that maps to the specified authenticator - * - * @throws IllegalArgumentException if the specified authenticator does not - * implement the org.apache.catalina.Valve interface - */ - public void addAuthenticator(Authenticator authenticator, - String loginMethod) { - if (!(authenticator instanceof Valve)) { - throw new IllegalArgumentException( - sm.getString("embedded.authenticatorNotInstanceOfValve")); - } - if (authenticators == null) { - synchronized (this) { - if (authenticators == null) { - authenticators = new HashMap(); - } - } - } - authenticators.put(loginMethod, authenticator); - } - - - // ------------------------------------------------------ Lifecycle Methods - - - /** - * Add a lifecycle event listener to this component. - * - * @param listener The listener to add - */ - public void addLifecycleListener(LifecycleListener listener) { - - lifecycle.addLifecycleListener(listener); - - } - - - /** - * Get the lifecycle listeners associated with this lifecycle. If this - * Lifecycle has no listeners registered, a zero-length array is returned. - */ - public LifecycleListener[] findLifecycleListeners() { - - return lifecycle.findLifecycleListeners(); - - } - - - /** - * Remove a lifecycle event listener from this component. - * - * @param listener The listener to remove - */ - public void removeLifecycleListener(LifecycleListener listener) { - - lifecycle.removeLifecycleListener(listener); - - } - - - /** - * Prepare for the beginning of active use of the public methods of this - * component. This method should be called after <code>configure()</code>, - * and before any of the public methods of the component are utilized. - * - * @exception LifecycleException if this component detects a fatal error - * that prevents this component from being used - */ - public void start() throws LifecycleException { - - if( log.isInfoEnabled() ) - log.info("Starting tomcat server"); - - // Initialise if not already done. - if (!initialized) { - initialized = true; - lifecycle.fireLifecycleEvent(INIT_EVENT, null); - } - - // Validate and update our current component state - if (started) - throw new LifecycleException - (sm.getString("embedded.alreadyStarted")); - lifecycle.fireLifecycleEvent(START_EVENT, null); - started = true; - - // Start our defined Engines first - for (int i = 0; i < engines.length; i++) { - if (engines[i] instanceof Lifecycle) - ((Lifecycle) engines[i]).start(); - } - - // Start our defined Connectors second - for (int i = 0; i < connectors.length; i++) { - connectors[i].init(); - if (connectors[i] instanceof Lifecycle) - ((Lifecycle) connectors[i]).start(); - } - - } - - - /** - * Gracefully terminate the active use of the public methods of this - * component. This method should be the last one called on a given - * instance of this component. - * - * @exception LifecycleException if this component detects a fatal error - * that needs to be reported - */ - public void stop() throws LifecycleException { - - if( log.isDebugEnabled() ) - log.debug("Stopping embedded server"); - - // Validate and update our current component state - if (!started) - throw new LifecycleException - (sm.getString("embedded.notStarted")); - lifecycle.fireLifecycleEvent(STOP_EVENT, null); - started = false; - - // Stop our defined Connectors first - for (int i = 0; i < connectors.length; i++) { - if (connectors[i] instanceof Lifecycle) - ((Lifecycle) connectors[i]).stop(); - } - - // Stop our defined Engines second - for (int i = 0; i < engines.length; i++) { - if (engines[i] instanceof Lifecycle) - ((Lifecycle) engines[i]).stop(); - } - if (initialized) { - initialized = false; - lifecycle.fireLifecycleEvent(AFTER_STOP_EVENT, null); - } - - } - - - // -------------------------------------------------------- Private Methods - - /** - * Set the security package access/protection. - */ - protected void setSecurityProtection(){ - SecurityConfig securityConfig = SecurityConfig.newInstance(); - securityConfig.setPackageDefinition(); - securityConfig.setPackageAccess(); - } - -}