Tomcat 10.1.19 · org.apache.catalina.core.StandardHost

Modifier and Type	Class and Description
private class	StandardHost.MemoryLeakTrackingListener Used to ensure the regardless of `Context` implementation, a record is kept of the class loader used every time a context starts.

Modifier and Type	Field and Description
private String[]	aliases The set of aliases for this Host.
private final Object	aliasesLock
private String	appBase The application root for this Host.
private volatile File	appBaseFile
private boolean	autoDeploy The auto deploy flag for this Host.
private final Map<ClassLoader, String>	childClassLoaders Track the class loaders for the child web applications so memory leaks can be detected.
private String	configClass The Java class name of the default context configuration class for deployed web applications.
private String	contextClass The Java class name of the default Context implementation class for deployed web applications.
private boolean	copyXML Should XML files be copied to $CATALINA_BASE/conf/<engine>/<host> by default when a web application is deployed?
private boolean	createDirs Should we create directories upon startup for appBase and xmlBase
private Pattern	deployIgnore Any file or directory in `appBase` that this pattern matches will be ignored by the automatic deployment process (both `deployOnStartup` and `autoDeploy`).
private boolean	deployOnStartup The deploy on startup flag for this Host.
private boolean	deployXML deploy Context XML config files property.
private String	errorReportValveClass The Java class name of the default error reporter implementation class for deployed web applications.
private boolean	failCtxIfServletStartFails
private volatile File	hostConfigBase host's default config path
private String	legacyAppBase The legacy (Java EE) application root for this Host.
private volatile File	legacyAppBaseFile
private static final Log	log Hides org.apache.catalina.core.ContainerBase.log.
private boolean	undeployOldVersions
private boolean	unpackWARs Unpack WARs property.
private String	workDir Work Directory base for applications.
private String	xmlBase The XML root for this Host.

Access	Constructor and Description
public	StandardHost() Create a new StandardHost component with the default basic Valve.

Method Summary

