public class HostConfig extends Object implements LifecycleListener
| Modifier and Type | Class and Description | 
|---|---|
| protected static class  | HostConfig.DeployedApplicationThis class represents the state of a deployed application, as well as
 the monitored resources. | 
| Modifier and Type | Field and Description | 
|---|---|
| protected File | appBaseApp base. | 
| protected File | configBaseConfig base. | 
| protected String | configClassDeprecated. 
 Will be removed in Tomcat 8.0.x | 
| protected String | contextClassThe Java class name of the Context implementation we should use. | 
| protected boolean | copyXMLShould XML files be copied to
 $CATALINA_BASE/conf/<engine>/<host> by default when
 a web application is deployed? | 
| protected Map<String,HostConfig.DeployedApplication> | deployedMap of deployed applications. | 
| protected boolean | deployXMLShould we deploy XML Context config files packaged with WAR files and
 directories? | 
| protected Digester | digesterThe  Digesterinstance used to parse context descriptors. | 
| protected static long | FILE_MODIFICATION_RESOLUTION_MSThe resolution, in milliseconds, of file modification times. | 
| protected Host | hostThe Host we are associated with. | 
| protected Set<String> | invalidWarsThe list of Wars in the appBase to be ignored because they are invalid
 (e.g. contain /../ sequences). | 
| protected ObjectName | onameThe JMX ObjectName of this component. | 
| protected ArrayList<String> | servicedList of applications which are being serviced, and shouldn't be
 deployed/undeployed/redeployed at the moment. | 
| protected static StringManager | smThe string resources for this package. | 
| protected boolean | unpackWARsShould we unpack WAR files when auto-deploying applications in the
  appBasedirectory? | 
| Constructor and Description | 
|---|
| HostConfig() | 
| Modifier and Type | Method and Description | 
|---|---|
| protected void | addGlobalRedeployResources(HostConfig.DeployedApplication app) | 
| void | addServiced(String name)Add a serviced application to the list. | 
| protected void | addWatchedResources(HostConfig.DeployedApplication app,
                   String docBase,
                   Context context)Add watched resources to the specified Context. | 
| protected File | appBase()Return a File object representing the "application root" directory
 for our associated Host. | 
| void | beforeStart() | 
| protected void | check()Check status of all webapps. | 
| void | check(String name)Check status of a specific web application and reload, redeploy or deploy
 it as necessary. | 
| protected void | checkResources(HostConfig.DeployedApplication app)Deprecated. 
 Use  checkResources(DeployedApplication, boolean).
             Will be removed in Tomcat 9.0.x | 
| protected void | checkResources(HostConfig.DeployedApplication app,
              boolean skipFileModificationResolutionCheck)Check resources for redeployment and reloading. | 
| void | checkUndeploy()Check for old versions of applications using parallel deployment that are
 now unused (have no active sessions) and undeploy any that are found. | 
| protected File | configBase()Return a File object representing the "configuration root" directory
 for our associated Host. | 
| protected static Digester | createDigester(String contextClassName)Create the digester which will be used to parse context config files. | 
| protected void | deployApps()Deploy applications for any directories or WAR files that are found
 in our "application root" directory. | 
| protected void | deployApps(String name)Deploy applications for any directories or WAR files that are found
 in our "application root" directory. | 
| protected void | deployDescriptor(ContextName cn,
                File contextXml) | 
| protected void | deployDescriptors(File configBase,
                 String[] files)Deploy XML context descriptors. | 
| protected void | deployDirectories(File appBase,
                 String[] files)Deploy directories. | 
| protected void | deployDirectory(ContextName cn,
               File dir) | 
| protected boolean | deploymentExists(String contextName)Check if a webapp is already deployed in this host. | 
| protected void | deployWAR(ContextName cn,
         File war) | 
| protected void | deployWARs(File appBase,
          String[] files)Deploy WAR files. | 
| protected String[] | filterAppPaths(String[] unfilteredAppPaths)Filter the list of application file paths to remove those that match
 the regular expression defined by  Host.getDeployIgnore(). | 
| String | getConfigBaseName()Get the name of the configBase. | 
| String | getConfigClass()Deprecated. 
 Will be removed in Tomcat 8.0.x | 
