Top Description Fields Constructors Methods
org.apache.tomcat.util.descriptor.web

public Class WebRuleSet

Additional top-level classes in compilation unit: SetLoginConfig, SetJspConfig, SetSessionConfig, SetAuthConstraintRule, SetDistributableRule, SetDenyUncoveredHttpMethodsRule, SetPublicIdRule, ServletDefCreateRule, CallParamMultiRule, CallMethodMultiRule, IgnoreAnnotationsRule, VersionRule, NameRule, AbsoluteOrderingRule, RelativeOrderingRule, SoapHeaderRule, ServiceQnameRule, TaglibLocationRule, MappedNameRule, LifecycleCallbackRule, SetOverrideRule.

extends Object
implements RuleSet
Class Inheritance
All Implemented Interfaces
org.apache.tomcat.util.digester.RuleSet
Imports
java.lang.reflect.Method, java.util.ArrayList, org.apache.tomcat.util.IntrospectionUtils, org.apache.tomcat.util.digester.CallMethodRule, .CallParamRule, .Digester, .Rule, .RuleSet, .SetNextRule, org.apache.tomcat.util.res.StringManager, org.xml.sax.Attributes

RuleSet for processing the contents of a web application deployment descriptor (/WEB-INF/web.xml) resource.

Author
Craig R. McClanahan

Field Summary

Modifier and TypeField and Description
protected final AbsoluteOrderingRule
absoluteOrdering

The AbsoluteOrderingRule rule used to parse the web.xml

protected final boolean
fragment

Flag that indicates if this ruleset is for a web-fragment.xml file or for a web.xml file.

protected final String
fullPrefix

The full pattern matching prefix, including the webapp or web-fragment component, to use for matching elements

protected final SetJspConfig
jspConfig

The SetJspConfig rule used to parse the web.xml

protected final SetLoginConfig
loginConfig

The SetLoginConfig rule used to parse the web.xml

protected final NameRule
name

The NameRule rule used to parse the web.xml

protected final String
prefix

The matching pattern prefix to use for recognizing our elements.

protected final RelativeOrderingRule
relativeOrdering

The RelativeOrderingRule rule used to parse the web.xml

protected final SetSessionConfig
sessionConfig

The SetSessionConfig rule used to parse the web.xml

protected static final StringManager
sm

The string resources for this package.

Constructor Summary

AccessConstructor and Description
public
WebRuleSet()

Construct an instance of this RuleSet with the default matching pattern prefix and default fragment setting.

public
WebRuleSet(boolean
true if this is a web fragment
fragment)

Construct an instance of this RuleSet with the default matching pattern prefix.

public
WebRuleSet(String
Prefix for matching pattern rules (including the trailing slash character)
prefix, boolean
true if this is a web fragment
fragment)

Construct an instance of this RuleSet with the specified matching pattern prefix.

Method Summary

Modifier and TypeMethod and Description
public void
addRuleInstances(Digester
Digester instance to which the new Rule instances should be added.
digester)

Implements org.apache.tomcat.util.digester.RuleSet.addRuleInstances.

Add the set of Rule instances defined in this RuleSet to the specified Digester instance, associating them with our namespace URI (if any).

protected void
configureInjectionRules(Digester digester, String base)

protected void
configureNamingRules(Digester digester)

public void
recycle()

Reset counter used for validating the web.xml file.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

absoluteOrderingback to summary
protected final AbsoluteOrderingRule absoluteOrdering

The AbsoluteOrderingRule rule used to parse the web.xml

fragmentback to summary
protected final boolean fragment

Flag that indicates if this ruleset is for a web-fragment.xml file or for a web.xml file.

fullPrefixback to summary
protected final String fullPrefix

The full pattern matching prefix, including the webapp or web-fragment component, to use for matching elements

jspConfigback to summary
protected final SetJspConfig jspConfig

The SetJspConfig rule used to parse the web.xml

loginConfigback to summary
protected final SetLoginConfig loginConfig

The SetLoginConfig rule used to parse the web.xml

nameback to summary
protected final NameRule name

The NameRule rule used to parse the web.xml

prefixback to summary
protected final String prefix

The matching pattern prefix to use for recognizing our elements.

relativeOrderingback to summary
protected final RelativeOrderingRule relativeOrdering

The RelativeOrderingRule rule used to parse the web.xml

sessionConfigback to summary
protected final SetSessionConfig sessionConfig

The SetSessionConfig rule used to parse the web.xml

smback to summary
protected static final StringManager sm

The string resources for this package.

Constructor Detail

WebRuleSetback to summary
public WebRuleSet()

Construct an instance of this RuleSet with the default matching pattern prefix and default fragment setting.

WebRuleSetback to summary
public WebRuleSet(boolean fragment)

Construct an instance of this RuleSet with the default matching pattern prefix.

Parameters
fragment:boolean

true if this is a web fragment

WebRuleSetback to summary
public WebRuleSet(String prefix, boolean fragment)

Construct an instance of this RuleSet with the specified matching pattern prefix.

Parameters
prefix:String

Prefix for matching pattern rules (including the trailing slash character)

fragment:boolean

true if this is a web fragment

Method Detail

addRuleInstancesback to summary
public void addRuleInstances(Digester digester)

Implements org.apache.tomcat.util.digester.RuleSet.addRuleInstances.

Add the set of Rule instances defined in this RuleSet to the specified Digester instance, associating them with our namespace URI (if any). This method should only be called by a Digester instance.

Parameters
digester:Digester

Digester instance to which the new Rule instances should be added.

Annotations
@Override
configureInjectionRulesback to summary
protected void configureInjectionRules(Digester digester, String base)
configureNamingRulesback to summary
protected void configureNamingRules(Digester digester)
recycleback to summary
public void recycle()

Reset counter used for validating the web.xml file.