Field Detail

• ORDER_OTHERS

  protected static final java.lang.String ORDER_OTHERS

  See Also:

  Constant Field Values

Constructor Detail

• WebXml

  public WebXml()

Method Detail

• isOverridable

  public boolean isOverridable()

• setOverridable

  public void setOverridable(boolean overridable)

• createAbsoluteOrdering

  public void createAbsoluteOrdering()

• addAbsoluteOrdering

  public void addAbsoluteOrdering(java.lang.String fragmentName)

• addAbsoluteOrderingOthers

  public void addAbsoluteOrderingOthers()

• getAbsoluteOrdering

  public java.util.Set<java.lang.String> getAbsoluteOrdering()

• addAfterOrdering

  public void addAfterOrdering(java.lang.String fragmentName)

• addAfterOrderingOthers

  public void addAfterOrderingOthers()

• getAfterOrdering

  public java.util.Set<java.lang.String> getAfterOrdering()

• addBeforeOrdering

  public void addBeforeOrdering(java.lang.String fragmentName)

• addBeforeOrderingOthers

  public void addBeforeOrderingOthers()

• getBeforeOrdering

  public java.util.Set<java.lang.String> getBeforeOrdering()

• getVersion

  public java.lang.String getVersion()

• setVersion

  public void setVersion(java.lang.String version)

  Set the version for this web.xml file

  Parameters:

  version - Values of null will be ignored

• getPublicId

  public java.lang.String getPublicId()

• setPublicId

  public void setPublicId(java.lang.String publicId)

• isMetadataComplete

  public boolean isMetadataComplete()

• setMetadataComplete

  public void setMetadataComplete(boolean metadataComplete)

• getName

  public java.lang.String getName()

• setName

  public void setName(java.lang.String name)

• getMajorVersion

  public int getMajorVersion()

• getMinorVersion

  public int getMinorVersion()

• getDisplayName

  public java.lang.String getDisplayName()

• setDisplayName

  public void setDisplayName(java.lang.String displayName)

• isDistributable

  public boolean isDistributable()

• setDistributable

  public void setDistributable(boolean distributable)

• addContextParam

  public void addContextParam(java.lang.String param,
                     java.lang.String value)

• getContextParams

  public java.util.Map<java.lang.String,java.lang.String> getContextParams()

• addFilter

  public void addFilter(FilterDef filter)

• getFilters

  public java.util.Map<java.lang.String,FilterDef> getFilters()

• addFilterMapping

  public void addFilterMapping(FilterMap filterMap)

• getFilterMappings

  public java.util.Set<FilterMap> getFilterMappings()

• addListener

  public void addListener(java.lang.String className)

• getListeners

  public java.util.Set<java.lang.String> getListeners()

• addServlet

  public void addServlet(ServletDef servletDef)

• getServlets

  public java.util.Map<java.lang.String,ServletDef> getServlets()

• addServletMapping

  public void addServletMapping(java.lang.String urlPattern,
                       java.lang.String servletName)

• getServletMappings

  public java.util.Map<java.lang.String,java.lang.String> getServletMappings()

• setSessionConfig

  public void setSessionConfig(SessionConfig sessionConfig)

• getSessionConfig

  public SessionConfig getSessionConfig()

• addMimeMapping

  public void addMimeMapping(java.lang.String extension,
                    java.lang.String mimeType)

• getMimeMappings

  public java.util.Map<java.lang.String,java.lang.String> getMimeMappings()

• setReplaceWelcomeFiles

  public void setReplaceWelcomeFiles(boolean replaceWelcomeFiles)

  When merging/parsing web.xml files into this web.xml should the current set be completely replaced?

• setAlwaysAddWelcomeFiles

  public void setAlwaysAddWelcomeFiles(boolean alwaysAddWelcomeFiles)

  When merging from this web.xml, should the welcome files be added to the target web.xml even if it already contains welcome file definitions.

• addWelcomeFile

  public void addWelcomeFile(java.lang.String welcomeFile)

• getWelcomeFiles

  public java.util.Set<java.lang.String> getWelcomeFiles()

• addErrorPage

  public void addErrorPage(ErrorPage errorPage)

• getErrorPages

  public java.util.Map<java.lang.String,ErrorPage> getErrorPages()

• addTaglib

  public void addTaglib(java.lang.String uri,
               java.lang.String location)

• getTaglibs

  public java.util.Map<java.lang.String,java.lang.String> getTaglibs()

