Class FilterMap

java.lang.Object
org.apache.tomcat.util.descriptor.web.XmlEncodingBase
org.apache.tomcat.util.descriptor.web.FilterMap
All Implemented Interfaces:
Serializable

public class FilterMap extends XmlEncodingBase implements 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 Details

  • Constructor Details

    • FilterMap

      public FilterMap()
  • Method Details

    • getFilterName

      public String getFilterName()
    • setFilterName

      public void setFilterName(String filterName)
    • getServletNames

      public String[] getServletNames()
    • addServletName

      public void addServletName(String servletName)
    • getMatchAllUrlPatterns

      public boolean getMatchAllUrlPatterns()
    • getMatchAllServletNames

      public boolean getMatchAllServletNames()
    • getURLPatterns

      public String[] getURLPatterns()
    • addURLPattern

      public void addURLPattern(String urlPattern)
    • addURLPatternDecoded

      public void addURLPatternDecoded(String urlPattern)
    • setDispatcher

      public void setDispatcher(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
    • getDispatcherMapping

      public int getDispatcherMapping()
    • getDispatcherNames

      public String[] getDispatcherNames()
    • toString

      public String toString()
      Render a String representation of this object.
      Overrides:
      toString in class Object