ContextConfig (Apache Tomcat 7.0.109 API Documentation)

java.lang.Object
- org.apache.catalina.startup.ContextConfig

All Implemented Interfaces:

LifecycleListener
```
public class ContextConfig
extends Object
implements LifecycleListener
```
Startup event listener for a Context that configures the properties of that Context, and the associated defined servlets.

Author:

Craig R. McClanahan, Jean-Francois Arcand

Field Summary

Fields
Modifier and Type	Field and Description
`protected static Properties`	`authenticators` The set of Authenticators that we know how to configure.
`protected Context`	`context` The Context we are associated with.
`protected Map<String,Authenticator>`	`customAuthenticators` Custom mappings of login methods to authenticators
`protected String`	`defaultContextXml` Deprecated. Unnecessary
`protected String`	`defaultWebXml` The default web application's deployment descriptor location.
`protected static long`	`deploymentCount` Deployment count.
`protected static LoginConfig`	`DUMMY_LOGIN_CONFIG`
`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 Map<Host,org.apache.catalina.startup.ContextConfig.DefaultWebXmlCacheEntry>`	`hostWebXmlCache` Cache of default web.xml fragments per Host
`protected Map<ServletContainerInitializer,Set<Class<?>>>`	`initializerClassMap` Map of ServletContainerInitializer to classes they expressed interest in.
`protected Map<String,org.apache.catalina.startup.ContextConfig.JavaClassCacheEntry>`	`javaClassCache` Cache of JavaClass objects (byte code) by fully qualified class name.
`protected boolean`	`ok` Track any fatal errors during startup configuration processing.
`protected String`	`originalDocBase` Original docBase.
`protected static StringManager`	`sm` The string resources for this package.
`protected Map<Class<?>,Set<ServletContainerInitializer>>`	`typeInitializerMap` Map of Types to ServletContainerInitializer that are interested in those types.
`protected Digester`	`webDigester` The `Digester` we will use to process web application deployment descriptor files.
`protected Digester`	`webFragmentDigester` The `Digester` we will use to process web fragment deployment descriptor files.
`protected WebRuleSet`	`webFragmentRuleSet`
`protected WebRuleSet`	`webRuleSet`

Constructor Summary

Constructors
Constructor and Description

ContextConfig()

Constructors
Constructor and Description
`ContextConfig()`

Method Summary