• addJspPropertyGroup

  public void addJspPropertyGroup(JspPropertyGroup propertyGroup)

• getJspPropertyGroups

  public java.util.Set<JspPropertyGroup> getJspPropertyGroups()

• addSecurityConstraint

  public void addSecurityConstraint(SecurityConstraint securityConstraint)

• getSecurityConstraints

  public java.util.Set<SecurityConstraint> getSecurityConstraints()

• setLoginConfig

  public void setLoginConfig(LoginConfig loginConfig)

• getLoginConfig

  public LoginConfig getLoginConfig()

• addSecurityRole

  public void addSecurityRole(java.lang.String securityRole)

• getSecurityRoles

  public java.util.Set<java.lang.String> getSecurityRoles()

• addEnvEntry

  public void addEnvEntry(ContextEnvironment envEntry)

• getEnvEntries

  public java.util.Map<java.lang.String,ContextEnvironment> getEnvEntries()

• addEjbRef

  public void addEjbRef(ContextEjb ejbRef)

• getEjbRefs

  public java.util.Map<java.lang.String,ContextEjb> getEjbRefs()

• addEjbLocalRef

  public void addEjbLocalRef(ContextLocalEjb ejbLocalRef)

• getEjbLocalRefs

  public java.util.Map<java.lang.String,ContextLocalEjb> getEjbLocalRefs()

• addServiceRef

  public void addServiceRef(ContextService serviceRef)

• getServiceRefs

  public java.util.Map<java.lang.String,ContextService> getServiceRefs()

• addResourceRef

  public void addResourceRef(ContextResource resourceRef)

• getResourceRefs

  public java.util.Map<java.lang.String,ContextResource> getResourceRefs()

• addResourceEnvRef

  public void addResourceEnvRef(ContextResourceEnvRef resourceEnvRef)

• getResourceEnvRefs

  public java.util.Map<java.lang.String,ContextResourceEnvRef> getResourceEnvRefs()

• addMessageDestinationRef

  public void addMessageDestinationRef(MessageDestinationRef messageDestinationRef)

• getMessageDestinationRefs

  public java.util.Map<java.lang.String,MessageDestinationRef> getMessageDestinationRefs()

• addMessageDestination

  public void addMessageDestination(MessageDestination messageDestination)

• getMessageDestinations

  public java.util.Map<java.lang.String,MessageDestination> getMessageDestinations()

• addLocaleEncodingMapping

  public void addLocaleEncodingMapping(java.lang.String locale,
                              java.lang.String encoding)

• getLocalEncodingMappings

  public java.util.Map<java.lang.String,java.lang.String> getLocalEncodingMappings()

• addPostConstructMethods

  public void addPostConstructMethods(java.lang.String clazz,
                             java.lang.String method)

• getPostConstructMethods

  public java.util.Map<java.lang.String,java.lang.String> getPostConstructMethods()

• addPreDestroyMethods

  public void addPreDestroyMethods(java.lang.String clazz,
                          java.lang.String method)

• getPreDestroyMethods

  public java.util.Map<java.lang.String,java.lang.String> getPreDestroyMethods()

• setURL

  public void setURL(java.net.URL url)

• getURL

  public java.net.URL getURL()

• setJarName

  public void setJarName(java.lang.String jarName)

• getJarName

  public java.lang.String getJarName()

• toString

  public java.lang.String toString()

  Overrides:

  toString in class java.lang.Object

• toXml

  public java.lang.String toXml()

  Generate a web.xml in String form that matches the representation stored in this object.

  Returns:

  The complete contents of web.xml as a String

• configureContext

  public void configureContext(Context context)

  Configure a Context using the stored web.xml representation.

  Parameters:

  context - The context to be configured

• merge

  public boolean merge(java.util.Set<WebXml> fragments)

  Merge the supplied web fragments into this main web.xml.

  Parameters:

  fragments - The fragments to merge in

  Returns:

  true if merge is successful, else false

• orderWebFragments

  public static java.util.Set<WebXml> orderWebFragments(WebXml application,
                                        java.util.Map<java.lang.String,WebXml> fragments,
                                        ServletContext servletContext)

  Generates the sub-set of the web-fragment.xml files to be processed in the order that the fragments must be processed as per the rules in the Servlet spec.

  Parameters:

  application - The application web.xml file

  fragments - The map of fragment names to web fragments

  servletContext - The servlet context the fragments are associated with

  Returns:

  Ordered list of web-fragment.xml files to process