Class WebXml
- java.lang.Object
- 
- org.apache.tomcat.util.descriptor.web.XmlEncodingBase
- 
- org.apache.tomcat.util.descriptor.web.WebXml
 
 
- 
- All Implemented Interfaces:
- DocumentProperties.Charset
 
 public class WebXml extends XmlEncodingBase implements DocumentProperties.Charset Representation of common elements of web.xml and web-fragment.xml. Provides a repository for parsed data before the elements are merged. Validation is spread between multiple classes: The digester checks for structural correctness (eg single login-config) This class checks for invalid duplicates (eg filter/servlet names) StandardContext will check validity of values (eg URL formats etc)
- 
- 
Field SummaryFields Modifier and Type Field Description protected static java.lang.StringORDER_OTHERS
 - 
Constructor SummaryConstructors Constructor Description WebXml()
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidaddAbsoluteOrdering(java.lang.String fragmentName)voidaddAbsoluteOrderingOthers()voidaddAfterOrdering(java.lang.String fragmentName)voidaddAfterOrderingOthers()voidaddBeforeOrdering(java.lang.String fragmentName)voidaddBeforeOrderingOthers()voidaddContextParam(java.lang.String param, java.lang.String value)voidaddDuplicate(java.lang.String duplicate)voidaddEjbLocalRef(ContextLocalEjb ejbLocalRef)voidaddEjbRef(ContextEjb ejbRef)voidaddEnvEntry(ContextEnvironment envEntry)voidaddErrorPage(ErrorPage errorPage)voidaddFilter(FilterDef filter)voidaddFilterMapping(FilterMap filterMap)voidaddJspPropertyGroup(JspPropertyGroup propertyGroup)voidaddListener(java.lang.String className)voidaddLocaleEncodingMapping(java.lang.String locale, java.lang.String encoding)voidaddMessageDestination(MessageDestination messageDestination)voidaddMessageDestinationRef(MessageDestinationRef messageDestinationRef)voidaddMimeMapping(java.lang.String extension, java.lang.String mimeType)voidaddPostConstructMethods(java.lang.String clazz, java.lang.String method)voidaddPreDestroyMethods(java.lang.String clazz, java.lang.String method)voidaddResourceEnvRef(ContextResourceEnvRef resourceEnvRef)voidaddResourceRef(ContextResource resourceRef)voidaddSecurityConstraint(SecurityConstraint securityConstraint)voidaddSecurityRole(java.lang.String securityRole)voidaddServiceRef(ContextService serviceRef)voidaddServlet(ServletDef servletDef)voidaddServletMapping(java.lang.String urlPattern, java.lang.String servletName)voidaddServletMappingDecoded(java.lang.String urlPattern, java.lang.String servletName)voidaddTaglib(java.lang.String uri, java.lang.String location)voidaddWelcomeFile(java.lang.String welcomeFile)voidcreateAbsoluteOrdering()java.util.Set<java.lang.String>getAbsoluteOrdering()java.util.Set<java.lang.String>getAfterOrdering()java.util.Set<java.lang.String>getBeforeOrdering()java.util.Map<java.lang.String,java.lang.String>getContextParams()booleangetDelegate()booleangetDenyUncoveredHttpMethods()java.lang.StringgetDisplayName()java.util.List<java.lang.String>getDuplicates()java.util.Map<java.lang.String,ContextLocalEjb>getEjbLocalRefs()java.util.Map<java.lang.String,ContextEjb>getEjbRefs()java.util.Map<java.lang.String,ContextEnvironment>getEnvEntries()java.util.Map<java.lang.String,ErrorPage>getErrorPages()java.util.Set<FilterMap>getFilterMappings()java.util.Map<java.lang.String,FilterDef>getFilters()java.lang.StringgetJarName()JspConfigDescriptorgetJspConfigDescriptor()java.util.Set<JspPropertyGroup>getJspPropertyGroups()java.util.Set<java.lang.String>getListeners()java.util.Map<java.lang.String,java.lang.String>getLocaleEncodingMappings()LoginConfiggetLoginConfig()intgetMajorVersion()java.util.Map<java.lang.String,MessageDestinationRef>getMessageDestinationRefs()java.util.Map<java.lang.String,MessageDestination>getMessageDestinations()java.util.Map<java.lang.String,java.lang.String>getMimeMappings()intgetMinorVersion()java.lang.StringgetName()java.util.Map<java.lang.String,java.lang.String>getPostConstructMethods()java.util.Map<java.lang.String,java.lang.String>getPreDestroyMethods()java.lang.StringgetPublicId()java.lang.StringgetRequestCharacterEncoding()java.util.Map<java.lang.String,ContextResourceEnvRef>getResourceEnvRefs()java.util.Map<java.lang.String,ContextResource>getResourceRefs()java.lang.StringgetResponseCharacterEncoding()java.util.Set<SecurityConstraint>getSecurityConstraints()java.util.Set<java.lang.String>getSecurityRoles()java.util.Map<java.lang.String,ContextService>getServiceRefs()java.util.Map<java.lang.String,java.lang.String>getServletMappings()java.util.Map<java.lang.String,ServletDef>getServlets()SessionConfiggetSessionConfig()java.util.Map<java.lang.String,java.lang.String>getTaglibs()java.net.URLgetURL()java.lang.StringgetVersion()booleangetWebappJar()java.util.Set<java.lang.String>getWelcomeFiles()booleanisDistributable()booleanisDuplicated()booleanisMetadataComplete()booleanisOverridable()booleanmerge(java.util.Set<WebXml> fragments)Merge the supplied web fragments into this main web.xml.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.voidsetAlwaysAddWelcomeFiles(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.voidsetDelegate(boolean delegate)voidsetDenyUncoveredHttpMethods(boolean denyUncoveredHttpMethods)voidsetDisplayName(java.lang.String displayName)voidsetDistributable(boolean distributable)voidsetDuplicated(boolean duplicated)Deprecated.voidsetJarName(java.lang.String jarName)voidsetLoginConfig(LoginConfig loginConfig)voidsetMetadataComplete(boolean metadataComplete)voidsetName(java.lang.String name)voidsetOverridable(boolean overridable)voidsetPublicId(java.lang.String publicId)voidsetReplaceWelcomeFiles(boolean replaceWelcomeFiles)When merging/parsing web.xml files into this web.xml should the current set be completely replaced?voidsetRequestCharacterEncoding(java.lang.String requestCharacterEncoding)voidsetResponseCharacterEncoding(java.lang.String responseCharacterEncoding)voidsetSessionConfig(SessionConfig sessionConfig)voidsetURL(java.net.URL url)voidsetVersion(java.lang.String version)Set the version for this web.xml filevoidsetWebappJar(boolean webappJar)java.lang.StringtoString()java.lang.StringtoXml()Generate a web.xml in String form that matches the representation stored in this object.- 
Methods inherited from class org.apache.tomcat.util.descriptor.web.XmlEncodingBasegetCharset, setCharset
 - 
Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 - 
Methods inherited from interface org.apache.tomcat.util.digester.DocumentProperties.CharsetsetCharset
 
- 
 
- 
- 
- 
Field Detail- 
ORDER_OTHERSprotected static final java.lang.String ORDER_OTHERS - See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
isOverridablepublic boolean isOverridable() 
 - 
setOverridablepublic void setOverridable(boolean overridable) 
 - 
isDuplicatedpublic boolean isDuplicated() 
 - 
setDuplicated@Deprecated public void setDuplicated(boolean duplicated) Deprecated.
 - 
addDuplicatepublic void addDuplicate(java.lang.String duplicate) 
 - 
getDuplicatespublic java.util.List<java.lang.String> getDuplicates() 
 - 
createAbsoluteOrderingpublic void createAbsoluteOrdering() 
 - 
addAbsoluteOrderingpublic void addAbsoluteOrdering(java.lang.String fragmentName) 
 - 
addAbsoluteOrderingOtherspublic void addAbsoluteOrderingOthers() 
 - 
getAbsoluteOrderingpublic java.util.Set<java.lang.String> getAbsoluteOrdering() 
 - 
addAfterOrderingpublic void addAfterOrdering(java.lang.String fragmentName) 
 - 
addAfterOrderingOtherspublic void addAfterOrderingOthers() 
 - 
getAfterOrderingpublic java.util.Set<java.lang.String> getAfterOrdering() 
 - 
addBeforeOrderingpublic void addBeforeOrdering(java.lang.String fragmentName) 
 - 
addBeforeOrderingOtherspublic void addBeforeOrderingOthers() 
 - 
getBeforeOrderingpublic java.util.Set<java.lang.String> getBeforeOrdering() 
 - 
getVersionpublic java.lang.String getVersion() 
 - 
setVersionpublic void setVersion(java.lang.String version) Set the version for this web.xml file- Parameters:
- version- Values of- nullwill be ignored
 
 - 
getPublicIdpublic java.lang.String getPublicId() 
 - 
setPublicIdpublic void setPublicId(java.lang.String publicId) 
 - 
isMetadataCompletepublic boolean isMetadataComplete() 
 - 
setMetadataCompletepublic void setMetadataComplete(boolean metadataComplete) 
 - 
getNamepublic java.lang.String getName() 
 - 
setNamepublic void setName(java.lang.String name) 
 - 
getMajorVersionpublic int getMajorVersion() 
 - 
getMinorVersionpublic int getMinorVersion() 
 - 
getDisplayNamepublic java.lang.String getDisplayName() 
 - 
setDisplayNamepublic void setDisplayName(java.lang.String displayName) 
 - 
isDistributablepublic boolean isDistributable() 
 - 
setDistributablepublic void setDistributable(boolean distributable) 
 - 
getDenyUncoveredHttpMethodspublic boolean getDenyUncoveredHttpMethods() 
 - 
setDenyUncoveredHttpMethodspublic void setDenyUncoveredHttpMethods(boolean denyUncoveredHttpMethods) 
 - 
addContextParampublic void addContextParam(java.lang.String param, java.lang.String value)
 - 
getContextParamspublic java.util.Map<java.lang.String,java.lang.String> getContextParams() 
 - 
addFilterpublic void addFilter(FilterDef filter) 
 - 
getFilterspublic java.util.Map<java.lang.String,FilterDef> getFilters() 
 - 
addFilterMappingpublic void addFilterMapping(FilterMap filterMap) 
 - 
getFilterMappingspublic java.util.Set<FilterMap> getFilterMappings() 
 - 
addListenerpublic void addListener(java.lang.String className) 
 - 
getListenerspublic java.util.Set<java.lang.String> getListeners() 
 - 
addServletpublic void addServlet(ServletDef servletDef) 
 - 
getServletspublic java.util.Map<java.lang.String,ServletDef> getServlets() 
 - 
addServletMappingpublic void addServletMapping(java.lang.String urlPattern, java.lang.String servletName)
 - 
addServletMappingDecodedpublic void addServletMappingDecoded(java.lang.String urlPattern, java.lang.String servletName)
 - 
getServletMappingspublic java.util.Map<java.lang.String,java.lang.String> getServletMappings() 
 - 
setSessionConfigpublic void setSessionConfig(SessionConfig sessionConfig) 
 - 
getSessionConfigpublic SessionConfig getSessionConfig() 
 - 
addMimeMappingpublic void addMimeMapping(java.lang.String extension, java.lang.String mimeType)
 - 
getMimeMappingspublic java.util.Map<java.lang.String,java.lang.String> getMimeMappings() 
 - 
setReplaceWelcomeFilespublic void setReplaceWelcomeFiles(boolean replaceWelcomeFiles) When merging/parsing web.xml files into this web.xml should the current set be completely replaced?- Parameters:
- replaceWelcomeFiles-- trueto replace welcome files rather than add to the list
 
 - 
setAlwaysAddWelcomeFilespublic 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.- Parameters:
- alwaysAddWelcomeFiles-- trueto add welcome files
 
 - 
addWelcomeFilepublic void addWelcomeFile(java.lang.String welcomeFile) 
 - 
getWelcomeFilespublic java.util.Set<java.lang.String> getWelcomeFiles() 
 - 
addErrorPagepublic void addErrorPage(ErrorPage errorPage) 
 - 
getErrorPagespublic java.util.Map<java.lang.String,ErrorPage> getErrorPages() 
 - 
addTaglibpublic void addTaglib(java.lang.String uri, java.lang.String location)
 - 
getTaglibspublic java.util.Map<java.lang.String,java.lang.String> getTaglibs() 
 - 
addJspPropertyGrouppublic void addJspPropertyGroup(JspPropertyGroup propertyGroup) 
 - 
getJspPropertyGroupspublic java.util.Set<JspPropertyGroup> getJspPropertyGroups() 
 - 
addSecurityConstraintpublic void addSecurityConstraint(SecurityConstraint securityConstraint) 
 - 
getSecurityConstraintspublic java.util.Set<SecurityConstraint> getSecurityConstraints() 
 - 
setLoginConfigpublic void setLoginConfig(LoginConfig loginConfig) 
 - 
getLoginConfigpublic LoginConfig getLoginConfig() 
 - 
addSecurityRolepublic void addSecurityRole(java.lang.String securityRole) 
 - 
getSecurityRolespublic java.util.Set<java.lang.String> getSecurityRoles() 
 - 
addEnvEntrypublic void addEnvEntry(ContextEnvironment envEntry) 
 - 
getEnvEntriespublic java.util.Map<java.lang.String,ContextEnvironment> getEnvEntries() 
 - 
addEjbRefpublic void addEjbRef(ContextEjb ejbRef) 
 - 
getEjbRefspublic java.util.Map<java.lang.String,ContextEjb> getEjbRefs() 
 - 
addEjbLocalRefpublic void addEjbLocalRef(ContextLocalEjb ejbLocalRef) 
 - 
getEjbLocalRefspublic java.util.Map<java.lang.String,ContextLocalEjb> getEjbLocalRefs() 
 - 
addServiceRefpublic void addServiceRef(ContextService serviceRef) 
 - 
getServiceRefspublic java.util.Map<java.lang.String,ContextService> getServiceRefs() 
 - 
addResourceRefpublic void addResourceRef(ContextResource resourceRef) 
 - 
getResourceRefspublic java.util.Map<java.lang.String,ContextResource> getResourceRefs() 
 - 
addResourceEnvRefpublic void addResourceEnvRef(ContextResourceEnvRef resourceEnvRef) 
 - 
getResourceEnvRefspublic java.util.Map<java.lang.String,ContextResourceEnvRef> getResourceEnvRefs() 
 - 
addMessageDestinationRefpublic void addMessageDestinationRef(MessageDestinationRef messageDestinationRef) 
 - 
getMessageDestinationRefspublic java.util.Map<java.lang.String,MessageDestinationRef> getMessageDestinationRefs() 
 - 
addMessageDestinationpublic void addMessageDestination(MessageDestination messageDestination) 
 - 
getMessageDestinationspublic java.util.Map<java.lang.String,MessageDestination> getMessageDestinations() 
 - 
addLocaleEncodingMappingpublic void addLocaleEncodingMapping(java.lang.String locale, java.lang.String encoding)
 - 
getLocaleEncodingMappingspublic java.util.Map<java.lang.String,java.lang.String> getLocaleEncodingMappings() 
 - 
addPostConstructMethodspublic void addPostConstructMethods(java.lang.String clazz, java.lang.String method)
 - 
getPostConstructMethodspublic java.util.Map<java.lang.String,java.lang.String> getPostConstructMethods() 
 - 
addPreDestroyMethodspublic void addPreDestroyMethods(java.lang.String clazz, java.lang.String method)
 - 
getPreDestroyMethodspublic java.util.Map<java.lang.String,java.lang.String> getPreDestroyMethods() 
 - 
getJspConfigDescriptorpublic JspConfigDescriptor getJspConfigDescriptor() 
 - 
getRequestCharacterEncodingpublic java.lang.String getRequestCharacterEncoding() 
 - 
setRequestCharacterEncodingpublic void setRequestCharacterEncoding(java.lang.String requestCharacterEncoding) 
 - 
getResponseCharacterEncodingpublic java.lang.String getResponseCharacterEncoding() 
 - 
setResponseCharacterEncodingpublic void setResponseCharacterEncoding(java.lang.String responseCharacterEncoding) 
 - 
setURLpublic void setURL(java.net.URL url) 
 - 
getURLpublic java.net.URL getURL() 
 - 
setJarNamepublic void setJarName(java.lang.String jarName) 
 - 
getJarNamepublic java.lang.String getJarName() 
 - 
setWebappJarpublic void setWebappJar(boolean webappJar) 
 - 
getWebappJarpublic boolean getWebappJar() 
 - 
getDelegatepublic boolean getDelegate() 
 - 
setDelegatepublic void setDelegate(boolean delegate) 
 - 
toStringpublic java.lang.String toString() - Overrides:
- toStringin class- java.lang.Object
 
 - 
toXmlpublic 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
 
 - 
mergepublic 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:
- trueif merge is successful, else- false
 
 - 
orderWebFragmentspublic 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
 
 
- 
 
-