Methods
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 void`	`beforeStart()` Process a "before start" event for this Context.
`protected void`	`checkHandlesTypes(JavaClass javaClass)` 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`.
`protected void`	`configureStart()` Process a "contextConfig" event for this Context.
`protected void`	`configureStop()` Process a "stop" event for this Context.
`protected void`	`contextConfig(Digester digester)` Process the default configuration file, if it exists.
`protected Digester`	`createContextDigester()` Create (if necessary) and return a Digester configured to process the context configuration descriptor for an application.
`protected WebXml`	`createWebXml()`
`void`	`createWebXmlDigester(boolean namespaceAware, boolean validation)` Create and return a Digester configured to process the web application deployment descriptor (web.xml).
`protected void`	`destroy()` Process a "destroy" event for this Context.
`protected void`	`fixDocBase()` Adjust docBase.
`protected String`	`getBaseDir()`
`protected File`	`getConfigBase()` Deprecated. Unused - will be removed in 8.0.x
`protected InputSource`	`getContextWebXmlSource()` Identify the application web.xml to be used and obtain an input source for it.
`String`	`getDefaultContextXml()` Deprecated. Never changed from default
`String`	`getDefaultWebXml()` Obtain the location of the default deployment descriptor.
`protected InputSource`	`getGlobalWebXmlSource()` Identify the default web.xml to be used and obtain an input source for it.
`protected File`	`getHostConfigBase()`
`protected InputSource`	`getHostWebXmlSource()` Identify the host web.xml to be used and obtain an input source for it.
`protected InputSource`	`getWebXmlSource(String filename, String path)` Utility method to create an input source from the specified XML file.
`protected void`	`init()` Process a "init" event for this Context.
`void`	`lifecycleEvent(LifecycleEvent event)` Process events for an associated Context.
`protected void`	`parseWebXml(InputSource source, WebXml dest, boolean fragment)` Parses the given source and stores the parsed data in the given web.xml representation.
`protected void`	`processAnnotations(Set<WebXml> fragments, boolean handlesTypesOnly)`
`protected void`	`processAnnotationsFile(File file, WebXml fragment, boolean handlesTypesOnly)`
`protected void`	`processAnnotationsJar(URL url, WebXml fragment, boolean handlesTypesOnly)`
`protected void`	`processAnnotationsJndi(URL url, WebXml fragment, boolean handlesTypesOnly)`
`protected void`	`processAnnotationsStream(InputStream is, WebXml fragment, boolean handlesTypesOnly)`
`protected String[]`	`processAnnotationsStringArray(ElementValue ev)`
`protected void`	`processAnnotationsUrl(URL url, WebXml fragment, boolean handlesTypesOnly)`
`protected void`	`processAnnotationWebFilter(String className, AnnotationEntry ae, WebXml 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 digester, URL contextXml)` Process a context.xml.
`protected Map<String,WebXml>`	`processJarsForWebFragments(WebXml application)` Scan /WEB-INF/lib for JARs and for each one found add it and any /META-INF/web-fragment.xml to the resulting Map. web-fragment.xml files will be parsed before being added to the map.
`protected void`	`processResourceJARs(Set<WebXml> 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.
`void`	`setCustomAuthenticators(Map<String,Authenticator> customAuthenticators)` Sets custom mappings of login methods to authenticators.
`void`	`setDefaultContextXml(String path)` Deprecated. Unused
`void`	`setDefaultWebXml(String 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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - sm
```
protected static final StringManager sm
```
    The string resources for this package.
  - DUMMY_LOGIN_CONFIG
```
protected static final LoginConfig DUMMY_LOGIN_CONFIG
```
  - authenticators
```
protected static final Properties authenticators
```
    The set of Authenticators that we know how to configure. The key is the name of the implemented authentication method, and the value is the fully qualified Java class name of the corresponding Valve.
  - deploymentCount
```
protected static long deploymentCount
```
    Deployment count.
  - hostWebXmlCache
```
protected static final Map<Host,org.apache.catalina.startup.ContextConfig.DefaultWebXmlCacheEntry> hostWebXmlCache
```
    Cache of default web.xml fragments per Host
  - customAuthenticators
```
protected Map<String,Authenticator> customAuthenticators
```
    Custom mappings of login methods to authenticators
  - context
```
protected volatile Context context
```
    The Context we are associated with.
  - defaultContextXml
```
@Deprecated
protected String defaultContextXml
```
    Deprecated. Unnecessary
    
    The default web application's context file location.
  - defaultWebXml
```
protected String defaultWebXml
```
    The default web application's deployment descriptor location.
  - ok
```
protected boolean ok
```
    Track any fatal errors during startup configuration processing.
  - originalDocBase
```
protected String originalDocBase
```
    Original docBase.
  - initializerClassMap
```
protected final Map<ServletContainerInitializer,Set<Class<?>>> initializerClassMap
```
    Map of ServletContainerInitializer to classes they expressed interest in.
  - typeInitializerMap
```
protected final Map<Class<?>,Set<ServletContainerInitializer>> typeInitializerMap
```
    Map of Types to ServletContainerInitializer that are interested in those types.
  - javaClassCache
```
protected final Map<String,org.apache.catalina.startup.ContextConfig.JavaClassCacheEntry> javaClassCache
```
    Cache of JavaClass objects (byte code) by fully qualified class name. Only populated if it is necessary to scan the super types and interfaces as part of the processing for HandlesTypes.
  - handlesTypesAnnotations
```
protected boolean handlesTypesAnnotations
```
    Flag that indicates if at least one HandlesTypes entry is present that represents an annotation.
  - handlesTypesNonAnnotations
```
protected boolean handlesTypesNonAnnotations
```
    Flag that indicates if at least one HandlesTypes entry is present that represents a non-annotation.
  - webDigester
```
protected Digester webDigester
```
    The Digester we will use to process web application deployment descriptor files.
  - webRuleSet
```
protected WebRuleSet webRuleSet
```
  - webFragmentDigester
```
protected Digester webFragmentDigester
```
    The Digester we will use to process web fragment deployment descriptor files.
  - webFragmentRuleSet
```
protected WebRuleSet webFragmentRuleSet
```
- Constructor Detail
  - ContextConfig
```
public ContextConfig()
```
- Method Detail
  - getDefaultWebXml
```
public String getDefaultWebXml()
```
    Obtain the location of the default deployment descriptor.
    
    Returns:
    The path to the default web.xml. If not absolute, it is relative to CATALINA_BASE.
  - setDefaultWebXml
```
public void setDefaultWebXml(String path)
```
    Set the location of the default deployment descriptor.
    
    Parameters:
    path - The path to the default web.xml. If not absolute, it is relative to CATALINA_BASE.
  - getDefaultContextXml
```
@Deprecated
public String getDefaultContextXml()
```
    Deprecated. Never changed from default
    
    Return the location of the default context file
  - setDefaultContextXml
```
@Deprecated
public void setDefaultContextXml(String path)
```
    Deprecated. Unused
    
    Set the location of the default context file
    
    Parameters:
    path - Absolute/relative path to the default context.xml
  - setCustomAuthenticators
```
public void setCustomAuthenticators(Map<String,Authenticator> customAuthenticators)
```
    Sets custom mappings of login methods to authenticators.
    
    Parameters:
    customAuthenticators - Custom mappings of login methods to authenticators
  - lifecycleEvent
```
public void lifecycleEvent(LifecycleEvent event)
```
    Process events for an associated Context.
    
    Specified by:
    
    lifecycleEvent in interface LifecycleListener
    
    Parameters:
    event - The lifecycle event that has occurred
  - applicationAnnotationsConfig
```
protected void applicationAnnotationsConfig()
```
    Process the application classes annotations, if it exists.
  - authenticatorConfig
```
protected void authenticatorConfig()
```
    Set up an Authenticator automatically if required, and one has not already been configured.
  - createWebXmlDigester
```
public void createWebXmlDigester(boolean namespaceAware,
                        boolean validation)
```
    Create and return a Digester configured to process the web application deployment descriptor (web.xml).
  - createContextDigester
```
protected Digester createContextDigester()
```
    Create (if necessary) and return a Digester configured to process the context configuration descriptor for an application.
    
    Returns:
    the digester for context.xml files
  - getBaseDir
```
protected String getBaseDir()
```
  - contextConfig
```
protected void contextConfig(Digester digester)
```
    Process the default configuration file, if it exists.
  - processContextConfig
```
protected void processContextConfig(Digester digester,
                        URL contextXml)
```
    Process a context.xml.
    
    Parameters:
    digester - The digester that will be used for XML parsing
    contextXml - The URL to the context.xml configuration
  - fixDocBase
```
protected void fixDocBase()
                   throws IOException
```
    Adjust docBase.
    
    Throws:
    
    IOException - cannot access the context base path
  - antiLocking
```
protected void antiLocking()
```
  - init
```
protected void init()
```
    Process a "init" event for this Context.
  - beforeStart
```
protected void beforeStart()
```
    Process a "before start" event for this Context.
  - configureStart
```
protected void configureStart()
```
    Process a "contextConfig" event for this Context.
  - configureStop
```
protected void configureStop()
```
    Process a "stop" event for this Context.
  - destroy
```
protected void destroy()
```
    Process a "destroy" event for this Context.
  - validateSecurityRoles
```
protected void validateSecurityRoles()
```
    Validate the usage of security role names in the web application deployment descriptor. If any problems are found, issue warning messages (for backwards compatibility) and add the missing roles. (To make these problems fatal instead, simply set the ok instance variable to false as well).
  - getConfigBase
```
@Deprecated
protected File getConfigBase()
```
    Deprecated. Unused - will be removed in 8.0.x
    
    Get config base.
  - getHostConfigBase
```
protected File getHostConfigBase()
```
  - webConfig
```
protected void webConfig()
```
    Scan the web.xml files that apply to the web application and merge them using the rules defined in the spec. For the global web.xml files, where there is duplicate configuration, the most specific level wins. ie an application's web.xml takes precedence over the host level or global web.xml file.
  - processClasses
```
protected void processClasses(WebXml webXml,
                  Set<WebXml> orderedFragments)
```
  - createWebXml
```
protected WebXml createWebXml()
```
  - processServletContainerInitializers
```
protected void processServletContainerInitializers()
```
    Scan JARs for ServletContainerInitializer implementations.
  - processResourceJARs
```
protected void processResourceJARs(Set<WebXml> 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. If static resources are found, add them to the context. Resources are added in web-fragment.xml priority order.
    
    Parameters:
    fragments - The set of fragments that will be scanned for static resources
  - getGlobalWebXmlSource
```
protected InputSource getGlobalWebXmlSource()
```
    Identify the default web.xml to be used and obtain an input source for it.
    
    Returns:
    an input source to the default web.xml
  - getHostWebXmlSource
```
protected InputSource getHostWebXmlSource()
```
    Identify the host web.xml to be used and obtain an input source for it.
    
    Returns:
    an input source to the default per host web.xml
  - getContextWebXmlSource
```
protected InputSource getContextWebXmlSource()
```
    Identify the application web.xml to be used and obtain an input source for it.
    
    Returns:
    an input source to the context web.xml
  - getWebXmlSource
```
protected InputSource getWebXmlSource(String filename,
                          String path)
```
    Utility method to create an input source from the specified XML file.
    
    Parameters:
    filename - Name of the file (possibly with one or more leading path segments) to read
    path - Location that filename is relative to
    
    Returns:
    the input source
  - parseWebXml
```
protected void parseWebXml(InputSource source,
               WebXml dest,
               boolean fragment)
```
    Parses the given source and stores the parsed data in the given web.xml representation. The byte stream will be closed at the end of the parse operation.
    
    Parameters:
    source - Input source containing the XML data to be parsed
    dest - The object representation of common elements of web.xml and web-fragment.xml
    fragment - Specifies whether the source is web-fragment.xml or web.xml
  - processJarsForWebFragments
```
protected Map<String,WebXml> processJarsForWebFragments(WebXml application)
```
    Scan /WEB-INF/lib for JARs and for each one found add it and any /META-INF/web-fragment.xml to the resulting Map. web-fragment.xml files will be parsed before being added to the map. Every JAR will be added and null will be used if no web-fragment.xml was found. Any JARs known not contain fragments will be skipped.
    
    Returns:
    A map of JAR name to processed web fragment (if any)
  - processAnnotations
```
protected void processAnnotations(Set<WebXml> fragments,
                      boolean handlesTypesOnly)
```
  - processAnnotationsUrl
```
protected void processAnnotationsUrl(URL url,
                         WebXml fragment,
                         boolean handlesTypesOnly)
```
  - processAnnotationsJar
```
protected void processAnnotationsJar(URL url,
                         WebXml fragment,
                         boolean handlesTypesOnly)
```
  - processAnnotationsJndi
```
protected void processAnnotationsJndi(URL url,
                          WebXml fragment,
                          boolean handlesTypesOnly)
```
  - processAnnotationsFile
```
protected void processAnnotationsFile(File file,
                          WebXml fragment,
                          boolean handlesTypesOnly)
```
  - processAnnotationsStream
```
protected void processAnnotationsStream(InputStream is,
                            WebXml fragment,
                            boolean handlesTypesOnly)
                                 throws ClassFormatException,
                                        IOException
```
    Throws:
    
    ClassFormatException
    
    IOException
  - processClass
```
protected void processClass(WebXml fragment,
                JavaClass clazz)
```
  - checkHandlesTypes
```
protected void checkHandlesTypes(JavaClass javaClass)
```
    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.
    
    Parameters:
    javaClass - the class to check
  - processAnnotationWebServlet
```
protected void processAnnotationWebServlet(String className,
                               AnnotationEntry ae,
                               WebXml fragment)
```
  - processAnnotationWebFilter
```
protected void processAnnotationWebFilter(String className,
                              AnnotationEntry ae,
                              WebXml fragment)
```
    process filter annotation and merge with existing one! FIXME: refactoring method too long and has redundant subroutines with processAnnotationWebServlet!
    
    Parameters:
    className - The filter class name
    ae - The filter annotation
    fragment - The corresponding fragment
  - processAnnotationsStringArray
```
protected String[] processAnnotationsStringArray(ElementValue ev)
```
  - processAnnotationWebInitParams
```
protected Map<String,String> processAnnotationWebInitParams(ElementValue ev)
```

Class ContextConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sm

DUMMY_LOGIN_CONFIG

authenticators

deploymentCount

hostWebXmlCache

customAuthenticators

context

defaultContextXml

defaultWebXml

ok

originalDocBase

initializerClassMap

typeInitializerMap

javaClassCache

handlesTypesAnnotations

handlesTypesNonAnnotations

webDigester

webRuleSet

webFragmentDigester

webFragmentRuleSet

Constructor Detail

ContextConfig

Method Detail

getDefaultWebXml

setDefaultWebXml

getDefaultContextXml

setDefaultContextXml

setCustomAuthenticators

lifecycleEvent

applicationAnnotationsConfig

authenticatorConfig

createWebXmlDigester

createContextDigester

getBaseDir

contextConfig

processContextConfig

fixDocBase

antiLocking

init

beforeStart

configureStart

configureStop

destroy

validateSecurityRoles

getConfigBase

getHostConfigBase

webConfig

processClasses

createWebXml

processServletContainerInitializers

processResourceJARs

getGlobalWebXmlSource

getHostWebXmlSource

getContextWebXmlSource

getWebXmlSource

parseWebXml

processJarsForWebFragments

processAnnotations

processAnnotationsUrl

processAnnotationsJar

processAnnotationsJndi

processAnnotationsFile

processAnnotationsStream

processClass

checkHandlesTypes

processAnnotationWebServlet

processAnnotationWebFilter

processAnnotationsStringArray

processAnnotationWebInitParams