Tomcat 10.1.19 · org.apache.tomcat.util.descriptor.web.WebXml

Modifier and Type	Field and Description
private Set<String>	absoluteOrdering web.xml only elements Absolute Ordering
private final Set<String>	after web-fragment.xml only elements Relative ordering
private boolean	alwaysAddWelcomeFiles
private final Set<String>	before
private final Map<String, String>	contextParams
private boolean	delegate
private boolean	denyUncoveredHttpMethods
private String	displayName
private boolean	distributable
private final List<String>	duplicates
private final Map<String, ContextLocalEjb>	ejbLocalRefs
private final Map<String, ContextEjb>	ejbRefs
private final Map<String, ContextEnvironment>	envEntries
private final Map<String, ErrorPage>	errorPages
private final Set<String>	filterMappingNames
private final Set<FilterMap>	filterMaps
private final Map<String, FilterDef>	filters
private static final String	INDENT2
private static final String	INDENT4
private static final String	INDENT6
private String	jarName
private final Set<JspPropertyGroup>	jspPropertyGroups
private final Set<String>	listeners
private final Map<String, String>	localeEncodingMappings
private final Log	log
private LoginConfig	loginConfig
private int	majorVersion
private final Map<String, MessageDestinationRef>	messageDestinationRefs
private final Map<String, MessageDestination>	messageDestinations
private boolean	metadataComplete
private final Map<String, String>	mimeMappings
private int	minorVersion
private String	name
protected static final String	ORDER_OTHERS
private boolean	overridable Global defaults are overridable but Servlets and Servlet mappings need to be unique.
private Map<String, String>	postConstructMethods
private Map<String, String>	preDestroyMethods
private String	publicId
private boolean	replaceWelcomeFiles
private String	requestCharacterEncoding
private final Map<String, ContextResourceEnvRef>	resourceEnvRefs
private final Map<String, ContextResource>	resourceRefs
private String	responseCharacterEncoding
private final Set<SecurityConstraint>	securityConstraints
private final Set<String>	securityRoles
private final Map<String, ContextService>	serviceRefs
private final Set<String>	servletMappingNames
private final Map<String, String>	servletMappings
private final Map<String, ServletDef>	servlets
private SessionConfig	sessionConfig
private static final StringManager	sm
private final Map<String, String>	taglibs
private URL	uRL
private boolean	webappJar
private final Set<String>	welcomeFiles

Access	Constructor and Description
public	WebXml()

Method Summary

