Modifier and Type	Class and Description
protected class	Catalina.CatalinaShutdownHook Shutdown hook which will perform a clean shutdown of Catalina if needed.
public static interface	Catalina.ServerXml
pack-priv class	Catalina.SetParentClassLoaderRule Rule that sets the parent class loader for the top object on the stack, which must be a `Container`.

Field Summary

Modifier and Type	Field and Description
protected boolean	await Use await.
protected String	configFile Pathname to the server configuration file.
protected boolean	generateCode Generate Tomcat embedded code from configuration files.
protected File	generatedCodeLocation Location of generated sources.
protected String	generatedCodeLocationParameter Value of the argument.
protected String	generatedCodePackage Top package name for generated source.
protected boolean	loaded Prevent duplicate loads.
private static final Log	log
protected ClassLoader	parentClassLoader The shared extensions class loader for this server.
protected Server	server The server component we are starting or stopping.
public static final String	SERVER_XML
protected Thread	shutdownHook Shutdown hook.
protected static final StringManager	sm The string manager for this package.
protected boolean	throwOnInitFailure Rethrow exceptions on init failure.
protected boolean	useGeneratedCode Use generated code as a replacement for configuration files.
protected boolean	useNaming Is naming enabled ?
protected boolean	useShutdownHook Use shutdown hook flag.

Constructor Summary

Access	Constructor and Description
public	Catalina()

Method Summary

Modifier and Type	Method and Description
private void	addClusterRuleSet(Digester digester, String prefix) Cluster support is optional.
protected boolean	Returns: `true` if we should continue processing arguments(String[] Command line arguments to process args) Process the specified command line arguments.
public void	await() Await and shutdown.
protected File	Returns: the main configuration file configFile() Return a File object representing our configuration file.
protected Digester	Returns: the main digester to parse server.xml createStartDigester() Create and configure the Digester we will be using for startup.
protected Digester	Returns: the digester to process the stop operation createStopDigester() Create and configure the Digester we will be using for shutdown.
protected void	generateClassFooter(Digester digester)
protected void	generateClassHeader(Digester digester, boolean start)
protected void	generateLoader()
public String	getConfigFile()
public boolean	getGenerateCode()
public File	getGeneratedCodeLocation()
public String	getGeneratedCodePackage()
public ClassLoader	getParentClassLoader()
public Server	getServer()
public boolean	Returns: `true` if an exception should be thrown if an error occurs during server init getThrowOnInitFailure()
public boolean	getUseGeneratedCode()
public boolean	getUseShutdownHook()
protected void	initNaming()
protected void	initStreams()
public boolean	isAwait()
public boolean	Returns: `true` if naming is enabled. isUseNaming()
public void	load() Start a new server instance.
public void	load(String[] args)
protected void	parseServerXml(boolean start)
public void	setAwait(boolean b)
public void	setConfigFile(String file)
public void	setGenerateCode(boolean generateCode)
public void	setGeneratedCodeLocation(File generatedCodeLocation)
public void	setGeneratedCodePackage(String generatedCodePackage)
public void	setParentClassLoader(ClassLoader The shared extensions class loader. parentClassLoader) Set the shared extensions class loader.
protected void	setSecurityProtection() Set the security package access/protection.
public void	setServer(Server server)
public void	setThrowOnInitFailure(boolean the new flag value throwOnInitFailure) Set the behavior regarding errors that could occur during server init.
public void	setUseGeneratedCode(boolean useGeneratedCode)
public void	setUseNaming(boolean The new use naming value useNaming) Enables or disables naming support.
public void	setUseShutdownHook(boolean useShutdownHook)
public void	start() Start a new server instance.
public void	stop() Stop an existing server instance.
public void	stopServer()
public void	stopServer(String[] arguments)
protected void	usage() Print usage information for this application.

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

Field Detail

await	back to summary
protected boolean await Use await.

configFile	back to summary
protected String configFile Pathname to the server configuration file.

generateCode	back to summary
protected boolean generateCode Generate Tomcat embedded code from configuration files.

generatedCodeLocation	back to summary
protected File generatedCodeLocation Location of generated sources.

generatedCodeLocationParameter	back to summary
protected String generatedCodeLocationParameter Value of the argument.

generatedCodePackage	back to summary
protected String generatedCodePackage Top package name for generated source.

loaded	back to summary
protected boolean loaded Prevent duplicate loads.

log	back to summary
private static final Log log

parentClassLoader	back to summary
protected ClassLoader parentClassLoader The shared extensions class loader for this server.

