Tomcat 10.1.19 · org.apache.catalina.startup.ContextConfig

Modifier and Type	Class and Description
private class	ContextConfig.AnnotationScanTask Executable task to scan a segment for annotations.
public static interface	ContextConfig.ContextXml
private static class	ContextConfig.DefaultWebXmlCacheEntry
private static class	ContextConfig.HostWebXmlCacheCleaner
pack-priv static class	ContextConfig.JavaClassCacheEntry

Field Summary

Modifier and Type	Field and Description
private File	antiLockingDocBase Anti-locking docBase.
protected static final Properties	authenticators The set of Authenticators that we know how to configure.
protected volatile Context	context The Context we are associated with.
protected Map<String, Authenticator>	customAuthenticators Custom mappings of login methods to authenticators
protected String	defaultWebXml The default web application's deployment descriptor location.
protected static long	deploymentCount Deployment count.
protected static final LoginConfig	DUMMY_LOGIN_CONFIG
private static final Set<ServletContainerInitializer>	EMPTY_SCI_SET Set used as the value for `JavaClassCacheEntry.sciSet` when there are no SCIs associated with a class.
protected boolean	handlesTypesAnnotations Flag that indicates if at least one `HandlesTypes` entry is present that represents an annotation.
protected boolean	handlesTypesNonAnnotations Flag that indicates if at least one `HandlesTypes` entry is present that represents a non-annotation.
protected static final Map<Host, ContextConfig.DefaultWebXmlCacheEntry>	hostWebXmlCache Cache of default web.xml fragments per Host
protected final Map<ServletContainerInitializer, Set<Class<?>>>	initializerClassMap Map of ServletContainerInitializer to classes they expressed interest in.
private static final Log	log
protected boolean	ok Track any fatal errors during startup configuration processing.
protected String	originalDocBase Original docBase.
protected static final StringManager	sm The string resources for this package.
protected final Map<Class<?>, Set<ServletContainerInitializer>>	typeInitializerMap Map of Types to ServletContainerInitializer that are interested in those types.

Access	Constructor and Description
public	ContextConfig()

Method Summary

