org.eclipse.jetty.servlet

Class Holder<T>

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

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

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

Type Parameters:

T - the type of holder

All Implemented Interfaces:

Dumpable, LifeCycle

Direct Known Subclasses:

FilterHolder, ServletHolder

@ManagedObject(value="Holder - a container for servlets and the like")
public class Holder<T>
extends BaseHolder<T>

Holder Specialization of AbstractHolder for servlet-related classes that have init-params etc

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	Holder.HolderConfig
protected class	Holder.HolderRegistration

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

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 boolean	_asyncSupported
protected String	_displayName
protected Map<String,String>	_initParams
protected String	_name

Fields inherited from class org.eclipse.jetty.servlet.BaseHolder

_class, _className, _extInstance, _servletHandler, _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	Holder(BaseHolder.Source source)

Method Summary

Modifier and Type	Method and Description
void	destroyInstance(Object instance)
String	dump()
void	dump(Appendable out, String indent)
String	getDisplayName()
String	getInitParameter(String param)
Enumeration<String>	getInitParameterNames()
Map<String,String>	getInitParameters()
String	getName()
boolean	isAsyncSupported()
void	setAsyncSupported(boolean suspendable)
void	setClassName(String className)
void	setDisplayName(String name)
void	setHeldClass(Class<? extends T> held)
void	setInitParameter(String param, String value)
void	setInitParameters(Map<String,String> map)
void	setName(String name) The name is a primary key for the held object.
String	toString()

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

doStart, doStop, getClassName, getHeldClass, getServletHandler, getSource, illegalStateIfContextStarted, initialize, isInstance, setServletHandler

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, wait, wait, wait

Field Detail

_initParams

protected final Map<String,String> _initParams

_displayName

protected String _displayName

_asyncSupported

protected boolean _asyncSupported

_name

protected String _name

Constructor Detail

Holder

protected Holder(BaseHolder.Source source)

Method Detail

getDisplayName

@ManagedAttribute(value="Display Name",
                  readonly=true)
public String getDisplayName()

getInitParameter

public String getInitParameter(String param)

getInitParameterNames

public Enumeration<String> getInitParameterNames()

getInitParameters

@ManagedAttribute(value="Initial Parameters",
                  readonly=true)
public Map<String,String> getInitParameters()

getName

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

destroyInstance

public void destroyInstance(Object instance)
                     throws Exception

Throws:

Exception

setClassName

public void setClassName(String className)

Overrides:

setClassName in class BaseHolder<T>

Parameters:

className - The className to set.

setHeldClass

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

Overrides:

setHeldClass in class BaseHolder<T>

Parameters:

held - The class to hold

setDisplayName

public void setDisplayName(String name)

setInitParameter

public void setInitParameter(String param,
                             String value)

setInitParameters

public void setInitParameters(Map<String,String> map)

setName

public void setName(String name)

The name is a primary key for the held object. Ensure that the name is set BEFORE adding a Holder (eg ServletHolder or FilterHolder) to a ServletHandler.

Parameters:

name - The name to set.

setAsyncSupported

public void setAsyncSupported(boolean suspendable)

isAsyncSupported

public boolean isAsyncSupported()

dump

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

Specified by:

dump in interface Dumpable

Overrides:

dump in class BaseHolder<T>

Throws:

IOException

dump

public String dump()

Specified by:

dump in interface Dumpable

Overrides:

dump in class BaseHolder<T>

toString

public String toString()

Overrides:

toString in class Object