Package org.apache.catalina.startup
Class Catalina
- java.lang.Object
-
- org.apache.catalina.startup.Catalina
-
public class Catalina extends Object
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.
- configtest - Try to test the config
- start - Start an instance of Catalina.
- stop - Stop the currently running instance of Catalina.
- Author:
- Craig R. McClanahan, Remy Maucherat
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected classCatalina.CatalinaShutdownHookShutdown hook which will perform a clean shutdown of Catalina if needed.static interfaceCatalina.ServerXml
-
Field Summary
Fields Modifier and Type Field Description protected booleanawaitUse await.protected StringconfigFilePathname to the server configuration file.protected booleangenerateCodeGenerate Tomcat embedded code from configuration files.protected FilegeneratedCodeLocationLocation of generated sources.protected StringgeneratedCodeLocationParameterValue of the argument.protected StringgeneratedCodePackageTop package name for generated source.protected booleanloadedPrevent duplicate loads.protected ClassLoaderparentClassLoaderThe shared extensions class loader for this server.protected ServerserverThe server component we are starting or stopping.static StringSERVER_XMLprotected ThreadshutdownHookShutdown hook.protected static StringManagersmThe string manager for this package.protected booleanthrowOnInitFailureRethrow exceptions on init failure.protected booleanuseGeneratedCodeUse generated code as a replacement for configuration files.protected booleanuseNamingIs naming enabled ?protected booleanuseShutdownHookUse shutdown hook flag.
-
Constructor Summary
Constructors Constructor Description Catalina()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected booleanarguments(String[] args)Process the specified command line arguments.voidawait()Await and shutdown.protected FileconfigFile()Return a File object representing our configuration file.protected DigestercreateStartDigester()Create and configure the Digester we will be using for startup.protected DigestercreateStopDigester()Create and configure the Digester we will be using for shutdown.protected voidgenerateClassFooter(Digester digester)protected voidgenerateClassHeader(Digester digester, boolean start)protected voidgenerateLoader()StringgetConfigFile()booleangetGenerateCode()FilegetGeneratedCodeLocation()StringgetGeneratedCodePackage()ClassLoadergetParentClassLoader()ServergetServer()booleangetThrowOnInitFailure()booleangetUseGeneratedCode()booleangetUseShutdownHook()protected voidinitNaming()protected voidinitStreams()booleanisAwait()booleanisUseNaming()voidload()Start a new server instance.voidload(String[] args)protected voidparseServerXml(boolean start)voidsetAwait(boolean b)voidsetConfigFile(String file)voidsetGenerateCode(boolean generateCode)voidsetGeneratedCodeLocation(File generatedCodeLocation)voidsetGeneratedCodePackage(String generatedCodePackage)voidsetParentClassLoader(ClassLoader parentClassLoader)Set the shared extensions class loader.protected voidsetSecurityProtection()Set the security package access/protection.voidsetServer(Server server)voidsetThrowOnInitFailure(boolean throwOnInitFailure)Set the behavior regarding errors that could occur during server init.voidsetUseGeneratedCode(boolean useGeneratedCode)voidsetUseNaming(boolean useNaming)Enables or disables naming support.voidsetUseShutdownHook(boolean useShutdownHook)voidstart()Start a new server instance.voidstop()Stop an existing server instance.voidstopServer()voidstopServer(String[] arguments)protected voidusage()Print usage information for this application.
-
-
-
Field Detail
-
sm
protected static final StringManager sm
The string manager for this package.
-
SERVER_XML
public static final String SERVER_XML
- See Also:
- Constant Field Values
-
await
protected boolean await
Use await.
-
configFile
protected String configFile
Pathname to the server configuration file.
-
parentClassLoader
protected ClassLoader parentClassLoader
The shared extensions class loader for this server.
-
server
protected Server server
The server component we are starting or stopping.
-
useShutdownHook
protected boolean useShutdownHook
Use shutdown hook flag.
-
shutdownHook
protected Thread shutdownHook
Shutdown hook.
-
useNaming
protected boolean useNaming
Is naming enabled ?
-
loaded
protected boolean loaded
Prevent duplicate loads.
-
throwOnInitFailure
protected boolean throwOnInitFailure
Rethrow exceptions on init failure.
-
generateCode
protected boolean generateCode
Generate Tomcat embedded code from configuration files.
-
generatedCodeLocation
protected File generatedCodeLocation
Location of generated sources.
-
generatedCodeLocationParameter
protected String generatedCodeLocationParameter
Value of the argument.
-
generatedCodePackage
protected String generatedCodePackage
Top package name for generated source.
-
useGeneratedCode
protected boolean useGeneratedCode
Use generated code as a replacement for configuration files.
-
-
Method Detail
-
setConfigFile
public void setConfigFile(String file)
-
getConfigFile
public String getConfigFile()
-
setUseShutdownHook
public void setUseShutdownHook(boolean useShutdownHook)
-
getUseShutdownHook
public boolean getUseShutdownHook()
-
getGenerateCode
public boolean getGenerateCode()
-
setGenerateCode
public void setGenerateCode(boolean generateCode)
-
getUseGeneratedCode
public boolean getUseGeneratedCode()
-
setUseGeneratedCode
public void setUseGeneratedCode(boolean useGeneratedCode)
-
getGeneratedCodeLocation
public File getGeneratedCodeLocation()
-
setGeneratedCodeLocation
public void setGeneratedCodeLocation(File generatedCodeLocation)
-
getGeneratedCodePackage
public String getGeneratedCodePackage()
-
setGeneratedCodePackage
public void setGeneratedCodePackage(String generatedCodePackage)
-
getThrowOnInitFailure
public boolean getThrowOnInitFailure()
- Returns:
trueif an exception should be thrown if an error occurs during server init
-
setThrowOnInitFailure
public void setThrowOnInitFailure(boolean throwOnInitFailure)
Set the behavior regarding errors that could occur during server init.- Parameters:
throwOnInitFailure- the new flag value
-
setParentClassLoader
public void setParentClassLoader(ClassLoader parentClassLoader)
Set the shared extensions class loader.- Parameters:
parentClassLoader- The shared extensions class loader.
-
getParentClassLoader
public ClassLoader getParentClassLoader()
-
setServer
public void setServer(Server server)
-
getServer
public Server getServer()
-
isUseNaming
public boolean isUseNaming()
- Returns:
trueif naming is enabled.
-
setUseNaming
public void setUseNaming(boolean useNaming)
Enables or disables naming support.- Parameters:
useNaming- The new use naming value
-
setAwait
public void setAwait(boolean b)
-
isAwait
public boolean isAwait()
-
arguments
protected boolean arguments(String[] args)
Process the specified command line arguments.- Parameters:
args- Command line arguments to process- Returns:
trueif we should continue processing
-
configFile
protected File configFile()
Return a File object representing our configuration file.- Returns:
- the main configuration file
-
createStartDigester
protected Digester createStartDigester()
Create and configure the Digester we will be using for startup.- Returns:
- the main digester to parse server.xml
-
createStopDigester
protected Digester createStopDigester()
Create and configure the Digester we will be using for shutdown.- Returns:
- the digester to process the stop operation
-
parseServerXml
protected void parseServerXml(boolean start)
-
stopServer
public void stopServer()
-
stopServer
public void stopServer(String[] arguments)
-
load
public void load()
Start a new server instance.
-
load
public void load(String[] args)
-
start
public void start()
Start a new server instance.
-
stop
public void stop()
Stop an existing server instance.
-
await
public void await()
Await and shutdown.
-
usage
protected void usage()
Print usage information for this application.
-
initStreams
protected void initStreams()
-
initNaming
protected void initNaming()
-
setSecurityProtection
protected void setSecurityProtection()
Set the security package access/protection.
-
generateLoader
protected void generateLoader()
-
generateClassHeader
protected void generateClassHeader(Digester digester, boolean start)
-
generateClassFooter
protected void generateClassFooter(Digester digester)
-
-