| String | getContextClass()Return the Context implementation class name. | 
| long | getDeploymentTime(String name)Get the instant where an application was deployed. | 
| boolean | isCopyXML()Return the copy XML config file flag for this component. | 
| boolean | isDeployed(String name)Has the specified application been deployed? | 
| boolean | isDeployXML()Return the deploy XML config file flag for this component. | 
| boolean | isServiced(String name)Is application serviced ? | 
| boolean | isUnpackWARs()Return the unpack WARs flag. | 
| void | lifecycleEvent(LifecycleEvent event)Process the START event for an associated Host. | 
| void | manageApp(Context context)Add a new Context to be managed by us. | 
| void | removeServiced(String name)Removed a serviced application from the list. | 
| protected File | returnCanonicalPath(String path) | 
| void | setConfigClass(String configClass)Deprecated. 
 Will be removed in Tomcat 8.0.x | 
| void | setContextClass(String contextClass)Set the Context implementation class name. | 
| void | setCopyXML(boolean copyXML)Set the copy XML config file flag for this component. | 
| void | setDeployXML(boolean deployXML)Set the deploy XML config file flag for this component. | 
| void | setUnpackWARs(boolean unpackWARs)Set the unpack WARs flag. | 
| void | start()Process a "start" event for this Host. | 
| void | stop()Process a "stop" event for this Host. | 
| void | unmanageApp(String contextName)Remove a webapp from our control. | 
protected static final long FILE_MODIFICATION_RESOLUTION_MS
protected File appBase
protected File configBase
@Deprecated protected String configClass
protected String contextClass
protected Host host
protected ObjectName oname
protected static final StringManager sm
protected boolean deployXML
protected boolean copyXML
protected boolean unpackWARs
appBase directory?protected Map<String,HostConfig.DeployedApplication> deployed
protected ArrayList<String> serviced
protected Digester digester
Digester instance used to parse context descriptors.@Deprecated public String getConfigClass()
@Deprecated public void setConfigClass(String configClass)
configClass - The new Context configuration class name.public String getContextClass()
public void setContextClass(String contextClass)
contextClass - The new Context implementation class name.public boolean isDeployXML()
public void setDeployXML(boolean deployXML)
deployXML - The new deploy XML flagpublic boolean isCopyXML()
public void setCopyXML(boolean copyXML)
copyXML - The new copy XML flagpublic boolean isUnpackWARs()
public void setUnpackWARs(boolean unpackWARs)
unpackWARs - The new unpack WARs flagpublic void lifecycleEvent(LifecycleEvent event)
lifecycleEvent in interface LifecycleListenerevent - The lifecycle event that has occurredpublic void addServiced(String name)
public boolean isServiced(String name)
public void removeServiced(String name)
public long getDeploymentTime(String name)
public boolean isDeployed(String name)
true if the application has been deployed and
 false if the application has not been deployed or does not
 existprotected static Digester createDigester(String contextClassName)
protected File appBase()
protected File configBase()
public String getConfigBaseName()
protected void deployApps()
protected String[] filterAppPaths(String[] unfilteredAppPaths)
Host.getDeployIgnore().unfilteredAppPaths - The list of application paths to filterprotected void deployApps(String name)
protected void deployDescriptors(File configBase, String[] files)
protected void deployDescriptor(ContextName cn, File contextXml)
cn - contextXml - protected void deployWAR(ContextName cn, File war)
cn - war - protected void deployDirectories(File appBase, String[] files)
protected void deployDirectory(ContextName cn, File dir)
cn - dir - protected boolean deploymentExists(String contextName)
contextName - of the context which will be checkedprotected void addWatchedResources(HostConfig.DeployedApplication app, String docBase, Context context)
app - HostConfig deployed appdocBase - web app docBasecontext - web application contextprotected void addGlobalRedeployResources(HostConfig.DeployedApplication app)
@Deprecated protected void checkResources(HostConfig.DeployedApplication app)
checkResources(DeployedApplication, boolean).
             Will be removed in Tomcat 9.0.xprotected void checkResources(HostConfig.DeployedApplication app, boolean skipFileModificationResolutionCheck)
app - The web application to checkskipFileModificationResolutionCheck - When checking files for modification should the check that
              requires that any file modification must have occurred at
              least as long ago as the resolution of the file time stamp
              be skippedpublic void beforeStart()
public void start()
public void stop()
protected void check()
public void check(String name)
name - The name of the web application to checkpublic void checkUndeploy()
public void manageApp(Context context)
public void unmanageApp(String contextName)
Copyright © 2000-2020 Apache Software Foundation. All Rights Reserved.