Class FilterMap
java.lang.Object
org.apache.tomcat.util.descriptor.web.XmlEncodingBase
org.apache.tomcat.util.descriptor.web.FilterMap
- All Implemented Interfaces:
Serializable
Representation of a filter mapping for a web application, as represented in a
<filter-mapping>
element in the deployment descriptor. Each filter mapping must contain a filter name plus either a URL pattern or a
servlet name.- Author:
- Craig R. McClanahan
- See Also:
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddServletName(String servletName) voidaddURLPattern(String urlPattern) voidaddURLPatternDecoded(String urlPattern) intString[]booleanbooleanString[]String[]voidsetDispatcher(String dispatcherString) This method will be used to set the current state of the FilterMap representing the state of when filters should be applied.voidsetFilterName(String filterName) toString()Render a String representation of this object.Methods inherited from class org.apache.tomcat.util.descriptor.web.XmlEncodingBase
getCharset, setCharset
-
Field Details
-
ERROR
public static final int ERRORThe name of this filter to be executed when this mapping matches a particular request.- See Also:
-
FORWARD
public static final int FORWARD- See Also:
-
INCLUDE
public static final int INCLUDE- See Also:
-
REQUEST
public static final int REQUEST- See Also:
-
ASYNC
public static final int ASYNC- See Also:
-
-
Constructor Details
-
FilterMap
public FilterMap()
-
-
Method Details
-
getFilterName
-
setFilterName
-
getServletNames
-
addServletName
-
getMatchAllUrlPatterns
public boolean getMatchAllUrlPatterns() -
getMatchAllServletNames
public boolean getMatchAllServletNames() -
getURLPatterns
-
addURLPattern
-
addURLPatternDecoded
-
setDispatcher
This method will be used to set the current state of the FilterMap representing the state of when filters should be applied.- Parameters:
dispatcherString- the dispatcher type which should match this filter
-
getDispatcherMapping
public int getDispatcherMapping() -
getDispatcherNames
-
toString
-