Package org.eclipse.jetty.servlet
Class BaseHolder<T>
java.lang.Object
org.eclipse.jetty.util.component.AbstractLifeCycle
org.eclipse.jetty.servlet.BaseHolder<T>
- Type Parameters:
T
- the type of holder
- Direct Known Subclasses:
Holder
,ListenerHolder
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 ClassesNested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle
AbstractLifeCycle.AbstractLifeCycleListener
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
FieldsModifier and TypeFieldDescriptionprivate String
private T
private ServletHandler
private final Source
private static final Logger
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
doStart()
void
doStop()
dump()
void
dump
(Appendable out, String indent) Dump this object (and children) into an Appendable using the provided indent after any new lines.protected T
protected void
void
Do any setup necessary after startingboolean
void
setClassName
(String className) void
setHeldClass
(Class<? extends T> held) protected void
setInstance
(T instance) void
setServletHandler
(ServletHandler servletHandler) protected T
protected <W> T
Wrap component using component specific Wrapper Function beans.Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle
addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, setStopTimeout, start, stop, toString
-
Field Details
-
LOG
-
_source
-
_class
-
_className
-
_instance
-
_servletHandler
-
-
Constructor Details
-
BaseHolder
-
-
Method Details
-
getSource
-
initialize
Do any setup necessary after starting- Throws:
Exception
- if unable to initialize
-
doStart
- Overrides:
doStart
in classAbstractLifeCycle
- Throws:
Exception
-
doStop
- Overrides:
doStop
in classAbstractLifeCycle
- Throws:
Exception
-
getClassName
-
getHeldClass
-
getServletHandler
- Returns:
- Returns the servletHandler.
-
setServletHandler
- Parameters:
servletHandler
- TheServletHandler
that will handle requests dispatched to this servlet.
-
setClassName
- Parameters:
className
- The className to set.
-
setHeldClass
- Parameters:
held
- The class to hold
-
illegalStateIfContextStarted
protected void illegalStateIfContextStarted() -
setInstance
-
getInstance
-
isInstance
public boolean isInstance()- Returns:
- True if this holder was created for a specific instance.
-
wrap
Wrap component using component specific Wrapper Function beans.- Type Parameters:
W
- the "wrapper function" implementation. (eg:ServletHolder.WrapperFunction
orFilterHolder.WrapperFunction
, etc)- Parameters:
component
- the component to optionally wrapwrapperFunctionType
- the bean class type to look for in theServletContextHandler
function
- the BiFunction to execute for eachwrapperFunctionType
Bean found (passing in the component and component type)- Returns:
- the component that has passed through all Wrapper Function beans found.
-
unwrap
-
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
-