Package org.eclipse.jetty.servlet
Class FilterMapping
java.lang.Object
org.eclipse.jetty.servlet.FilterMapping
- All Implemented Interfaces:
Dumpable
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable
Dumpable.DumpableContainer
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
private String
private FilterHolder
private String[]
private String[]
static final int
static final int
static final int
Dispatch typesstatic final int
static final int
static final int
static final int
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription(package private) boolean
appliesTo
(int type) Check if this filter applies to a particular dispatch type.(package private) boolean
Check if this filter applies to a path.boolean
appliesTo
(javax.servlet.DispatcherType t) static javax.servlet.DispatcherType
dispatch
(int type) Dispatch type from namestatic javax.servlet.DispatcherType
Dispatch type from namestatic int
dispatch
(javax.servlet.DispatcherType type) Dispatch type from namedump()
void
dump
(Appendable out, String indent) Dump this object (and children) into an Appendable using the provided indent after any new lines.EnumSet
<javax.servlet.DispatcherType> (package private) FilterHolder
String[]
String[]
boolean
void
setDispatcherTypes
(EnumSet<javax.servlet.DispatcherType> dispatcherTypes) void
setDispatches
(int dispatches) (package private) void
setFilterHolder
(FilterHolder holder) void
setFilterName
(String filterName) void
setPathSpec
(String pathSpec) void
setPathSpecs
(String[] pathSpecs) void
setServletName
(String servletName) void
setServletNames
(String[] servletNames) toString()
-
Field Details
-
DEFAULT
public static final int DEFAULTDispatch types- See Also:
-
REQUEST
public static final int REQUEST- See Also:
-
FORWARD
public static final int FORWARD- See Also:
-
INCLUDE
public static final int INCLUDE- See Also:
-
ERROR
public static final int ERROR- See Also:
-
ASYNC
public static final int ASYNC- See Also:
-
ALL
public static final int ALL- See Also:
-
_dispatches
private int _dispatches -
_filterName
-
_holder
-
_pathSpecs
-
_servletNames
-
-
Constructor Details
-
FilterMapping
public FilterMapping()
-
-
Method Details
-
dispatch
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 -
dispatch
public static javax.servlet.DispatcherType dispatch(int type) Dispatch type from name -
appliesTo
Check if this filter applies to a path.- Parameters:
path
- The path to check or null to just check typetype
- 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. -
appliesTo
public boolean appliesTo(javax.servlet.DispatcherType t) -
isDefaultDispatches
public boolean isDefaultDispatches() -
getFilterName
- Returns:
- Returns the filterName.
-
getFilterHolder
FilterHolder getFilterHolder()- Returns:
- Returns the holder.
-
getPathSpecs
- Returns:
- Returns the pathSpec.
-
setDispatcherTypes
-
getDispatcherTypes
-
setDispatches
public void setDispatches(int dispatches) - Parameters:
dispatches
- The dispatches to set.- See Also:
-
setFilterName
- Parameters:
filterName
- The filterName to set.
-
setFilterHolder
- Parameters:
holder
- The holder to set.
-
setPathSpecs
- Parameters:
pathSpecs
- The Path specifications to which this filter should be mapped.
-
setPathSpec
- Parameters:
pathSpec
- The pathSpec to set.
-
getServletNames
- Returns:
- Returns the servletName.
-
setServletNames
- Parameters:
servletNames
- Maps thenamed filter
to multiple servlets- See Also:
-
setServletName
- Parameters:
servletName
- Maps thenamed filter
to a single servlet- See Also:
-
toString
-
dump
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 interfaceDumpable
- Parameters:
out
- The appendable to dump toindent
- The indent to apply after any new lines.- Throws:
IOException
- if unable to write to Appendable
-
dump
-