Class FilterMapping

java.lang.Object
org.eclipse.jetty.servlet.FilterMapping
All Implemented Interfaces:
Dumpable
@ManagedObject("Filter Mappings") public class FilterMapping extends Object implements Dumpable

  • Field Details

  • Constructor Details

    • FilterMapping

      public FilterMapping()

  • Method Details

    • dispatch

      public static javax.servlet.DispatcherType dispatch(String type)
      Dispatch type from name
      Parameters:
      type - the type name
      Returns:
      the dispatcher type

    • dispatch

      public static int dispatch(javax.servlet.DispatcherType type)
      Dispatch type from name
      Parameters:
      type - the dispatcher type
      Returns:
      the type constant (REQUEST, ASYNC, FORWARD, INCLUDE, or ERROR)

    • dispatch

      public static javax.servlet.DispatcherType dispatch(int type)
      Dispatch type from name
      Parameters:
      type - the dispatcher type
      Returns:
      the type constant (REQUEST, ASYNC, FORWARD, INCLUDE, or ERROR)

    • appliesTo

      boolean appliesTo(String path, int type)
      Check if this filter applies to a path.
      Parameters:
      path - The path to check or null to just check type
      type - The type of request: __REQUEST,__FORWARD,__INCLUDE, __ASYNC or __ERROR.
      Returns:
      True if this filter applies

    • appliesTo

      boolean appliesTo(int type)
      Check if this filter applies to a particular dispatch type.
      Parameters:
      type - The type of request: REQUEST, FORWARD, INCLUDE or ERROR.
      Returns:
      true if this filter applies

    • appliesTo

      public boolean appliesTo(javax.servlet.DispatcherType t)

    • isDefaultDispatches

      public boolean isDefaultDispatches()

    • getFilterName

      @ManagedAttribute(value="filter name", readonly=true) public String getFilterName()
      Returns:
      Returns the filterName.

    • getFilterHolder

      FilterHolder getFilterHolder()
      Returns:
      Returns the holder.

    • getPathSpecs

      @ManagedAttribute(value="url patterns", readonly=true) public String[] getPathSpecs()
      Returns:
      Returns the pathSpec.

    • setDispatcherTypes

      public void setDispatcherTypes(EnumSet<javax.servlet.DispatcherType> dispatcherTypes)

    • getDispatcherTypes

      public EnumSet<javax.servlet.DispatcherType> getDispatcherTypes()

    • setDispatches

      public void setDispatches(int dispatches)
      Parameters:
      dispatches - The dispatches to set.
      See Also:

    • setFilterName

      public void setFilterName(String filterName)
      Parameters:
      filterName - The filterName to set.

    • setFilterHolder

      void setFilterHolder(FilterHolder holder)
      Parameters:
      holder - The holder to set.

    • setPathSpecs

      public void setPathSpecs(String[] pathSpecs)
      Parameters:
      pathSpecs - The Path specifications to which this filter should be mapped.

    • setPathSpec

      public void setPathSpec(String pathSpec)
      Parameters:
      pathSpec - The pathSpec to set.

    • getServletNames

      @ManagedAttribute(value="servlet names", readonly=true) public String[] getServletNames()
      Returns:
      Returns the servletName.

    • setServletNames

      public void setServletNames(String[] servletNames)
      Parameters:
      servletNames - Maps the named filter to multiple servlets
      See Also:

    • setServletName

      public void setServletName(String servletName)
      Parameters:
      servletName - Maps the named filter to a single servlet
      See Also:

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • dump

      public void dump(Appendable out, String indent) throws IOException
      Description copied from interface: Dumpable
      Dump this object (and children) into an Appendable using the provided indent after any new lines. The indent should not be applied to the first object dumped.
      Specified by:
      dump in interface Dumpable
      Parameters:
      out - The appendable to dump to
      indent - The indent to apply after any new lines.
      Throws:
      IOException - if unable to write to Appendable

    • dump

      public String dump()
      Specified by:
      dump in interface Dumpable