Class BaseHolder<T>

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

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

Type Parameters:

T - the type of holder

All Implemented Interfaces:

Dumpable, LifeCycle

Direct Known Subclasses:

Holder, ListenerHolder, ServletContainerInitializerHolder

public abstract class BaseHolder<T>
extends AbstractLifeCycle
implements Dumpable

AbstractHolder Base class for all servlet-related classes that may be lazily instantiated (eg servlet, filter, listener), and/or require metadata to be held regarding their origin (web.xml, annotation, programmatic api etc).

Nested Class Summary

Nested classes/interfaces inherited from class AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener, AbstractLifeCycle.StopException

Nested classes/interfaces inherited from interface Dumpable

Dumpable.DumpableContainer

Nested classes/interfaces inherited from interface LifeCycle

LifeCycle.Listener

Field Summary

Fields inherited from class AbstractLifeCycle

FAILED, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface Dumpable

KEY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseHolder(Source source)

Method Summary

Modifier and Type	Method	Description
protected T	createInstance()
void	doStart()	Method to override to start the lifecycle
void	doStop()	Method to override to stop the lifecycle
String	dump()
void	dump(Appendable out, String indent)	Dump this object (and children) into an Appendable using the provided indent after any new lines.
String	getClassName()
Class<? extends T>	getHeldClass()
protected T	getInstance()
jakarta.servlet.ServletContext	getServletContext()
ServletContextHandler	getServletContextHandler()
ServletHandler	getServletHandler()
Source	getSource()
protected void	illegalStateIfContextStarted()
void	initialize()	Do any setup necessary after starting
boolean	isInstance()
void	setClassName(String className)
void	setHeldClass(Class<? extends T> held)
protected void	setInstance(T instance)
void	setServletHandler(ServletHandler servletHandler)
protected T	unwrap(T component)
protected <W> T	wrap(T component, Class<W> wrapperFunctionType, BiFunction<W,T,T> function)	Wrap component using component specific Wrapper Function beans.

Methods inherited from class AbstractLifeCycle

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

Methods inherited from class Object

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

Methods inherited from interface Dumpable

dumpSelf

Constructor Details

BaseHolder

protected BaseHolder(Source source)

Method Details

getSource

public Source getSource()

initialize

public void initialize()
                throws Exception

Do any setup necessary after starting

Throws:

Exception - if unable to initialize

doStart

public void doStart()
             throws Exception

Description copied from class: AbstractLifeCycle

Method to override to start the lifecycle

Overrides:

doStart in class AbstractLifeCycle

Throws:

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

doStop

public void doStop()
            throws Exception

Description copied from class: AbstractLifeCycle

Method to override to stop the lifecycle

Overrides:

doStop in class AbstractLifeCycle

Throws:

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

getClassName

@ManagedAttribute(value="Class Name",
                  readonly=true)
public String getClassName()

getHeldClass

public Class<? extends T> getHeldClass()

getServletHandler

public ServletHandler getServletHandler()

Returns:

Returns the servletHandler.

setServletHandler

public void setServletHandler(ServletHandler servletHandler)

Parameters:

servletHandler - The ServletHandler that will handle requests dispatched to this servlet.

setClassName

public void setClassName(String className)

Parameters:

className - The className to set.

setHeldClass

public void setHeldClass(Class<? extends T> held)

Parameters:

held - The class to hold

illegalStateIfContextStarted

protected void illegalStateIfContextStarted()

setInstance

protected void setInstance(T instance)

getInstance

protected T getInstance()

createInstance

protected T createInstance()
                    throws Exception

Throws:

Exception

getServletContext

public jakarta.servlet.ServletContext getServletContext()

getServletContextHandler

public ServletContextHandler getServletContextHandler()

isInstance

public boolean isInstance()

Returns:

True if this holder was created for a specific instance.

wrap

protected <W> T wrap(T component,
 Class<W> wrapperFunctionType,
 BiFunction<W,T,T> function)

Wrap component using component specific Wrapper Function beans.

Type Parameters:

W - the "wrapper function" implementation. (eg: ServletHolder.WrapperFunction or FilterHolder.WrapperFunction, etc)

Parameters:

component - the component to optionally wrap

wrapperFunctionType - the bean class type to look for in the ServletContextHandler

function - the BiFunction to execute for each wrapperFunctionType Bean found (passing in the component and component type)

Returns:

the component that has passed through all Wrapper Function beans found.

unwrap

protected T unwrap(T component)

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