server	back to summary
protected Server server The server component we are starting or stopping.

SERVER_XML	back to summary
public static final String SERVER_XML

shutdownHook	back to summary
protected Thread shutdownHook Shutdown hook.

sm	back to summary
protected static final StringManager sm The string manager for this package.

throwOnInitFailure	back to summary
protected boolean throwOnInitFailure Rethrow exceptions on init failure.

useGeneratedCode	back to summary
protected boolean useGeneratedCode Use generated code as a replacement for configuration files.

useNaming	back to summary
protected boolean useNaming Is naming enabled ?

useShutdownHook	back to summary
protected boolean useShutdownHook Use shutdown hook flag.

Constructor Detail

Catalina	back to summary
public Catalina()

Method Detail

addClusterRuleSet	back to summary
private void addClusterRuleSet(Digester digester, String prefix) Cluster support is optional. The JARs may have been removed.

arguments back to summary

arguments	back to summary
protected boolean arguments(String[] args) Process the specified command line arguments. Parameters args:String[] Command line arguments to process Returns:boolean `true` if we should continue processing

protected boolean arguments(String[] args)

Process the specified command line arguments.

Parameters

args:String[]: Command line arguments to process

Returns:boolean

true if we should continue processing

await	back to summary
public void await() Await and shutdown.

configFile	back to summary
protected File configFile() Return a File object representing our configuration file. Returns:File the main configuration file

configFile

back to summary

protected File configFile()

Return a File object representing our configuration file.

Returns:File: the main configuration file

createStartDigester	back to summary
protected Digester createStartDigester() Create and configure the Digester we will be using for startup. Returns:Digester the main digester to parse server.xml

createStartDigester

back to summary

protected Digester createStartDigester()

Create and configure the Digester we will be using for startup.

Returns:Digester: the main digester to parse server.xml

createStopDigester	back to summary
protected Digester createStopDigester() Create and configure the Digester we will be using for shutdown. Returns:Digester the digester to process the stop operation

createStopDigester

back to summary

protected Digester createStopDigester()

Create and configure the Digester we will be using for shutdown.

Returns:Digester: the digester to process the stop operation

generateClassFooter	back to summary
protected void generateClassFooter(Digester digester)

generateClassHeader	back to summary
protected void generateClassHeader(Digester digester, boolean start)

generateLoader	back to summary
protected void generateLoader()

getConfigFile	back to summary
public String getConfigFile()

getGenerateCode	back to summary
public boolean getGenerateCode()

getGeneratedCodeLocation	back to summary
public File getGeneratedCodeLocation()

getGeneratedCodePackage	back to summary
public String getGeneratedCodePackage()

getParentClassLoader	back to summary
public ClassLoader getParentClassLoader()

getServer	back to summary
public Server getServer()

getThrowOnInitFailure	back to summary
public boolean getThrowOnInitFailure() Returns:boolean `true` if an exception should be thrown if an error occurs during server init

getUseGeneratedCode	back to summary
public boolean getUseGeneratedCode()

getUseShutdownHook	back to summary
public boolean getUseShutdownHook()

initNaming	back to summary
protected void initNaming()

initStreams	back to summary
protected void initStreams()

isAwait	back to summary
public boolean isAwait()

isUseNaming	back to summary
public boolean isUseNaming() Returns:boolean `true` if naming is enabled.

load	back to summary
public void load() Start a new server instance.

load	back to summary
public void load(String[] args)

parseServerXml	back to summary
protected void parseServerXml(boolean start)

setAwait	back to summary
public void setAwait(boolean b)

setConfigFile	back to summary
public void setConfigFile(String file)

setGenerateCode	back to summary
public void setGenerateCode(boolean generateCode)

setGeneratedCodeLocation	back to summary
public void setGeneratedCodeLocation(File generatedCodeLocation)

setGeneratedCodePackage	back to summary
public void setGeneratedCodePackage(String generatedCodePackage)

setParentClassLoader

back to summary

public void setParentClassLoader(ClassLoader parentClassLoader)

Set the shared extensions class loader.

Parameters

parentClassLoader:ClassLoader: The shared extensions class loader.

setSecurityProtection	back to summary
protected void setSecurityProtection() Set the security package access/protection.

setServer	back to summary
public void setServer(Server server)

setThrowOnInitFailure

back to summary

public void setThrowOnInitFailure(boolean throwOnInitFailure)

Set the behavior regarding errors that could occur during server init.

Parameters

