Class WebRuleSet
java.lang.Object
org.apache.tomcat.util.descriptor.web.WebRuleSet
- All Implemented Interfaces:
- RuleSet
RuleSet for processing the contents of a web application
 deployment descriptor (/WEB-INF/web.xml) resource.
- Author:
- Craig R. McClanahan
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected final org.apache.tomcat.util.descriptor.web.AbsoluteOrderingRuleTheAbsoluteOrderingRulerule used to parse the web.xmlprotected final booleanFlag that indicates if this ruleset is for a web-fragment.xml file or for a web.xml file.protected final StringThe full pattern matching prefix, including the webapp or web-fragment component, to use for matching elementsprotected final org.apache.tomcat.util.descriptor.web.SetJspConfigTheSetJspConfigrule used to parse the web.xmlprotected final org.apache.tomcat.util.descriptor.web.SetLoginConfigTheSetLoginConfigrule used to parse the web.xmlprotected final org.apache.tomcat.util.descriptor.web.NameRuleTheNameRulerule used to parse the web.xmlprotected final StringThe matching pattern prefix to use for recognizing our elements.protected final org.apache.tomcat.util.descriptor.web.RelativeOrderingRuleTheRelativeOrderingRulerule used to parse the web.xmlprotected final org.apache.tomcat.util.descriptor.web.SetSessionConfigTheSetSessionConfigrule used to parse the web.xmlprotected static final StringManagerThe string resources for this package.
- 
Constructor SummaryConstructorsConstructorDescriptionConstruct an instance of thisRuleSetwith the default matching pattern prefix and default fragment setting.WebRuleSet(boolean fragment) Construct an instance of thisRuleSetwith the default matching pattern prefix.WebRuleSet(String prefix, boolean fragment) Construct an instance of thisRuleSetwith the specified matching pattern prefix.
- 
Method SummaryModifier and TypeMethodDescriptionvoidaddRuleInstances(Digester digester) Add the set of Rule instances defined in this RuleSet to the specifiedDigesterinstance, associating them with our namespace URI (if any).protected voidconfigureInjectionRules(Digester digester, String base) protected voidconfigureNamingRules(Digester digester) voidrecycle()Reset counter used for validating the web.xml file.
- 
Field Details- 
smThe string resources for this package.
- 
prefixThe matching pattern prefix to use for recognizing our elements.
- 
fullPrefixThe full pattern matching prefix, including the webapp or web-fragment component, to use for matching elements
- 
fragmentprotected final boolean fragmentFlag that indicates if this ruleset is for a web-fragment.xml file or for a web.xml file.
- 
sessionConfigprotected final org.apache.tomcat.util.descriptor.web.SetSessionConfig sessionConfigTheSetSessionConfigrule used to parse the web.xml
- 
loginConfigprotected final org.apache.tomcat.util.descriptor.web.SetLoginConfig loginConfigTheSetLoginConfigrule used to parse the web.xml
- 
jspConfigprotected final org.apache.tomcat.util.descriptor.web.SetJspConfig jspConfigTheSetJspConfigrule used to parse the web.xml
- 
nameprotected final org.apache.tomcat.util.descriptor.web.NameRule nameTheNameRulerule used to parse the web.xml
- 
absoluteOrderingprotected final org.apache.tomcat.util.descriptor.web.AbsoluteOrderingRule absoluteOrderingTheAbsoluteOrderingRulerule used to parse the web.xml
- 
relativeOrderingprotected final org.apache.tomcat.util.descriptor.web.RelativeOrderingRule relativeOrderingTheRelativeOrderingRulerule used to parse the web.xml
 
- 
- 
Constructor Details- 
WebRuleSetpublic WebRuleSet()Construct an instance of thisRuleSetwith the default matching pattern prefix and default fragment setting.
- 
WebRuleSetpublic WebRuleSet(boolean fragment) Construct an instance of thisRuleSetwith the default matching pattern prefix.- Parameters:
- fragment-- trueif this is a web fragment
 
- 
WebRuleSetConstruct an instance of thisRuleSetwith the specified matching pattern prefix.- Parameters:
- prefix- Prefix for matching pattern rules (including the trailing slash character)
- fragment-- trueif this is a web fragment
 
 
- 
- 
Method Details- 
addRuleInstancesAdd the set of Rule instances defined in this RuleSet to the specified Digesterinstance, associating them with our namespace URI (if any). This method should only be called by a Digester instance.- Specified by:
- addRuleInstancesin interface- RuleSet
- Parameters:
- digester- Digester instance to which the new Rule instances should be added.
 
- 
configureNamingRules
- 
configureInjectionRules
- 
recyclepublic void recycle()Reset counter used for validating the web.xml file.
 
-