Class FilterMap
- java.lang.Object
- 
- org.apache.tomcat.util.descriptor.web.XmlEncodingBase
- 
- org.apache.tomcat.util.descriptor.web.FilterMap
 
 
- 
- All Implemented Interfaces:
- java.io.Serializable
 
 public class FilterMap extends XmlEncodingBase implements java.io.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:
- Serialized Form
 
- 
- 
Constructor SummaryConstructors Constructor Description FilterMap()
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddServletName(java.lang.String servletName)voidaddURLPattern(java.lang.String urlPattern)voidaddURLPatternDecoded(java.lang.String urlPattern)intgetDispatcherMapping()java.lang.String[]getDispatcherNames()java.lang.StringgetFilterName()booleangetMatchAllServletNames()booleangetMatchAllUrlPatterns()java.lang.String[]getServletNames()java.lang.String[]getURLPatterns()voidsetDispatcher(java.lang.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(java.lang.String filterName)java.lang.StringtoString()Render a String representation of this object.- 
Methods inherited from class org.apache.tomcat.util.descriptor.web.XmlEncodingBasegetCharset, getEncoding, setCharset, setEncoding
 
- 
 
- 
- 
- 
Field Detail- 
ERRORpublic static final int ERROR The name of this filter to be executed when this mapping matches a particular request.- See Also:
- Constant Field Values
 
 - 
FORWARDpublic static final int FORWARD - See Also:
- Constant Field Values
 
 - 
INCLUDEpublic static final int INCLUDE - See Also:
- Constant Field Values
 
 - 
REQUESTpublic static final int REQUEST - See Also:
- Constant Field Values
 
 - 
ASYNCpublic static final int ASYNC - See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
getFilterNamepublic java.lang.String getFilterName() 
 - 
setFilterNamepublic void setFilterName(java.lang.String filterName) 
 - 
getServletNamespublic java.lang.String[] getServletNames() 
 - 
addServletNamepublic void addServletName(java.lang.String servletName) 
 - 
getMatchAllUrlPatternspublic boolean getMatchAllUrlPatterns() 
 - 
getMatchAllServletNamespublic boolean getMatchAllServletNames() 
 - 
getURLPatternspublic java.lang.String[] getURLPatterns() 
 - 
addURLPatternpublic void addURLPattern(java.lang.String urlPattern) 
 - 
addURLPatternDecodedpublic void addURLPatternDecoded(java.lang.String urlPattern) 
 - 
setDispatcherpublic void setDispatcher(java.lang.String dispatcherString) 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
 
 - 
getDispatcherMappingpublic int getDispatcherMapping() 
 - 
getDispatcherNamespublic java.lang.String[] getDispatcherNames() 
 - 
toStringpublic java.lang.String toString() Render a String representation of this object.- Overrides:
- toStringin class- java.lang.Object
 
 
- 
 
-