throwOnInitFailure:boolean: the new flag value

setUseGeneratedCode	back to summary
public void setUseGeneratedCode(boolean useGeneratedCode)

setUseNaming

back to summary

public void setUseNaming(boolean useNaming)

Enables or disables naming support.

Parameters

useNaming:boolean: The new use naming value

setUseShutdownHook	back to summary
public void setUseShutdownHook(boolean useShutdownHook)

start	back to summary
public void start() Start a new server instance.

stop	back to summary
public void stop() Stop an existing server instance.

stopServer	back to summary
public void stopServer()

stopServer	back to summary
public void stopServer(String[] arguments)

usage	back to summary
protected void usage() Print usage information for this application.

org.apache.catalina.startup back to summary

protected Class Catalina.CatalinaShutdownHook

Class Inheritance

extends Thread

java.lang.Object
java.lang.Thread
org.apache.catalina.startup.Catalina.CatalinaShutdownHook

Shutdown hook which will perform a clean shutdown of Catalina if needed.

Field Summary

Inherited from java.lang.Thread:: MAX_PRIORITY MIN_PRIORITY NORM_PRIORITY

Constructor Summary

Access	Constructor and Description
protected	CatalinaShutdownHook()

Method Summary

Modifier and Type	Method and Description
public void	run() Overrides java.lang.Thread.run. Implements java.lang.Runnable.run. This method is run by the thread when it executes.

Constructor Detail

CatalinaShutdownHook	back to summary
protected CatalinaShutdownHook()

Method Detail

run back to summary

public void run()

Overrides java.lang.Thread.run.

Implements java.lang.Runnable.run.

Doc from java.lang.Thread.run.

This method is run by the thread when it executes. Subclasses of Thread may override this method.

This method is not intended to be invoked directly. If this thread is a platform thread created with a Runnable task then invoking this method will invoke the task's run method. If this thread is a virtual thread then invoking this method directly does nothing.

Annotations

@Override

org.apache.catalina.startup back to summary

public Interface Catalina.ServerXml

Method Summary

Modifier and Type	Method and Description
public void	load(Catalina catalina)

Method Detail

load	back to summary
public void load(Catalina catalina)

org.apache.catalina.startup back to summary

pack-priv final Class Catalina.SetParentClassLoaderRule

Class Inheritance

extends Rule

java.lang.Object
org.apache.tomcat.util.digester.Rule
org.apache.catalina.startup.Catalina.SetParentClassLoaderRule

Rule that sets the parent class loader for the top object on the stack, which must be a Container.

Field Summary

Modifier and Type	Field and Description
pack-priv ClassLoader	parentClassLoader

Inherited from org.apache.tomcat.util.digester.Rule:: digester namespaceURI sm

Constructor Summary

Access	Constructor and Description
pack-priv	SetParentClassLoaderRule(ClassLoader parentClassLoader)

Method Summary

Modifier and Type

Method and Description

public void

begin(String

the namespace URI of the matching element, or an empty string if the parser is not namespace aware or the element has no namespace

namespace, String

the local name if the parser is namespace aware, or just the element name otherwise

name, Attributes

The attribute list of this element

attributes)

Overrides org.apache.tomcat.util.digester.Rule.begin.

This method is called when the beginning of a matching XML element is encountered.

Inherited from org.apache.tomcat.util.digester.Rule:: body end finish getDigester getNamespaceURI setDigester setNamespaceURI

Field Detail

parentClassLoader	back to summary
pack-priv ClassLoader parentClassLoader

Constructor Detail

SetParentClassLoaderRule	back to summary
pack-priv SetParentClassLoaderRule(ClassLoader parentClassLoader)

Method Detail

begin

back to summary

public void begin(String namespace, String name, Attributes attributes) throws Exception

Overrides org.apache.tomcat.util.digester.Rule.begin.

Doc from org.apache.tomcat.util.digester.Rule.begin.

This method is called when the beginning of a matching XML element is encountered. The default implementation is a NO-OP.

Parameters

namespace:String: the namespace URI of the matching element, or an empty string if the parser is not namespace aware or the element has no namespace
name:String: the local name if the parser is namespace aware, or just the element name otherwise
attributes:Attributes: The attribute list of this element

Annotations

@Override

Exceptions

Exception:: if an error occurs while processing the event

public Class Catalina

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class Catalina.CatalinaShutdownHook

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public Interface Catalina.ServerXml

Method Summary

Method Detail

pack-priv final Class Catalina.SetParentClassLoaderRule

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail