org.eclipse.jetty.servlet

Class BaseHolder<T>

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

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

All Implemented Interfaces:

Dumpable, LifeCycle

Direct Known Subclasses:

Holder, ListenerHolder

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

Modifier and Type	Class and Description
static class	BaseHolder.Source

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

AbstractLifeCycle.AbstractLifeCycleListener

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

LifeCycle.Listener

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<? extends T>	_class
protected String	_className
protected boolean	_extInstance
protected ServletHandler	_servletHandler
protected BaseHolder.Source	_source

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

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseHolder(BaseHolder.Source source)

Method Summary

Methods

Modifier and Type	Method and Description
void	doStart()
void	doStop()
String	dump()
void	dump(Appendable out, String indent)
String	getClassName()
Class<? extends T>	getHeldClass()
ServletHandler	getServletHandler()
BaseHolder.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)
void	setServletHandler(ServletHandler servletHandler)

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

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, setStopTimeout, start, stop

Methods inherited from class java.lang.Object

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

Field Detail

_source

protected final BaseHolder.Source _source

_class

protected transient Class<? extends T> _class

_className

protected String _className

_extInstance

protected boolean _extInstance

_servletHandler

protected ServletHandler _servletHandler

Constructor Detail

BaseHolder

protected BaseHolder(BaseHolder.Source source)

Method Detail

getSource

public BaseHolder.Source getSource()

initialize

public void initialize()
                throws Exception

Do any setup necessary after starting

Throws:

Exception

doStart

public void doStart()
             throws Exception

Overrides:

doStart in class AbstractLifeCycle

Throws:

Exception

doStop

public void doStop()
            throws Exception

Overrides:

doStop in class AbstractLifeCycle

Throws:

Exception

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()

isInstance

public boolean isInstance()

Returns:

True if this holder was created for a specific instance.

dump

public void dump(Appendable out,
        String indent)
          throws IOException

Specified by:

dump in interface Dumpable

Throws:

IOException

dump

public String dump()

Specified by:

dump in interface Dumpable