Modifier and Type	Method and Description
public void	addAbsoluteOrdering(String fragmentName)
public void	addAbsoluteOrderingOthers()
public void	addAfterOrdering(String fragmentName)
public void	addAfterOrderingOthers()
public void	addBeforeOrdering(String fragmentName)
public void	addBeforeOrderingOthers()
public void	addContextParam(String param, String value)
public void	addDuplicate(String duplicate)
public void	addEjbLocalRef(ContextLocalEjb ejbLocalRef)
public void	addEjbRef(ContextEjb ejbRef)
public void	addEnvEntry(ContextEnvironment envEntry)
public void	addErrorPage(ErrorPage errorPage)
public void	addFilter(FilterDef filter)
public void	addFilterMapping(FilterMap filterMap)
public void	addJspPropertyGroup(JspPropertyGroup propertyGroup)
public void	addListener(String className)
public void	addLocaleEncodingMapping(String locale, String encoding)
public void	addMessageDestination(MessageDestination messageDestination)
public void	addMessageDestinationRef(MessageDestinationRef messageDestinationRef)
public void	addMimeMapping(String extension, String mimeType)
public void	addPostConstructMethods(String clazz, String method)
public void	addPreDestroyMethods(String clazz, String method)
public void	addResourceEnvRef(ContextResourceEnvRef resourceEnvRef)
public void	addResourceRef(ContextResource resourceRef)
public void	addSecurityConstraint(SecurityConstraint securityConstraint)
public void	addSecurityRole(String securityRole)
public void	addServiceRef(ContextService serviceRef)
public void	addServlet(ServletDef servletDef)
public void	addServletMapping(String urlPattern, String servletName)
public void	addServletMappingDecoded(String urlPattern, String servletName)
public void	addTaglib(String uri, String location)
public void	addWelcomeFile(String welcomeFile)
private static void	appendElement(StringBuilder sb, String indent, String elementName, String value)
private static void	appendElement(StringBuilder sb, String indent, String elementName, Object value)
public void	createAbsoluteOrdering()
private static void	decoupleOtherGroups(Set<WebXml> group)
private String	encodeUrl(String input)
public Set<String>	getAbsoluteOrdering()
public Set<String>	getAfterOrdering()
public Set<String>	getBeforeOrdering()
public Map<String, String>	getContextParams()
public boolean	getDelegate()
public boolean	getDenyUncoveredHttpMethods()
public String	getDisplayName()
public List<String>	getDuplicates()
public Map<String, ContextLocalEjb>	getEjbLocalRefs()
public Map<String, ContextEjb>	getEjbRefs()
public Map<String, ContextEnvironment>	getEnvEntries()
public Map<String, ErrorPage>	getErrorPages()
public Set<FilterMap>	getFilterMappings()
public Map<String, FilterDef>	getFilters()
public String	getJarName()
public JspConfigDescriptor	getJspConfigDescriptor()
public Set<JspPropertyGroup>	getJspPropertyGroups()
public Set<String>	getListeners()
public Map<String, String>	getLocaleEncodingMappings()
public LoginConfig	getLoginConfig()
public int	getMajorVersion()
public Map<String, MessageDestinationRef>	getMessageDestinationRefs()
public Map<String, MessageDestination>	getMessageDestinations()
public Map<String, String>	getMimeMappings()
public int	getMinorVersion()
public String	getName()
public Map<String, String>	getPostConstructMethods()
public Map<String, String>	getPreDestroyMethods()
public String	getPublicId()
public String	getRequestCharacterEncoding()
public Map<String, ContextResourceEnvRef>	getResourceEnvRefs()
public Map<String, ContextResource>	getResourceRefs()
public String	getResponseCharacterEncoding()
public Set<SecurityConstraint>	getSecurityConstraints()
public Set<String>	getSecurityRoles()
public Map<String, ContextService>	getServiceRefs()
public Map<String, String>	getServletMappings()
public Map<String, ServletDef>	getServlets()
public SessionConfig	getSessionConfig()
public Map<String, String>	getTaglibs()
public URL	getURL()
public String	getVersion()
public boolean	getWebappJar()
public Set<String>	getWelcomeFiles()
public boolean	isDistributable()
public boolean	isDuplicated()
public boolean	isMetadataComplete()
public boolean	isOverridable()
private static void	makeAfterOthersExplicit(Set<String> afterOrdering, Map<String, WebXml> fragments)
private static void	makeBeforeOthersExplicit(Set<String> beforeOrdering, Map<String, WebXml> fragments)
public boolean	Returns: `true` if merge is successful, else `false` merge(Set<WebXml> The fragments to merge in fragments) Merge the supplied web fragments into this main web.xml.
private static boolean	mergeFilter(FilterDef src, FilterDef dest, boolean failOnConflict)
private boolean	mergeLifecycleCallback(Map<String, String> fragmentMap, Map<String, String> tempMap, WebXml fragment, String mapName)
private <T> boolean	mergeMap(Map<String, T> fragmentMap, Map<String, T> mainMap, Map<String, T> tempMap, WebXml fragment, String mapName)
private static boolean	mergeMultipartDef(MultipartDef src, MultipartDef dest, boolean failOnConflict)
private <T extends ResourceBase> boolean	mergeResourceMap(Map<String, T> fragmentResources, Map<String, T> mainResources, Map<String, T> tempResources, WebXml fragment)
private static boolean	mergeServlet(ServletDef src, ServletDef dest, boolean failOnConflict)
private static void	orderFragments(Set<WebXml> orderedFragments, Set<WebXml> unordered)
public static Set<WebXml>	Returns: Ordered list of web-fragment.xml files to process orderWebFragments(WebXml The application web.xml file application, Map<String, WebXml> The map of fragment names to web fragments fragments, ServletContext The servlet context the fragments are associated with 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.
private Set<WebXml>	orderWebFragments(Map<String, WebXml> fragments, ServletContext servletContext)
public void	setAlwaysAddWelcomeFiles(boolean `true` to add welcome files 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.
public void	setDelegate(boolean delegate)
public void	setDenyUncoveredHttpMethods(boolean denyUncoveredHttpMethods)
public void	setDisplayName(String displayName)
public void	setDistributable(boolean distributable)
public void	setJarName(String jarName)
public void	setLoginConfig(LoginConfig loginConfig)
public void	setMetadataComplete(boolean metadataComplete)
public void	setName(String name)
public void	setOverridable(boolean overridable)
public void	setPublicId(String publicId)
public void	setReplaceWelcomeFiles(boolean `true` to replace welcome files rather than add to the list replaceWelcomeFiles) When merging/parsing web.xml files into this web.xml should the current set be completely replaced?
public void	setRequestCharacterEncoding(String requestCharacterEncoding)
public void	setResponseCharacterEncoding(String responseCharacterEncoding)
public void	setSessionConfig(SessionConfig sessionConfig)
public void	setURL(URL url)
public void	setVersion(String Values of `null` will be ignored version) Set the version for this web.xml file
public void	setWebappJar(boolean webappJar)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public String	Returns: The complete contents of web.xml as a String toXml() Generate a web.xml in String form that matches the representation stored in this object.

Inherited from org.apache.tomcat.util.descriptor.web.XmlEncodingBase:: getCharset setCharset

public Class WebXml

Field Summary

Constructor Summary

Method Summary