Package org.eclipse.jetty.ee10.servlet

Class FilterHolder

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.ee10.servlet.BaseHolder<T>

org.eclipse.jetty.ee10.servlet.Holder<jakarta.servlet.Filter>

org.eclipse.jetty.ee10.servlet.FilterHolder

All Implemented Interfaces:

Dumpable, LifeCycle

public class FilterHolder
extends Holder<jakarta.servlet.Filter>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	FilterHolder.Registration
static interface	FilterHolder.WrapFunction	Experimental Wrapper mechanism for Filter objects.
static class	FilterHolder.Wrapper

Nested classes/interfaces inherited from class org.eclipse.jetty.ee10.servlet.Holder

Holder.HolderConfig, Holder.HolderRegistration

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener, AbstractLifeCycle.StopException

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

Dumpable.DumpableContainer

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

LifeCycle.Listener

Field Summary

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, STARTED, STARTING, STOPPED, STOPPING

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

KEY

Constructor Summary

Constructors

Constructor	Description
FilterHolder()	Constructor
FilterHolder(jakarta.servlet.Filter filter)	Constructor for existing filter.
FilterHolder(Class<? extends jakarta.servlet.Filter> filter)	Constructor
FilterHolder(Source source)	Constructor

Method Summary

Modifier and Type	Method	Description
protected jakarta.servlet.Filter	createInstance()
void	destroyInstance(Object o)
void	doFilter(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, jakarta.servlet.FilterChain chain)
void	doStart()	Method to override to start the lifecycle
void	doStop()	Method to override to stop the lifecycle
void	dump(Appendable out, String indent)	Dump this object (and children) into an Appendable using the provided indent after any new lines.
jakarta.servlet.Filter	getFilter()
jakarta.servlet.FilterRegistration.Dynamic	getRegistration()
void	initialize()	Do any setup necessary after starting
void	setFilter(jakarta.servlet.Filter filter)
String	toString()

Methods inherited from class org.eclipse.jetty.ee10.servlet.Holder

dump, getDisplayName, getInitParameter, getInitParameterNames, getInitParameters, getName, isAsyncSupported, setAsyncSupported, setClassName, setDisplayName, setHeldClass, setInitParameter, setInitParameters, setInstance, setName

Methods inherited from class org.eclipse.jetty.ee10.servlet.BaseHolder

getClassName, getHeldClass, getInstance, getServletContext, getServletContextHandler, getServletHandler, getSource, illegalStateIfContextStarted, isInstance, setServletHandler, unwrap, wrap

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

addEventListener, getEventListeners, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeEventListener, setEventListeners, start, stop

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

Constructor Details

FilterHolder

public FilterHolder()

Constructor

FilterHolder

public FilterHolder(Source source)

Constructor

Parameters:

source - the holder source

FilterHolder

public FilterHolder(Class<? extends jakarta.servlet.Filter> filter)

Constructor

Parameters:

filter - the filter class

FilterHolder

public FilterHolder(jakarta.servlet.Filter filter)

Constructor for existing filter.

Parameters:

filter - the filter

Method Details

doStart

public void doStart()
             throws Exception

Description copied from class: AbstractLifeCycle

Method to override to start the lifecycle

Overrides:

doStart in class BaseHolder<jakarta.servlet.Filter>

Throws:

AbstractLifeCycle.StopException - If thrown, the lifecycle will immediately be stopped.

Exception - If there was a problem starting. Will cause a transition to FAILED state

initialize

public void initialize()
                throws Exception

Description copied from class: BaseHolder

Do any setup necessary after starting

Overrides:

initialize in class BaseHolder<jakarta.servlet.Filter>

Throws:

Exception - if unable to initialize

createInstance

protected jakarta.servlet.Filter createInstance()
                                         throws Exception

Overrides:

createInstance in class BaseHolder<jakarta.servlet.Filter>

Throws:

Exception

doStop

public void doStop()
            throws Exception

Description copied from class: AbstractLifeCycle

Method to override to stop the lifecycle

Overrides:

doStop in class BaseHolder<jakarta.servlet.Filter>

Throws:

Exception - If there was a problem stopping. Will cause a transition to FAILED state

destroyInstance

public void destroyInstance(Object o)

Overrides:

destroyInstance in class Holder<jakarta.servlet.Filter>

setFilter

public void setFilter(jakarta.servlet.Filter filter)

getFilter

public jakarta.servlet.Filter getFilter()

doFilter

public void doFilter(jakarta.servlet.ServletRequest request,
 jakarta.servlet.ServletResponse response,
 jakarta.servlet.FilterChain chain)
              throws IOException,
jakarta.servlet.ServletException

Throws:

IOException

jakarta.servlet.ServletException

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

Overrides:

dump in class BaseHolder<jakarta.servlet.Filter>

Parameters:

out - The appendable to dump to

indent - The indent to apply after any new lines.

Throws:

IOException - if unable to write to Appendable

toString

public String toString()

Overrides:

toString in class Holder<jakarta.servlet.Filter>

getRegistration

public jakarta.servlet.FilterRegistration.Dynamic getRegistration()