Package org.eclipse.jetty.servlet

Class FilterMapping

java.lang.Object

org.eclipse.jetty.servlet.FilterMapping

All Implemented Interfaces:

Dumpable

@ManagedObject("Filter Mappings")
public class FilterMapping
extends Object
implements Dumpable

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

Dumpable.DumpableContainer

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALL
static final int	ASYNC
static final int	DEFAULT	Dispatch types
static final int	ERROR
static final int	FORWARD
static final int	INCLUDE
static final int	REQUEST

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Constructor Summary

Constructors

Constructor	Description
FilterMapping()

Method Summary

Modifier and Type	Method	Description
boolean	appliesTo(jakarta.servlet.DispatcherType t)
static jakarta.servlet.DispatcherType	dispatch(int type)	Dispatch type from name
static int	dispatch(jakarta.servlet.DispatcherType type)	Dispatch type from name
static jakarta.servlet.DispatcherType	dispatch(String type)	Dispatch type from name
String	dump()
void	dump(Appendable out, String indent)	Dump this object (and children) into an Appendable using the provided indent after any new lines.
EnumSet<jakarta.servlet.DispatcherType>	getDispatcherTypes()
String	getFilterName()
String[]	getPathSpecs()
String[]	getServletNames()
boolean	isDefaultDispatches()
void	setDispatcherTypes(EnumSet<jakarta.servlet.DispatcherType> dispatcherTypes)
void	setDispatches(int dispatches)
void	setFilterName(String filterName)
void	setPathSpec(String pathSpec)
void	setPathSpecs(String[] pathSpecs)
void	setServletName(String servletName)
void	setServletNames(String[] servletNames)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dumpSelf

Field Details

DEFAULT

public static final int DEFAULT

Dispatch types

See Also:

• Constant Field Values

REQUEST

public static final int REQUEST

See Also:

• Constant Field Values

FORWARD

public static final int FORWARD

See Also:

• Constant Field Values

INCLUDE

public static final int INCLUDE

See Also:

• Constant Field Values

ERROR

public static final int ERROR

See Also:

• Constant Field Values

ASYNC

public static final int ASYNC

See Also:

• Constant Field Values

ALL

public static final int ALL

See Also:

• Constant Field Values

Constructor Details

FilterMapping

public FilterMapping()

Method Details

dispatch

public static jakarta.servlet.DispatcherType dispatch(String type)

Dispatch type from name

Parameters:

type - the type name

Returns:

the dispatcher type

dispatch

public static int dispatch(jakarta.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 jakarta.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

public boolean appliesTo(jakarta.servlet.DispatcherType t)

isDefaultDispatches

public boolean isDefaultDispatches()

getFilterName

@ManagedAttribute(value="filter name",
                  readonly=true)
public String getFilterName()

Returns:

Returns the filterName.

getPathSpecs

@ManagedAttribute(value="url patterns",
                  readonly=true)
public String[] getPathSpecs()

Returns:

Returns the pathSpec.

setDispatcherTypes

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

getDispatcherTypes

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

setDispatches

public void setDispatches(int dispatches)

Parameters:

dispatches - The dispatches to set.

See Also:

• DEFAULT
• REQUEST
• ERROR
• FORWARD
• INCLUDE

setFilterName

public void setFilterName(String filterName)

Parameters:

filterName - The filterName 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(java.lang.String)

setServletName

public void setServletName(String servletName)

Parameters:

servletName - Maps the named filter to a single servlet

See Also:

• setServletNames(java.lang.String[])

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