Home » apache-tomcat-6.0.26-src » org.apache » catalina » startup » [javadoc | source]

org.apache.catalina.startup
public class: Catalina [javadoc | source]

java.lang.Object
   org.apache.catalina.core.StandardService
      org.apache.catalina.startup.Embedded
         org.apache.catalina.startup.Catalina

All Implemented Interfaces:
    Lifecycle, Service, MBeanRegistration

Startup/Shutdown shell program for Catalina. The following command line options are recognized:

• -config {pathname} - Set the pathname of the configuration file to be processed. If a relative path is specified, it will be interpreted as relative to the directory pathname specified by the "catalina.base" system property. [conf/server.xml]
• -help - Display usage information.
• -nonaming - Disable naming support.
• start - Start an instance of Catalina.
• stop - Stop the currently running instance of Catalina. Should do the same thing as Embedded, but using a server.xml file.
  author: Craig - R. McClanahan
  
  author: Remy - Maucherat
  
  version: $ - Revision: 919742 $ $Date: 2010-03-06 12:15:07 +0100 (Sat, 06 Mar 2010) $
  

  Nested Class Summary:
  protected class	Catalina.CatalinaShutdownHook	Shutdown hook which will perform a clean shutdown of Catalina if needed.

  Field Summary
  protected  String	configFile	Pathname to the server configuration file.
  protected  ClassLoader	parentClassLoader	The shared extensions class loader for this server.
  protected  boolean	starting	Are we starting a new server?
  protected  boolean	stopping	Are we stopping an existing server?
  protected  boolean	useShutdownHook	Use shutdown hook flag.
  protected  Thread	shutdownHook	Shutdown hook.

  Fields inherited from org.apache.catalina.startup.Embedded:
  useNaming,  redirectStreams,  engines,  authenticators,  info,  lifecycle,  realm,  sm,  started,  await

  Fields inherited from org.apache.catalina.core.StandardService:
  support,  connectors,  executors,  container,  initialized,  type,  domain,  suffix,  oname,  controller,  mserver

  Method from org.apache.catalina.startup.Catalina Summary:
  arguments,   await,   configFile,   create,   createStartDigester,   createStopDigester,   destroy,   getConfigFile,   getUseShutdownHook,   load,   load,   main,   process,   setCatalinaBase,   setCatalinaHome,   setConfig,   setConfigFile,   setParentClassLoader,   setUseShutdownHook,   start,   stop,   stopServer,   stopServer,   usage

  Methods from org.apache.catalina.startup.Embedded:

  addAuthenticator,   addConnector,   addEngine,   addLifecycleListener,   createConnector,   createConnector,   createConnector,   createConnector,   createContext,   createEngine,   createHost,   createLoader,   findLifecycleListeners,   getCatalinaBase,   getCatalinaHome,   getInfo,   getRealm,   initDirs,   initNaming,   initStreams,   isAwait,   isRedirectStreams,   isUseNaming,   removeContext,   removeEngine,   removeHost,   removeLifecycleListener,   setAwait,   setCatalinaBase,   setCatalinaHome,   setRealm,   setRedirectStreams,   setSecurityProtection,   setUseNaming,   start,   stop

  Methods from org.apache.catalina.core.StandardService:

  addConnector,   addExecutor,   addLifecycleListener,   addPropertyChangeListener,   destroy,   findConnectors,   findExecutors,   findLifecycleListeners,   getConnectorNames,   getContainer,   getContainerName,   getDomain,   getExecutor,   getInfo,   getName,   getObjectName,   getServer,   init,   initialize,   postDeregister,   postRegister,   preDeregister,   preRegister,   removeConnector,   removeExecutor,   removeLifecycleListener,   removePropertyChangeListener,   setContainer,   setName,   setServer,   start,   stop,   toString

  Methods from java.lang.Object:
  clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait

  Method from org.apache.catalina.startup.Catalina Detail:
  protected boolean arguments(String[] args) { boolean isConfig = false; if (args.length < 1) { usage(); return (false); } for (int i = 0; i < args.length; i++) { if (isConfig) { configFile = args[i]; isConfig = false; } else if (args[i].equals("-config")) { isConfig = true; } else if (args[i].equals("-nonaming")) { setUseNaming( false ); } else if (args[i].equals("-help")) { usage(); return (false); } else if (args[i].equals("start")) { starting = true; stopping = false; } else if (args[i].equals("stop")) { starting = false; stopping = true; } else { usage(); return (false); } } return (true); } Process the specified command line arguments, and return true if we should continue processing; otherwise return false.
  public void await() { getServer().await(); } Await and shutdown.
  protected File configFile() { File file = new File(configFile); if (!file.isAbsolute()) file = new File(System.getProperty("catalina.base"), configFile); return (file); } Return a File object representing our configuration file.
  public void create() { }
  protected Digester createStartDigester() { long t1=System.currentTimeMillis(); // Initialize the digester Digester digester = new Digester(); digester.setValidating(false); digester.setRulesValidation(true); HashMap< Class, List< String > > fakeAttributes = new HashMap< Class, List< String > >(); ArrayList< String > attrs = new ArrayList< String >(); attrs.add("className"); fakeAttributes.put(Object.class, attrs); digester.setFakeAttributes(fakeAttributes); digester.setClassLoader(StandardServer.class.getClassLoader()); // Configure the actions we will be using digester.addObjectCreate("Server", "org.apache.catalina.core.StandardServer", "className"); digester.addSetProperties("Server"); digester.addSetNext("Server", "setServer", "org.apache.catalina.Server"); digester.addObjectCreate("Server/GlobalNamingResources", "org.apache.catalina.deploy.NamingResources"); digester.addSetProperties("Server/GlobalNamingResources"); digester.addSetNext("Server/GlobalNamingResources", "setGlobalNamingResources", "org.apache.catalina.deploy.NamingResources"); digester.addObjectCreate("Server/Listener", null, // MUST be specified in the element "className"); digester.addSetProperties("Server/Listener"); digester.addSetNext("Server/Listener", "addLifecycleListener", "org.apache.catalina.LifecycleListener"); digester.addObjectCreate("Server/Service", "org.apache.catalina.core.StandardService", "className"); digester.addSetProperties("Server/Service"); digester.addSetNext("Server/Service", "addService", "org.apache.catalina.Service"); digester.addObjectCreate("Server/Service/Listener", null, // MUST be specified in the element "className"); digester.addSetProperties("Server/Service/Listener"); digester.addSetNext("Server/Service/Listener", "addLifecycleListener", "org.apache.catalina.LifecycleListener"); //Executor digester.addObjectCreate("Server/Service/Executor", "org.apache.catalina.core.StandardThreadExecutor", "className"); digester.addSetProperties("Server/Service/Executor"); digester.addSetNext("Server/Service/Executor", "addExecutor", "org.apache.catalina.Executor"); digester.addRule("Server/Service/Connector", new ConnectorCreateRule()); digester.addRule("Server/Service/Connector", new SetAllPropertiesRule(new String[]{"executor"})); digester.addSetNext("Server/Service/Connector", "addConnector", "org.apache.catalina.connector.Connector"); digester.addObjectCreate("Server/Service/Connector/Listener", null, // MUST be specified in the element "className"); digester.addSetProperties("Server/Service/Connector/Listener"); digester.addSetNext("Server/Service/Connector/Listener", "addLifecycleListener", "org.apache.catalina.LifecycleListener"); // Add RuleSets for nested elements digester.addRuleSet(new NamingRuleSet("Server/GlobalNamingResources/")); digester.addRuleSet(new EngineRuleSet("Server/Service/")); digester.addRuleSet(new HostRuleSet("Server/Service/Engine/")); digester.addRuleSet(new ContextRuleSet("Server/Service/Engine/Host/")); digester.addRuleSet(ClusterRuleSetFactory.getClusterRuleSet("Server/Service/Engine/Host/Cluster/")); digester.addRuleSet(new NamingRuleSet("Server/Service/Engine/Host/Context/")); // When the 'engine' is found, set the parentClassLoader. digester.addRule("Server/Service/Engine", new SetParentClassLoaderRule(parentClassLoader)); digester.addRuleSet(ClusterRuleSetFactory.getClusterRuleSet("Server/Service/Engine/Cluster/")); long t2=System.currentTimeMillis(); if (log.isDebugEnabled()) log.debug("Digester for server.xml created " + ( t2-t1 )); return (digester); } Create and configure the Digester we will be using for startup.
  protected Digester createStopDigester() { // Initialize the digester Digester digester = new Digester(); // Configure the rules we need for shutting down digester.addObjectCreate("Server", "org.apache.catalina.core.StandardServer", "className"); digester.addSetProperties("Server"); digester.addSetNext("Server", "setServer", "org.apache.catalina.Server"); return (digester); } Create and configure the Digester we will be using for shutdown.
  public void destroy() { }
  public String getConfigFile() { return configFile; }
  public boolean getUseShutdownHook() { return useShutdownHook; }
  public void load() { long t1 = System.nanoTime(); initDirs(); // Before digester - it may be needed initNaming(); // Create and execute our Digester Digester digester = createStartDigester(); InputSource inputSource = null; InputStream inputStream = null; File file = null; try { file = configFile(); inputStream = new FileInputStream(file); inputSource = new InputSource("file://" + file.getAbsolutePath()); } catch (Exception e) { ; } if (inputStream == null) { try { inputStream = getClass().getClassLoader() .getResourceAsStream(getConfigFile()); inputSource = new InputSource (getClass().getClassLoader() .getResource(getConfigFile()).toString()); } catch (Exception e) { ; } } // This should be included in catalina.jar // Alternative: don't bother with xml, just create it manually. if( inputStream==null ) { try { inputStream = getClass().getClassLoader() .getResourceAsStream("server-embed.xml"); inputSource = new InputSource (getClass().getClassLoader() .getResource("server-embed.xml").toString()); } catch (Exception e) { ; } } if ((inputStream == null) && (file != null)) { log.warn("Can't load server.xml from " + file.getAbsolutePath()); if (file.exists() && !file.canRead()) { log.warn("Permissions incorrect, read permission is not allowed on the file."); } return; } try { inputSource.setByteStream(inputStream); digester.push(this); digester.parse(inputSource); inputStream.close(); } catch (Exception e) { log.warn("Catalina.start using " + getConfigFile() + ": " , e); return; } // Stream redirection initStreams(); // Start the new server if (getServer() instanceof Lifecycle) { try { getServer().initialize(); } catch (LifecycleException e) { if (Boolean.getBoolean("org.apache.catalina.startup.EXIT_ON_INIT_FAILURE")) throw new java.lang.Error(e); else log.error("Catalina.start", e); } } long t2 = System.nanoTime(); if(log.isInfoEnabled()) log.info("Initialization processed in " + ((t2 - t1) / 1000000) + " ms"); } Start a new server instance.
  public void load(String[] args) { try { if (arguments(args)) load(); } catch (Exception e) { e.printStackTrace(System.out); } }
  public static void main(String[] args) { (new Catalina()).process(args); } The application main program.
  public void process(String[] args) { setAwait(true); setCatalinaHome(); setCatalinaBase(); try { if (arguments(args)) { if (starting) { load(args); start(); } else if (stopping) { stopServer(); } } } catch (Exception e) { e.printStackTrace(System.out); } } The instance main program.
  public void setCatalinaBase() { initDirs(); } Deprecated! Use - initDirs() Set the catalina.base System property to the current working directory if it has not been set.
  public void setCatalinaHome() { initDirs(); } Deprecated! Use - initDirs() Set the catalina.home System property to the current working directory if it has not been set.
  public void setConfig(String file) { configFile = file; }
  public void setConfigFile(String file) { configFile = file; }
  public void setParentClassLoader(ClassLoader parentClassLoader) { this.parentClassLoader = parentClassLoader; } Set the shared extensions class loader.
  public void setUseShutdownHook(boolean useShutdownHook) { this.useShutdownHook = useShutdownHook; }
  public void start() { if (getServer() == null) { load(); } if (getServer() == null) { log.fatal("Cannot start server. Server instance is not configured."); return; } long t1 = System.nanoTime(); // Start the new server if (getServer() instanceof Lifecycle) { try { ((Lifecycle) getServer()).start(); } catch (LifecycleException e) { log.error("Catalina.start: ", e); } } long t2 = System.nanoTime(); if(log.isInfoEnabled()) log.info("Server startup in " + ((t2 - t1) / 1000000) + " ms"); try { // Register shutdown hook if (useShutdownHook) { if (shutdownHook == null) { shutdownHook = new CatalinaShutdownHook(); } Runtime.getRuntime().addShutdownHook(shutdownHook); // If JULI is being used, disable JULI's shutdown hook since // shutdown hooks run in parallel and log messages may be lost // if JULI's hook completes before the CatalinaShutdownHook() LogManager logManager = LogManager.getLogManager(); if (logManager instanceof ClassLoaderLogManager) { ((ClassLoaderLogManager) logManager).setUseShutdownHook( false); } } } catch (Throwable t) { // This will fail on JDK 1.2. Ignoring, as Tomcat can run // fine without the shutdown hook. } if (await) { await(); stop(); } } Start a new server instance.
  public void stop() { try { // Remove the ShutdownHook first so that server.stop() // doesn't get invoked twice if (useShutdownHook) { Runtime.getRuntime().removeShutdownHook(shutdownHook); // If JULI is being used, re-enable JULI's shutdown to ensure // log messages are not lost LogManager logManager = LogManager.getLogManager(); if (logManager instanceof ClassLoaderLogManager) { ((ClassLoaderLogManager) logManager).setUseShutdownHook( true); } } } catch (Throwable t) { // This will fail on JDK 1.2. Ignoring, as Tomcat can run // fine without the shutdown hook. } // Shut down the server if (getServer() instanceof Lifecycle) { try { ((Lifecycle) getServer()).stop(); } catch (LifecycleException e) { log.error("Catalina.stop", e); } } } Stop an existing server instance.
  public void stopServer() { stopServer(null); }
  public void stopServer(String[] arguments) { if (arguments != null) { arguments(arguments); } if( getServer() == null ) { // Create and execute our Digester Digester digester = createStopDigester(); digester.setClassLoader(Thread.currentThread().getContextClassLoader()); File file = configFile(); try { InputSource is = new InputSource("file://" + file.getAbsolutePath()); FileInputStream fis = new FileInputStream(file); is.setByteStream(fis); digester.push(this); digester.parse(is); fis.close(); } catch (Exception e) { log.error("Catalina.stop: ", e); System.exit(1); } } // Stop the existing server try { if (getServer().getPort() >0) { String hostAddress = InetAddress.getByName("localhost").getHostAddress(); Socket socket = new Socket(hostAddress, getServer().getPort()); OutputStream stream = socket.getOutputStream(); String shutdown = getServer().getShutdown(); for (int i = 0; i < shutdown.length(); i++) stream.write(shutdown.charAt(i)); stream.flush(); stream.close(); socket.close(); } else { log.error(sm.getString("catalina.stopServer")); System.exit(1); } } catch (IOException e) { log.error("Catalina.stop: ", e); System.exit(1); } }
  protected void usage() { System.out.println ("usage: java org.apache.catalina.startup.Catalina" + " [ -config {pathname} ]" + " [ -nonaming ] " + " { -help | start | stop }"); } Print usage information for this application.