Modifier and Type	Method and Description
public void	addAlias(String The alias to be added alias) Implements org.apache.catalina.Host.addAlias. Add an alias name that should be mapped to this same Host.
public void	addChild(Container Child container to be added child) Overrides org.apache.catalina.core.ContainerBase.addChild. Implements org.apache.catalina.Container.addChild. Add a child Container, only if the proposed child is an implementation of Context.
public String[]	Returns: the set of alias names for this Host. If none are defined, a zero length array is returned. findAliases() Implements org.apache.catalina.Host.findAliases.
public String[]	Returns: a list of possibly leaking contexts findReloadedContextMemoryLeaks() Attempt to identify the contexts that have a class loader memory leak.
public String[]	getAliases()
public String	getAppBase() Implements org.apache.catalina.Host.getAppBase.
public File	getAppBaseFile() Implements org.apache.catalina.Host.getAppBaseFile.
public boolean	Returns: the value of the auto deploy flag. If true, it indicates that this host's child webapps will be dynamically deployed. getAutoDeploy() Implements org.apache.catalina.Host.getAutoDeploy.
public File	getConfigBaseFile() Implements org.apache.catalina.Host.getConfigBaseFile. (
public String	Returns: the Java class name of the context configuration class for new web applications. getConfigClass() Implements org.apache.catalina.Host.getConfigClass.
public String	Returns: the Java class name of the Context implementation class for new web applications. getContextClass()
public boolean	Returns: `true` if the Host will attempt to create directories for appBase and xmlBase unless they already exist. getCreateDirs() Implements org.apache.catalina.Host.getCreateDirs. Returns `true` if the Host will attempt to create directories for appBase and xmlBase unless they already exist.
public String	Returns: the regular expression that defines the files and directories in the host's `getAppBase` that will be ignored by the automatic deployment process. getDeployIgnore() Implements org.apache.catalina.Host.getDeployIgnore.
public Pattern	Returns: the compiled regular expression that defines the files and directories in the host's `getAppBase` that will be ignored by the automatic deployment process. getDeployIgnorePattern() Implements org.apache.catalina.Host.getDeployIgnorePattern.
public boolean	Returns: the value of the deploy on startup flag. If `true`, it indicates that this host's child webapps should be discovered and automatically deployed at startup time. getDeployOnStartup() Implements org.apache.catalina.Host.getDeployOnStartup.
public String	Returns: the Java class name of the error report valve class for new web applications. getErrorReportValveClass()
public String	getLegacyAppBase() Implements org.apache.catalina.Host.getLegacyAppBase.
public File	getLegacyAppBaseFile() Implements org.apache.catalina.Host.getLegacyAppBaseFile.
public String	Returns: the canonical, fully qualified, name of the virtual host this Container represents. getName() Overrides org.apache.catalina.core.ContainerBase.getName. Implements org.apache.catalina.Container.getName. Return a name string (suitable for use by humans) that describes this Container.
protected String	getObjectNameKeyProperties() Implements abstract org.apache.catalina.util.LifecycleMBeanBase.getObjectNameKeyProperties. Allow sub-classes to specify the key properties component of the `ObjectName` that will be used to register this component.
public ExecutorService	getStartStopExecutor() Implements org.apache.catalina.Host.getStartStopExecutor.
public boolean	getUndeployOldVersions() Implements org.apache.catalina.Host.getUndeployOldVersions.
public String[]	Returns: the MBean Names of the Valves associated with this Host getValveNames()
public String	Returns: host work directory base. getWorkDir()
public String	getXmlBase() Implements org.apache.catalina.Host.getXmlBase. (
public boolean	Returns: the copy XML config file flag for this component. isCopyXML()
public boolean	Returns: `true` if XML context descriptors should be deployed. isDeployXML()
public boolean	Returns: `true` if a webapp start should fail if a Servlet startup fails isFailCtxIfServletStartFails()
public boolean	Returns: `true` if WARs should be unpacked on deployment. isUnpackWARs()
public void	removeAlias(String Alias name to be removed alias) Implements org.apache.catalina.Host.removeAlias. Remove the specified alias name from the aliases for this Host.
public void	setAppBase(String The new application root appBase) Implements org.apache.catalina.Host.setAppBase. Set the application root for this Host.
public void	setAutoDeploy(boolean The new auto deploy flag autoDeploy) Implements org.apache.catalina.Host.setAutoDeploy. Set the auto deploy flag value for this host.
public void	setConfigClass(String The new context configuration class configClass) Implements org.apache.catalina.Host.setConfigClass. Set the Java class name of the context configuration class for new web applications.
public void	setContextClass(String The new context implementation class contextClass) Set the Java class name of the Context implementation class for new web applications.
public void	setCopyXML(boolean The new copy XML flag copyXML) Set the copy XML config file flag for this component.
public void	setCreateDirs(boolean the new flag value createDirs) Implements org.apache.catalina.Host.setCreateDirs. Set to `true` if the Host should attempt to create directories for xmlBase and appBase upon startup
public void	setDeployIgnore(String the regexp deployIgnore) Implements org.apache.catalina.Host.setDeployIgnore. Set the regular expression that defines the files and directories in the host's `getAppBase` that will be ignored by the automatic deployment process.
public void	setDeployOnStartup(boolean The new deploy on startup flag deployOnStartup) Implements org.apache.catalina.Host.setDeployOnStartup. Set the deploy on startup flag value for this host.
public void	setDeployXML(boolean `true` if context descriptors should be deployed deployXML) Deploy XML Context config files flag mutator.
public void	setErrorReportValveClass(String The new error report valve class errorReportValveClass) Set the Java class name of the error report valve class for new web applications.
public void	setFailCtxIfServletStartFails(boolean `false` to ignore errors on Servlets which are stated when the web application starts failCtxIfServletStartFails) Change the behavior of Servlet startup errors on web application starts.
public void	setLegacyAppBase(String The new legacy application root legacyAppBase) Implements org.apache.catalina.Host.setLegacyAppBase. Set the legacy (Java EE) application root for this Host.
public void	setName(String Virtual host name name) Overrides org.apache.catalina.core.ContainerBase.setName. Implements org.apache.catalina.Container.setName. Set the canonical, fully qualified, name of the virtual host this Container represents.
public void	setUndeployOldVersions(boolean The new value for this flag undeployOldVersions) Implements org.apache.catalina.Host.setUndeployOldVersions. Set to `true` if the Host should automatically undeploy old versions of applications deployed using parallel deployment.
public void	setUnpackWARs(boolean `true` to unpack WARs on deployment unpackWARs) Unpack WARs flag mutator.
public void	setWorkDir(String the new base work folder for this host workDir) Set host work directory base.
public void	setXmlBase(String The new XML root xmlBase) Implements org.apache.catalina.Host.setXmlBase. (Set the Xml root for this Host.
protected void	startInternal() Overrides org.apache.catalina.core.ContainerBase.startInternal. Start this component and implement the requirements of `org.apache.catalina.util.LifecycleBase#startInternal()`.

aliases	back to summary
private String[] aliases The set of aliases for this Host.

aliasesLock	back to summary
private final Object aliasesLock

appBase	back to summary
private String appBase The application root for this Host.

appBaseFile	back to summary
private volatile File appBaseFile

autoDeploy	back to summary
private boolean autoDeploy The auto deploy flag for this Host.

childClassLoaders	back to summary
private final Map<ClassLoader, String> childClassLoaders Track the class loaders for the child web applications so memory leaks can be detected.

configClass	back to summary
private String configClass The Java class name of the default context configuration class for deployed web applications.

contextClass	back to summary
private String contextClass The Java class name of the default Context implementation class for deployed web applications.

copyXML	back to summary
private boolean copyXML Should XML files be copied to $CATALINA_BASE/conf/<engine>/<host> by default when a web application is deployed?

createDirs	back to summary
private boolean createDirs Should we create directories upon startup for appBase and xmlBase

deployIgnore	back to summary
private Pattern deployIgnore Any file or directory in `appBase` that this pattern matches will be ignored by the automatic deployment process (both `deployOnStartup` and `autoDeploy`).

deployOnStartup	back to summary
private boolean deployOnStartup The deploy on startup flag for this Host.

deployXML	back to summary
private boolean deployXML deploy Context XML config files property.

errorReportValveClass	back to summary
private String errorReportValveClass The Java class name of the default error reporter implementation class for deployed web applications.

failCtxIfServletStartFails	back to summary
private boolean failCtxIfServletStartFails

hostConfigBase	back to summary
private volatile File hostConfigBase host's default config path

legacyAppBase	back to summary
private String legacyAppBase The legacy (Java EE) application root for this Host.

legacyAppBaseFile	back to summary
private volatile File legacyAppBaseFile

log	back to summary
private static final Log log Hides org.apache.catalina.core.ContainerBase.log.

undeployOldVersions	back to summary
private boolean undeployOldVersions

unpackWARs	back to summary
private boolean unpackWARs Unpack WARs property.

workDir	back to summary
private String workDir Work Directory base for applications.

xmlBase	back to summary
private String xmlBase The XML root for this Host.

StandardHost	back to summary
public StandardHost() Create a new StandardHost component with the default basic Valve.

Method Detail

addAlias	back to summary
public void addAlias(String alias) Implements org.apache.catalina.Host.addAlias. Add an alias name that should be mapped to this same Host. Parameters alias:String The alias to be added Annotations @Override

addAlias

back to summary

public void addAlias(String alias)

Implements org.apache.catalina.Host.addAlias.

Add an alias name that should be mapped to this same Host.

Parameters

alias:String: The alias to be added

Annotations

@Override

addChild	back to summary
public void addChild(Container child) Overrides org.apache.catalina.core.ContainerBase.addChild. Implements org.apache.catalina.Container.addChild. Add a child Container, only if the proposed child is an implementation of Context. Parameters child:Container Child container to be added Annotations @Override

addChild

back to summary

public void addChild(Container child)

Overrides org.apache.catalina.core.ContainerBase.addChild.

Implements org.apache.catalina.Container.addChild.

Add a child Container, only if the proposed child is an implementation of Context.

Parameters

child:Container: Child container to be added

Annotations

@Override

findAliases	back to summary
public String[] findAliases() Implements org.apache.catalina.Host.findAliases. Returns:String[] the set of alias names for this Host. If none are defined, a zero length array is returned. Annotations @Override

findAliases

back to summary

public String[] findAliases()

Implements org.apache.catalina.Host.findAliases.

Returns:String[]

the set of alias names for this Host. If none are defined, a zero length array is returned.

Annotations

@Override

findReloadedContextMemoryLeaks	back to summary
public String[] findReloadedContextMemoryLeaks() Attempt to identify the contexts that have a class loader memory leak. This is usually triggered on context reload. Note This method attempts to force a full garbage collection. This should be used with extreme caution on a production system. Returns:String[] a list of possibly leaking contexts

findReloadedContextMemoryLeaks

back to summary

public String[] findReloadedContextMemoryLeaks()

Attempt to identify the contexts that have a class loader memory leak. This is usually triggered on context reload.

Note

This method attempts to force a full garbage collection. This should be used with extreme caution on a production system.

Returns:String[]: a list of possibly leaking contexts

getAliases	back to summary
public String[] getAliases()

getAppBase	back to summary
public String getAppBase() Implements org.apache.catalina.Host.getAppBase. Returns:String Doc from org.apache.catalina.Host.getAppBase. the application root for this Host. This can be an absolute pathname, a relative pathname, or a URL. Annotations @Override

getAppBase

back to summary

public String getAppBase()

Implements org.apache.catalina.Host.getAppBase.

Returns:String

Doc from org.apache.catalina.Host.getAppBase.

the application root for this Host. This can be an absolute pathname, a relative pathname, or a URL.

Annotations

@Override

getAppBaseFile back to summary

getAppBaseFile	back to summary
public File getAppBaseFile() Implements org.apache.catalina.Host.getAppBaseFile. Returns:File Doc from org.apache.catalina.Host.getAppBaseFile. an absolute `File` for the appBase of this Host. The file will be canonical if possible. There is no guarantee that that the appBase exists. Annotations @Override

public File getAppBaseFile()

Implements org.apache.catalina.Host.getAppBaseFile.

Returns:File

Doc from org.apache.catalina.Host.getAppBaseFile.

an absolute File for the appBase of this Host. The file will be canonical if possible. There is no guarantee that that the appBase exists.

Annotations

@Override

getAutoDeploy	back to summary
public boolean getAutoDeploy() Implements org.apache.catalina.Host.getAutoDeploy. Returns:boolean the value of the auto deploy flag. If true, it indicates that this host's child webapps will be dynamically deployed. Annotations @Override

getAutoDeploy

back to summary

public boolean getAutoDeploy()

Implements org.apache.catalina.Host.getAutoDeploy.

Returns:boolean

the value of the auto deploy flag. If true, it indicates that this host's child webapps will be dynamically deployed.

Annotations

@Override

getConfigBaseFile	back to summary
public File getConfigBaseFile() Implements org.apache.catalina.Host.getConfigBaseFile. ( Returns:File Doc from org.apache.catalina.Host.getConfigBaseFile. a default configuration path of this Host. The file will be canonical if possible. Annotations @Override

getConfigBaseFile

back to summary

public File getConfigBaseFile()

Implements org.apache.catalina.Host.getConfigBaseFile.

(

Returns:File

Doc from org.apache.catalina.Host.getConfigBaseFile.

a default configuration path of this Host. The file will be canonical if possible.

Annotations

@Override

getConfigClass	back to summary
public String getConfigClass() Implements org.apache.catalina.Host.getConfigClass. Returns:String the Java class name of the context configuration class for new web applications. Annotations @Override

getConfigClass

back to summary

public String getConfigClass()

Implements org.apache.catalina.Host.getConfigClass.

Returns:String

the Java class name of the context configuration class for new web applications.

Annotations

@Override

getContextClass	back to summary
public String getContextClass() Returns:String the Java class name of the Context implementation class for new web applications.

getCreateDirs back to summary

getCreateDirs	back to summary
public boolean getCreateDirs() Implements org.apache.catalina.Host.getCreateDirs. Doc from org.apache.catalina.Host.getCreateDirs. Returns `true` if the Host will attempt to create directories for appBase and xmlBase unless they already exist. Returns:boolean `true` if the Host will attempt to create directories for appBase and xmlBase unless they already exist. Annotations @Override

public boolean getCreateDirs()

Implements org.apache.catalina.Host.getCreateDirs.

Doc from org.apache.catalina.Host.getCreateDirs.

Returns true if the Host will attempt to create directories for appBase and xmlBase unless they already exist.

Returns:boolean

true if the Host will attempt to create directories for appBase and xmlBase unless they already exist.

Annotations

@Override

getDeployIgnore back to summary

getDeployIgnore	back to summary
public String getDeployIgnore() Implements org.apache.catalina.Host.getDeployIgnore. Returns:String the regular expression that defines the files and directories in the host's `getAppBase` that will be ignored by the automatic deployment process. Annotations @Override

public String getDeployIgnore()

Implements org.apache.catalina.Host.getDeployIgnore.

Returns:String

the regular expression that defines the files and directories in the host's getAppBase that will be ignored by the automatic deployment process.

Annotations

@Override

getDeployIgnorePattern back to summary

getDeployIgnorePattern	back to summary
public Pattern getDeployIgnorePattern() Implements org.apache.catalina.Host.getDeployIgnorePattern. Returns:Pattern the compiled regular expression that defines the files and directories in the host's `getAppBase` that will be ignored by the automatic deployment process. Annotations @Override

public Pattern getDeployIgnorePattern()

Implements org.apache.catalina.Host.getDeployIgnorePattern.

Returns:Pattern

the compiled regular expression that defines the files and directories in the host's getAppBase that will be ignored by the automatic deployment process.

Annotations

@Override

getDeployOnStartup back to summary

getDeployOnStartup	back to summary
public boolean getDeployOnStartup() Implements org.apache.catalina.Host.getDeployOnStartup. Returns:boolean the value of the deploy on startup flag. If `true`, it indicates that this host's child webapps should be discovered and automatically deployed at startup time. Annotations @Override

public boolean getDeployOnStartup()

Implements org.apache.catalina.Host.getDeployOnStartup.

Returns:boolean

the value of the deploy on startup flag. If true, it indicates that this host's child webapps should be discovered and automatically deployed at startup time.

Annotations

@Override

getErrorReportValveClass	back to summary
public String getErrorReportValveClass() Returns:String the Java class name of the error report valve class for new web applications.

getLegacyAppBase	back to summary
public String getLegacyAppBase() Implements org.apache.catalina.Host.getLegacyAppBase. Returns:String Doc from org.apache.catalina.Host.getLegacyAppBase. the legacy (Java EE) application root for this Host. This can be an absolute pathname, a relative pathname, or a URL. Annotations @Override

getLegacyAppBase

back to summary

public String getLegacyAppBase()

Implements org.apache.catalina.Host.getLegacyAppBase.

Returns:String

Doc from org.apache.catalina.Host.getLegacyAppBase.

the legacy (Java EE) application root for this Host. This can be an absolute pathname, a relative pathname, or a URL.

Annotations

@Override

getLegacyAppBaseFile back to summary

getLegacyAppBaseFile	back to summary
public File getLegacyAppBaseFile() Implements org.apache.catalina.Host.getLegacyAppBaseFile. Returns:File Doc from org.apache.catalina.Host.getLegacyAppBaseFile. an absolute `File` for the legacy (Java EE) appBase of this Host. The file will be canonical if possible. There is no guarantee that that the appBase exists. Annotations @Override

public File getLegacyAppBaseFile()

Implements org.apache.catalina.Host.getLegacyAppBaseFile.

Returns:File

Doc from org.apache.catalina.Host.getLegacyAppBaseFile.

an absolute File for the legacy (Java EE) appBase of this Host. The file will be canonical if possible. There is no guarantee that that the appBase exists.

Annotations

@Override

getName	back to summary
public String getName() Overrides org.apache.catalina.core.ContainerBase.getName. Implements org.apache.catalina.Container.getName. Doc from org.apache.catalina.Container.getName. Return a name string (suitable for use by humans) that describes this Container. Within the set of child containers belonging to a particular parent, Container names must be unique. Returns:String the canonical, fully qualified, name of the virtual host this Container represents. Annotations @Override

getName

back to summary

public String getName()

Overrides org.apache.catalina.core.ContainerBase.getName.

Implements org.apache.catalina.Container.getName.

Doc from org.apache.catalina.Container.getName.

Return a name string (suitable for use by humans) that describes this Container. Within the set of child containers belonging to a particular parent, Container names must be unique.

Returns:String

the canonical, fully qualified, name of the virtual host this Container represents.

Annotations

@Override

getObjectNameKeyProperties back to summary

getObjectNameKeyProperties	back to summary
protected String getObjectNameKeyProperties() Implements abstract org.apache.catalina.util.LifecycleMBeanBase.getObjectNameKeyProperties. Doc from org.apache.catalina.util.LifecycleMBeanBase.getObjectNameKeyProperties. Allow sub-classes to specify the key properties component of the `ObjectName` that will be used to register this component. Returns:String The string representation of the key properties component of the desired `ObjectName` Annotations @Override

protected String getObjectNameKeyProperties()

Implements abstract org.apache.catalina.util.LifecycleMBeanBase.getObjectNameKeyProperties.

Doc from org.apache.catalina.util.LifecycleMBeanBase.getObjectNameKeyProperties.

Allow sub-classes to specify the key properties component of the ObjectName that will be used to register this component.

Returns:String

The string representation of the key properties component of the desired ObjectName

Annotations

@Override

getStartStopExecutor	back to summary
public ExecutorService getStartStopExecutor() Implements org.apache.catalina.Host.getStartStopExecutor. Returns:ExecutorService Doc from org.apache.catalina.Host.getStartStopExecutor. the executor that is used for starting and stopping contexts. This is primarily for use by components deploying contexts that want to do this in a multi-threaded manner. Annotations @Override

getStartStopExecutor

back to summary

public ExecutorService getStartStopExecutor()

Implements org.apache.catalina.Host.getStartStopExecutor.

Returns:ExecutorService

Doc from org.apache.catalina.Host.getStartStopExecutor.

the executor that is used for starting and stopping contexts. This is primarily for use by components deploying contexts that want to do this in a multi-threaded manner.

Annotations

@Override

getUndeployOldVersions back to summary

getUndeployOldVersions	back to summary
public boolean getUndeployOldVersions() Implements org.apache.catalina.Host.getUndeployOldVersions. Returns:boolean Doc from org.apache.catalina.Host.getUndeployOldVersions. `true` of the Host is configured to automatically undeploy old versions of applications deployed using parallel deployment. This only takes effect is `getAutoDeploy()` also returns `true`. Annotations @Override

public boolean getUndeployOldVersions()

Implements org.apache.catalina.Host.getUndeployOldVersions.

Returns:boolean

Doc from org.apache.catalina.Host.getUndeployOldVersions.

true of the Host is configured to automatically undeploy old versions of applications deployed using parallel deployment. This only takes effect is getAutoDeploy() also returns true.

Annotations

@Override

getValveNames	back to summary
public String[] getValveNames() throws Exception Returns:String[] the MBean Names of the Valves associated with this Host Exceptions Exception: if an MBean cannot be created or registered

getWorkDir	back to summary
public String getWorkDir() Returns:String host work directory base.

getXmlBase

back to summary

public String getXmlBase()

Implements org.apache.catalina.Host.getXmlBase.

(

Returns:String

Doc from org.apache.catalina.Host.getXmlBase.

the XML root for this Host. This can be an absolute pathname or a relative pathname. If null, the base path defaults to ${catalina.base}/conf/<engine name>/<host name> directory

Annotations

@Override

isCopyXML	back to summary
public boolean isCopyXML() Returns:boolean the copy XML config file flag for this component.

isDeployXML	back to summary
public boolean isDeployXML() Returns:boolean `true` if XML context descriptors should be deployed.

isFailCtxIfServletStartFails	back to summary
public boolean isFailCtxIfServletStartFails() Returns:boolean `true` if a webapp start should fail if a Servlet startup fails

isUnpackWARs	back to summary
public boolean isUnpackWARs() Returns:boolean `true` if WARs should be unpacked on deployment.

removeAlias

back to summary

public void removeAlias(String alias)

Implements org.apache.catalina.Host.removeAlias.

Remove the specified alias name from the aliases for this Host.

Parameters

alias:String: Alias name to be removed

Annotations

@Override

setAppBase

back to summary

public void setAppBase(String appBase)

Implements org.apache.catalina.Host.setAppBase.

Doc from org.apache.catalina.Host.setAppBase.

Set the application root for this Host. This can be an absolute pathname, a relative pathname, or a URL.

Parameters

appBase:String: The new application root

Annotations

@Override

setAutoDeploy

back to summary

public void setAutoDeploy(boolean autoDeploy)

Implements org.apache.catalina.Host.setAutoDeploy.

Set the auto deploy flag value for this host.

Parameters

autoDeploy:boolean: The new auto deploy flag

Annotations

@Override

setConfigClass

back to summary

public void setConfigClass(String configClass)

Implements org.apache.catalina.Host.setConfigClass.

Set the Java class name of the context configuration class for new web applications.

Parameters

configClass:String: The new context configuration class

Annotations

@Override

setContextClass

back to summary

public void setContextClass(String contextClass)

Set the Java class name of the Context implementation class for new web applications.

Parameters

contextClass:String: The new context implementation class

setCopyXML

back to summary

public void setCopyXML(boolean copyXML)

Set the copy XML config file flag for this component.

Parameters

copyXML:boolean: The new copy XML flag

setCreateDirs back to summary

public void setCreateDirs(boolean createDirs)

Implements org.apache.catalina.Host.setCreateDirs.

Set to true if the Host should attempt to create directories for xmlBase and appBase upon startup

Parameters

createDirs:boolean: the new flag value

Annotations

@Override

setDeployIgnore back to summary

public void setDeployIgnore(String deployIgnore)

Implements org.apache.catalina.Host.setDeployIgnore.

Set the regular expression that defines the files and directories in the host's getAppBase that will be ignored by the automatic deployment process.

Parameters

deployIgnore:String: the regexp

Annotations

@Override

setDeployOnStartup

back to summary

public void setDeployOnStartup(boolean deployOnStartup)

Implements org.apache.catalina.Host.setDeployOnStartup.

Set the deploy on startup flag value for this host.

Parameters

deployOnStartup:boolean: The new deploy on startup flag

Annotations

@Override

setDeployXML back to summary

public void setDeployXML(boolean deployXML)

Deploy XML Context config files flag mutator.

Parameters

deployXML:boolean: true if context descriptors should be deployed

setErrorReportValveClass

back to summary

public void setErrorReportValveClass(String errorReportValveClass)

Set the Java class name of the error report valve class for new web applications.

Parameters

errorReportValveClass:String: The new error report valve class

setFailCtxIfServletStartFails back to summary

public void setFailCtxIfServletStartFails(boolean failCtxIfServletStartFails)

Change the behavior of Servlet startup errors on web application starts.

Parameters

failCtxIfServletStartFails:boolean: false to ignore errors on Servlets which are stated when the web application starts

setLegacyAppBase

back to summary

public void setLegacyAppBase(String legacyAppBase)

Implements org.apache.catalina.Host.setLegacyAppBase.

Doc from org.apache.catalina.Host.setLegacyAppBase.

Set the legacy (Java EE) application root for this Host. This can be an absolute pathname, a relative pathname, or a URL.

Parameters

legacyAppBase:String: The new legacy application root

Annotations

@Override

setName

back to summary

public void setName(String name)

Overrides org.apache.catalina.core.ContainerBase.setName.

Implements org.apache.catalina.Container.setName.

Set the canonical, fully qualified, name of the virtual host this Container represents.

Parameters

name:String: Virtual host name

Annotations

@Override

Exceptions

IllegalArgumentException:: if name is null

setUndeployOldVersions back to summary

public void setUndeployOldVersions(boolean undeployOldVersions)

Implements org.apache.catalina.Host.setUndeployOldVersions.

Doc from org.apache.catalina.Host.setUndeployOldVersions.

Set to true if the Host should automatically undeploy old versions of applications deployed using parallel deployment. This only takes effect if getAutoDeploy() returns true.

Parameters

undeployOldVersions:boolean: The new value for this flag

Annotations

@Override

setUnpackWARs back to summary

public void setUnpackWARs(boolean unpackWARs)

Unpack WARs flag mutator.

Parameters

unpackWARs:boolean: true to unpack WARs on deployment

setWorkDir

back to summary

public void setWorkDir(String workDir)

Set host work directory base.

Parameters

workDir:String: the new base work folder for this host

setXmlBase

back to summary

public void setXmlBase(String xmlBase)

Implements org.apache.catalina.Host.setXmlBase.

Doc from org.apache.catalina.Host.setXmlBase.

(Set the Xml root for this Host. This can be an absolute pathname or a relative pathname. If null, the base path defaults to ${catalina.base}/conf/<engine name>/<host name> directory

Parameters

xmlBase:String: The new XML root

Annotations

@Override

startInternal back to summary

protected void startInternal() throws LifecycleException

Overrides org.apache.catalina.core.ContainerBase.startInternal.

Start this component and implement the requirements of org.apache.catalina.util.LifecycleBase#startInternal().

Annotations

@Override

Exceptions

LifecycleException:: if this component detects a fatal error that prevents this component from being used

public Class StandardHost

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class StandardHost.MemoryLeakTrackingListener

Constructor Summary

Method Summary

Constructor Detail

Method Detail