org.mortbay.jetty.servlet

Class ServletHolder

java.lang.Object

org.mortbay.component.AbstractLifeCycle

org.mortbay.jetty.servlet.Holder

org.mortbay.jetty.servlet.ServletHolder

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable, org.mortbay.component.LifeCycle

public class ServletHolder
extends Holder
implements java.lang.Comparable

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.

Author:

Greg Wilkins

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.mortbay.component.LifeCycle

org.mortbay.component.LifeCycle.Listener

Field Summary

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

_class, _className, _displayName, _extInstance, _initParams, _name, _servletHandler

Fields inherited from class org.mortbay.component.AbstractLifeCycle

_listeners

Constructor Summary

Constructors

Constructor and Description
ServletHolder() Constructor .
ServletHolder(java.lang.Class servlet) Constructor for existing servlet.
ServletHolder(Servlet servlet) Constructor for existing servlet.

Method Summary

Methods

Modifier and Type	Method and Description
void	checkServletType() Check to ensure class of servlet is acceptable.
int	compareTo(java.lang.Object o) Comparitor by init order.
void	destroyInstance(java.lang.Object o)
void	doStart()
void	doStop()
boolean	equals(java.lang.Object o)
java.lang.String	getForcedPath()
int	getInitOrder()
java.util.Map	getRoleMap()
java.lang.String	getRunAs()
Servlet	getServlet() Get the servlet.
Servlet	getServletInstance() Get the servlet instance (no initialization done).
UnavailableException	getUnavailableException()
java.lang.String	getUserRoleLink(java.lang.String name) get a user role link.
void	handle(ServletRequest request, ServletResponse response) Service a request with this servlet.
int	hashCode()
boolean	isAvailable()
void	setForcedPath(java.lang.String forcedPath)
void	setInitOrder(int order) Set the initialize order.
void	setRunAs(java.lang.String role)
void	setServlet(Servlet servlet)
void	setUserRoleLink(java.lang.String name, java.lang.String link) Link a user role.

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

getClassName, getDisplayName, getHeldClass, getInitParameter, getInitParameterNames, getInitParameters, getName, getServletHandler, newInstance, setClassName, setDisplayName, setHeldClass, setInitParameter, setInitParameters, setName, setServletHandler, toString

Methods inherited from class org.mortbay.component.AbstractLifeCycle

addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ServletHolder

public ServletHolder()

Constructor .

ServletHolder

public ServletHolder(Servlet servlet)

Constructor for existing servlet.

ServletHolder

public ServletHolder(java.lang.Class servlet)

Constructor for existing servlet.

Method Detail

getUnavailableException

public UnavailableException getUnavailableException()

Returns:

The unavailable exception or null if not unavailable

setServlet

public void setServlet(Servlet servlet)

getInitOrder

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(java.lang.Object o)

Comparitor by init order.

Specified by:

compareTo in interface java.lang.Comparable

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

setUserRoleLink

public void setUserRoleLink(java.lang.String name,
                   java.lang.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 java.lang.String getUserRoleLink(java.lang.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.

getRoleMap

public java.util.Map getRoleMap()

setRunAs

public void setRunAs(java.lang.String role)

Parameters:

role - Role name that is added to UserPrincipal when this servlet is called.

getRunAs

public java.lang.String getRunAs()

getForcedPath

public java.lang.String getForcedPath()

Returns:

Returns the forcedPath.

setForcedPath

public void setForcedPath(java.lang.String forcedPath)

Parameters:

forcedPath - The forcedPath to set.

doStart

public void doStart()
             throws java.lang.Exception

Overrides:

doStart in class Holder

Throws:

java.lang.Exception

doStop

public void doStop()

Overrides:

doStop in class Holder

destroyInstance

public void destroyInstance(java.lang.Object o)
                     throws java.lang.Exception

Overrides:

destroyInstance in class Holder

Throws:

java.lang.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

handle

public void handle(ServletRequest request,
          ServletResponse response)
            throws ServletException,
                   UnavailableException,
                   java.io.IOException

Service a request with this servlet.

Throws:

ServletException

UnavailableException

java.io.IOException