Modifier and Type	Method and Description
protected void	antiLocking()
protected void	applicationAnnotationsConfig() Process the application classes annotations, if it exists.
protected void	authenticatorConfig() Set up an Authenticator automatically if required, and one has not already been configured.
protected synchronized void	beforeStart() Process a "before start" event for this Context.
protected void	checkHandlesTypes(JavaClass the class to check javaClass, Map<String, ContextConfig.JavaClassCacheEntry> a class cache javaClassCache) For classes packaged with the web application, the class and each super class needs to be checked for a match with `HandlesTypes` or for an annotation that matches `HandlesTypes`.
private String	classHierarchyToString(String className, ContextConfig.JavaClassCacheEntry entry, Map<String, ContextConfig.JavaClassCacheEntry> javaClassCache)
private void	configureContext(WebXml webxml)
protected synchronized void	configureStart() Process a "contextConfig" event for this Context.
protected synchronized void	configureStop() Process a "stop" event for this Context.
protected void	contextConfig(Digester The digester that will be used for XML parsing digester) Process the default configuration file, if it exists.
private void	convertJsp(ServletDef servletDef, Map<String, String> jspInitParams)
private void	convertJsps(WebXml webXml)
protected Digester	Returns: the digester for context.xml files createContextDigester() Create (if necessary) and return a Digester configured to process the context configuration descriptor for an application.
protected WebXml	createWebXml()
protected synchronized void	destroy() Process a "destroy" event for this Context.
protected void	fixDocBase() Adjust docBase.
protected void	generateClassFooter(Digester digester)
protected void	generateClassHeader(Digester digester, String packageName, String resourceName)
private static String	getClassName(String internalForm)
public String	getConfigBasePath()
protected InputSource	Returns: an input source to the context web.xml getContextWebXmlSource() Identify the application web.xml to be used and obtain an input source for it.
protected File	getContextXmlJavaSource(String contextXmlPackageName, String contextXmlSimpleClassName)
protected static String	getContextXmlPackageName(String generatedCodePackage, Container container)
public String	Returns: The path to the default web.xml. If not absolute, it is relative to CATALINA_BASE. getDefaultWebXml() Obtain the location of the default deployment descriptor.
private WebXml	getDefaultWebXmlFragment(WebXmlParser webXmlParser)
protected boolean	getGenerateCode()
protected File	getGeneratedCodeLocation()
protected String	getGeneratedCodePackage()
protected InputSource	Returns: an input source to the default web.xml getGlobalWebXmlSource() Identify the default web.xml to be used and obtain an input source for it.
protected File	getHostConfigBase()
protected InputSource	Returns: an input source to the default per host web.xml getHostWebXmlSource() Identify the host web.xml to be used and obtain an input source for it.
private Set<ServletContainerInitializer>	getSCIsForClass(String className)
private Server	getServer()
private WebXml	getTomcatWebXmlFragment(WebXmlParser webXmlParser)
protected boolean	getUseGeneratedCode()
protected InputSource	Returns: the input source getWebXmlSource(String Name of the file (possibly with one or more leading path segments) to read filename, boolean true if processing a shared resource, false if processing a host based resource global) Utility method to create an input source from the specified XML file.
protected synchronized void	init() Process a "init" event for this Context.
public void	lifecycleEvent(LifecycleEvent The lifecycle event that has occurred event) Implements org.apache.catalina.LifecycleListener.lifecycleEvent. Process events for an associated Context.
private void	populateJavaClassCache(String className, JavaClass javaClass, Map<String, ContextConfig.JavaClassCacheEntry> javaClassCache)
private void	populateJavaClassCache(String className, Map<String, ContextConfig.JavaClassCacheEntry> javaClassCache)
private void	populateSCIsForCacheEntry(ContextConfig.JavaClassCacheEntry cacheEntry, Map<String, ContextConfig.JavaClassCacheEntry> javaClassCache)
protected void	processAnnotations(Set<WebXml> fragments, boolean handlesTypesOnly, Map<String, ContextConfig.JavaClassCacheEntry> javaClassCache)
protected void	processAnnotationsFile(File file, WebXml fragment, boolean handlesTypesOnly, Map<String, ContextConfig.JavaClassCacheEntry> javaClassCache)
protected void	processAnnotationsInParallel(Set<WebXml> Set of parallelizable scans fragments, boolean Important parameter for the underlying scan handlesTypesOnly, Map<String, ContextConfig.JavaClassCacheEntry> The class cache javaClassCache) Parallelized version of processAnnotationsInParallel().
protected void	processAnnotationsJar(URL url, WebXml fragment, boolean handlesTypesOnly, Map<String, ContextConfig.JavaClassCacheEntry> javaClassCache)
protected void	processAnnotationsStream(InputStream is, WebXml fragment, boolean handlesTypesOnly, Map<String, ContextConfig.JavaClassCacheEntry> javaClassCache)
protected String[]	processAnnotationsStringArray(ElementValue ev)
protected void	processAnnotationsUrl(URL url, WebXml fragment, boolean handlesTypesOnly, Map<String, ContextConfig.JavaClassCacheEntry> javaClassCache)
protected void	processAnnotationsWebResource(WebResource webResource, WebXml fragment, boolean handlesTypesOnly, Map<String, ContextConfig.JavaClassCacheEntry> javaClassCache)
protected void	processAnnotationWebFilter(String The filter class name className, AnnotationEntry The filter annotation ae, WebXml The corresponding fragment fragment) process filter annotation and merge with existing one!
protected Map<String, String>	processAnnotationWebInitParams(ElementValue ev)
protected void	processAnnotationWebServlet(String className, AnnotationEntry ae, WebXml fragment)
protected void	processClass(WebXml fragment, JavaClass clazz)
protected void	processClasses(WebXml webXml, Set<WebXml> orderedFragments)
protected void	processContextConfig(Digester The digester that will be used for XML parsing digester, URL The URL to the context.xml configuration contextXml, InputStream The XML resource stream stream) Process a context.xml.
protected Map<String, WebXml>	Returns: A map of JAR name to processed web fragment (if any) processJarsForWebFragments(WebXml The main web.xml metadata application, WebXmlParser The parser to use to process the web.xml file webXmlParser) Scan /WEB-INF/lib for JARs and for each one found add it and any /META-INF/web-fragment.xml to the resulting Map.
protected void	processResourceJARs(Set<WebXml> The set of fragments that will be scanned for static resources fragments) Scan JARs that contain web-fragment.xml files that will be used to configure this application to see if they also contain static resources.
protected void	processServletContainerInitializers() Scan JARs for ServletContainerInitializer implementations.
private void	scanWebXmlFragment(boolean handlesTypesOnly, WebXml fragment, Map<String, ContextConfig.JavaClassCacheEntry> javaClassCache)
public void	setCustomAuthenticators(Map<String, Authenticator> Custom mappings of login methods to authenticators customAuthenticators) Sets custom mappings of login methods to authenticators.
public void	setDefaultWebXml(String The path to the default web.xml. If not absolute, it is relative to CATALINA_BASE. path) Set the location of the default deployment descriptor.
protected void	validateSecurityRoles() Validate the usage of security role names in the web application deployment descriptor.
protected void	webConfig() Scan the web.xml files that apply to the web application and merge them using the rules defined in the spec.

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

public Class ContextConfig

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary