org.eclipse.jetty.servlet

Class ServletHolder

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

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

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

org.eclipse.jetty.servlet.ServletHolder

All Implemented Interfaces:

Comparable<ServletHolder>, UserIdentity.Scope, Dumpable, LifeCycle

Direct Known Subclasses:

AntWebAppContext.AntServletHolder

@ManagedObject(value="Servlet Holder")
public class ServletHolder
extends Holder<Servlet>
implements UserIdentity.Scope, Comparable<ServletHolder>

Servlet Instance and Context Holder. Holds the name, params and some state of a javax.servlet.Servlet instance. It implements the ServletConfig interface. This class will organise the loading of the servlet when needed or requested.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ServletHolder.Config
static class	ServletHolder.JspContainer
class	ServletHolder.Registration

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

Holder.HolderConfig, 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
static String	APACHE_SENTINEL_CLASS
static String	GLASSFISH_SENTINEL_CLASS
static String	JSP_GENERATED_PACKAGE_NAME
static Map<String,String>	NO_MAPPED_ROLES

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

_asyncSupported, _displayName, _initParams, _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

Constructor and Description
ServletHolder() Constructor .
ServletHolder(BaseHolder.Source creator) Constructor .
ServletHolder(Class<? extends Servlet> servlet) Constructor for servlet class.
ServletHolder(Servlet servlet) Constructor for existing servlet.
ServletHolder(String name, Class<? extends Servlet> servlet) Constructor for servlet class.
ServletHolder(String name, Servlet servlet) Constructor for servlet class.

Method Summary

Methods

Modifier and Type	Method and Description
void	checkServletType() Check to ensure class of servlet is acceptable.
int	compareTo(ServletHolder sh) Comparitor by init order.
void	destroyInstance(Object o)
void	doStart()
void	doStop()
boolean	equals(Object o)
String	getContextPath()
String	getForcedPath()
int	getInitOrder()
ServletRegistration.Dynamic	getRegistration()
Map<String,String>	getRoleRefMap()
String	getRunAsRole()
Servlet	getServlet() Get the servlet.
Servlet	getServletInstance() Get the servlet instance (no initialization done).
UnavailableException	getUnavailableException()
String	getUserRoleLink(String name) get a user role link.
void	handle(Request baseRequest, ServletRequest request, ServletResponse response) Service a request with this servlet.
int	hashCode()
void	initialize() Do any setup necessary after starting
protected void	initJspServlet()
protected void	initMultiPart() Register a ServletRequestListener that will ensure tmp multipart files are deleted when the request goes out of scope.
boolean	isAvailable()
boolean	isEnabled()
protected Servlet	newInstance()
protected void	prepare(Request baseRequest, ServletRequest request, ServletResponse response) Prepare to service a request.
void	setEnabled(boolean enabled)
void	setForcedPath(String forcedPath)
void	setInitOrder(int order) Set the initialize order.
void	setRunAsRole(String role)
void	setServlet(Servlet servlet)
void	setUserRoleLink(String name, String link) Link a user role.
String	toString()

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

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

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

getClassName, getHeldClass, getServletHandler, getSource, illegalStateIfContextStarted, 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, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.jetty.server.UserIdentity.Scope

getName

Field Detail

GLASSFISH_SENTINEL_CLASS

public static final String GLASSFISH_SENTINEL_CLASS

See Also:

Constant Field Values

APACHE_SENTINEL_CLASS

public static final String APACHE_SENTINEL_CLASS

See Also:

Constant Field Values

JSP_GENERATED_PACKAGE_NAME

public static final String JSP_GENERATED_PACKAGE_NAME

See Also:

Constant Field Values

NO_MAPPED_ROLES

public static final Map<String,String> NO_MAPPED_ROLES

Constructor Detail

ServletHolder

public ServletHolder()

Constructor .

ServletHolder

public ServletHolder(BaseHolder.Source creator)

Constructor .

ServletHolder

public ServletHolder(Servlet servlet)

Constructor for existing servlet.

ServletHolder

public ServletHolder(String name,
             Class<? extends Servlet> servlet)

Constructor for servlet class.

ServletHolder

public ServletHolder(String name,
             Servlet servlet)

Constructor for servlet class.

ServletHolder

public ServletHolder(Class<? extends Servlet> servlet)

Constructor for servlet class.

Method Detail

getUnavailableException

public UnavailableException getUnavailableException()

Returns:

The unavailable exception or null if not unavailable

setServlet

public void setServlet(Servlet servlet)

getInitOrder

@ManagedAttribute(value="initialization order",
                  readonly=true)
public int getInitOrder()

setInitOrder

public void setInitOrder(int order)

Set the initialize order. Holders with order<0, are initialized on use. Those with order>=0 are initialized in increasing order when the handler is started.

compareTo

public int compareTo(ServletHolder sh)

Comparitor by init order.

Specified by:

compareTo in interface Comparable<ServletHolder>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

setUserRoleLink

public void setUserRoleLink(String name,
                   String link)

Link a user role. Translate the role name used by a servlet, to the link name used by the container.

Parameters:

name - The role name as used by the servlet

link - The role name as used by the container.

getUserRoleLink

public String getUserRoleLink(String name)

get a user role link.

Parameters:

name - The name of the role

Returns:

The name as translated by the link. If no link exists, the name is returned.

getForcedPath

@ManagedAttribute(value="forced servlet path",
                  readonly=true)
public String getForcedPath()

Returns:

Returns the forcedPath.

setForcedPath

public void setForcedPath(String forcedPath)

Parameters:

forcedPath - The forcedPath to set.

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

doStart

public void doStart()
             throws Exception

Overrides:

doStart in class BaseHolder<Servlet>

Throws:

Exception

initialize

public void initialize()
                throws Exception

Description copied from class: BaseHolder

Do any setup necessary after starting

Overrides:

initialize in class BaseHolder<Servlet>

Throws:

Exception

doStop

public void doStop()
            throws Exception

Overrides:

doStop in class BaseHolder<Servlet>

Throws:

Exception

destroyInstance

public void destroyInstance(Object o)
                     throws Exception

Overrides:

destroyInstance in class Holder<Servlet>

Throws:

Exception

getServlet

public Servlet getServlet()
                   throws ServletException

Get the servlet.

Returns:

The servlet

Throws:

ServletException

getServletInstance

public Servlet getServletInstance()

Get the servlet instance (no initialization done).

Returns:

The servlet or null

checkServletType

public void checkServletType()
                      throws UnavailableException

Check to ensure class of servlet is acceptable.

Throws:

UnavailableException

isAvailable

public boolean isAvailable()

Returns:

true if the holder is started and is not unavailable

initJspServlet

protected void initJspServlet()
                       throws Exception

Throws:

Exception

initMultiPart

protected void initMultiPart()
                      throws Exception

Register a ServletRequestListener that will ensure tmp multipart files are deleted when the request goes out of scope.

Throws:

Exception

getContextPath

public String getContextPath()

Specified by:

getContextPath in interface UserIdentity.Scope

Returns:

The context path that the identity is being considered within

See Also:

UserIdentity.Scope.getContextPath()

getRoleRefMap

public Map<String,String> getRoleRefMap()

Specified by:

getRoleRefMap in interface UserIdentity.Scope

Returns:

A map of role reference names that converts from names used by application code to names used by the context deployment.

See Also:

UserIdentity.Scope.getRoleRefMap()

getRunAsRole

@ManagedAttribute(value="role to run servlet as",
                  readonly=true)
public String getRunAsRole()

setRunAsRole

public void setRunAsRole(String role)

prepare

protected void prepare(Request baseRequest,
           ServletRequest request,
           ServletResponse response)
                throws ServletException,
                       UnavailableException

Prepare to service a request.

Parameters:

baseRequest -

request -

response -

Throws:

ServletException

UnavailableException

handle

public void handle(Request baseRequest,
          ServletRequest request,
          ServletResponse response)
            throws ServletException,
                   UnavailableException,
                   IOException

Service a request with this servlet.

Parameters:

baseRequest -

request -

response -

Throws:

ServletException

UnavailableException

IOException

getRegistration

public ServletRegistration.Dynamic getRegistration()

newInstance

protected Servlet newInstance()
                       throws ServletException,
                              IllegalAccessException,
                              InstantiationException

Returns:

the newly created Servlet instance

Throws:

ServletException

IllegalAccessException

InstantiationException

toString

public String toString()

Overrides:

toString in class Holder<Servlet>