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 java.util.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 java.util.Map<Host,org.apache.catalina.startup.ContextConfig.DefaultWebXmlCacheEntry> hostWebXmlCache

  Cache of default web.xml fragments per Host

• customAuthenticators

  protected java.util.Map<java.lang.String,Authenticator> customAuthenticators

  Custom mappings of login methods to authenticators

• context

  protected Context context

  The Context we are associated with.

• defaultWebXml

  protected java.lang.String defaultWebXml

  The default web application's deployment descriptor location.

• ok

  protected boolean ok

  Track any fatal errors during startup configuration processing.

• originalDocBase

  protected java.lang.String originalDocBase

  Original docBase.

• initializerClassMap

  protected final java.util.Map<ServletContainerInitializer,java.util.Set<java.lang.Class<?>>> initializerClassMap

  Map of ServletContainerInitializer to classes they expressed interest in.

• typeInitializerMap

  protected final java.util.Map<java.lang.Class<?>,java.util.Set<ServletContainerInitializer>> typeInitializerMap

  Map of Types to ServletContainerInitializer that are interested in those types.

• javaClassCache

  protected final java.util.Map<java.lang.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.

Constructor Detail

• ContextConfig

  public ContextConfig()

Method Detail

• getDefaultWebXml

  public java.lang.String getDefaultWebXml()

  Return the location of the default deployment descriptor

• setDefaultWebXml

  public void setDefaultWebXml(java.lang.String path)

  Set the location of the default deployment descriptor

  Parameters:

  path - Absolute/relative path to the default web.xml

• setCustomAuthenticators

  public void setCustomAuthenticators(java.util.Map<java.lang.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.

• createContextDigester

  protected Digester createContextDigester()

  Create (if necessary) and return a Digester configured to process the context configuration descriptor for an application.

• contextConfig

  protected void contextConfig(Digester digester)

  Process the default configuration file, if it exists.

• processContextConfig

  protected void processContextConfig(Digester digester,
                          java.net.URL contextXml)

  Process a context.xml.

• fixDocBase

  protected void fixDocBase()
                     throws java.io.IOException

  Adjust docBase.

  Throws:

  java.io.IOException

• 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).

• getHostConfigBase

  protected java.io.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.

• createWebXml

  protected WebXml createWebXml()

• processServletContainerInitializers

  protected void processServletContainerInitializers()

  Scan JARs for ServletContainerInitializer implementations.

• processResourceJARs

  protected void processResourceJARs(java.util.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.

• getGlobalWebXmlSource

  protected org.xml.sax.InputSource getGlobalWebXmlSource()

  Identify the default web.xml to be used and obtain an input source for it.

• getHostWebXmlSource

  protected org.xml.sax.InputSource getHostWebXmlSource()

  Identify the host web.xml to be used and obtain an input source for it.

• getContextWebXmlSource

  protected org.xml.sax.InputSource getContextWebXmlSource()

  Identify the application web.xml to be used and obtain an input source for it.

• getWebXmlSource

  protected org.xml.sax.InputSource getWebXmlSource(java.lang.String filename,
                                        java.lang.String path)

  Parameters:

  filename - Name of the file (possibly with one or more leading path segments) to read

  path - Location that filename is relative to

• processJarsForWebFragments

  protected java.util.Map<java.lang.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(java.util.Set<WebXml> fragments,
                        boolean handlesTypesOnly)

• processAnnotationsWebResource

  protected void processAnnotationsWebResource(WebResource webResource,
                                   WebXml fragment,
                                   boolean handlesTypesOnly)

• processAnnotationsUrl

  protected void processAnnotationsUrl(java.net.URL url,
                           WebXml fragment,
                           boolean handlesTypesOnly)

• processAnnotationsJar

  protected void processAnnotationsJar(java.net.URL url,
                           WebXml fragment,
                           boolean handlesTypesOnly)

• processAnnotationsFile

  protected void processAnnotationsFile(java.io.File file,
                            WebXml fragment,
                            boolean handlesTypesOnly)

• processAnnotationsStream

  protected void processAnnotationsStream(java.io.InputStream is,
                              WebXml fragment,
                              boolean handlesTypesOnly)
                                   throws ClassFormatException,
                                          java.io.IOException

  Throws:

  ClassFormatException

  java.io.IOException

• 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 -

• processAnnotationWebServlet

  protected void processAnnotationWebServlet(java.lang.String className,
                                 AnnotationEntry ae,
                                 WebXml fragment)

• processAnnotationWebFilter

  protected void processAnnotationWebFilter(java.lang.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 -

  ae -

  fragment -

• processAnnotationsStringArray

  protected java.lang.String[] processAnnotationsStringArray(ElementValue ev)

• processAnnotationWebInitParams

  protected java.util.Map<java.lang.String,java.lang.String> processAnnotationWebInitParams(ElementValue ev)