Modifier and Type	Class and Description
pack-priv class	ServletHolder.Config
private class	ServletHolder.SingleThreadedWrapper

Modifier and Type	Field and Description
private transient ServletHolder.Config	_config
private String	_forcedPath
private boolean	_initOnStartup
private int	_initOrder
private UserRealm	_realm
private Map<K, V>	_roleMap
private String	_runAs
private transient Servlet	_servlet
private transient long	_unavailable
private transient UnavailableException	_unavailableEx

Access	Constructor and Description
public	ServletHolder() Constructor .
public	ServletHolder(Servlet servlet) Constructor for existing servlet.
public	ServletHolder(Class<T> servlet) Constructor for existing servlet.

Method Summary

Modifier and Type	Method and Description
public void	checkServletType() Check to ensure class of servlet is acceptable.
public int	compareTo(Object the object to be compared. o) Implements java.lang.Comparable.compareTo. Comparitor by init order.
public void	destroyInstance(Object o) Overrides org.mortbay.jetty.servlet.Holder.destroyInstance.
public void	doStart() Overrides org.mortbay.jetty.servlet.Holder.doStart.
public void	doStop() Overrides org.mortbay.jetty.servlet.Holder.doStop.
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	Returns: Returns the forcedPath. getForcedPath()
public int	getInitOrder()
public Map<K, V>	getRoleMap()
public String	getRunAs()
public synchronized Servlet	Returns: The servlet getServlet() Get the servlet.
public UnavailableException	Returns: The unavailable exception or null if not unavailable getUnavailableException()
public String	Returns: The name as translated by the link. If no link exists, the name is returned. getUserRoleLink(String The name of the role name) get a user role link.
public void	handle(ServletRequest request, ServletResponse response) Service a request with this servlet.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
private void	initServlet()
public boolean	Returns: true if the holder is started and is not unavailable isAvailable()
private void	makeUnavailable(UnavailableException e)
private void	makeUnavailable(Throwable e)
public void	setForcedPath(String The forcedPath to set. forcedPath)
public void	setInitOrder(int order) Set the initialize order.
public void	setRunAs(String Role name that is added to UserPrincipal when this servlet is called. role)
public synchronized void	setServlet(Servlet servlet)
public synchronized void	setUserRoleLink(String The role name as used by the servlet name, String The role name as used by the container. link) Link a user role.

Inherited from org.mortbay.jetty.servlet.Holder:: getClassName getDisplayName getHeldClass getInitParameter getInitParameterNames getInitParameters getName getServletHandler newInstance setClassName setDisplayName setHeldClass setInitParameter setInitParameters setName setServletHandler toString

Field Detail

_config	back to summary
private transient ServletHolder.Config _config

_forcedPath	back to summary
private String _forcedPath

_initOnStartup	back to summary
private boolean _initOnStartup

_initOrder	back to summary
private int _initOrder

_realm	back to summary
private UserRealm _realm

_roleMap	back to summary
private Map<K, V> _roleMap

_runAs	back to summary
private String _runAs

_servlet	back to summary
private transient Servlet _servlet

_unavailable	back to summary
private transient long _unavailable

_unavailableEx	back to summary
private transient UnavailableException _unavailableEx

Constructor Detail

ServletHolder	back to summary
public ServletHolder() Constructor .

ServletHolder	back to summary
public ServletHolder(Servlet servlet) Constructor for existing servlet.

ServletHolder	back to summary
public ServletHolder(Class<T> servlet) Constructor for existing servlet.

Method Detail

checkServletType	back to summary
public void checkServletType() throws UnavailableException Check to ensure class of servlet is acceptable.

compareTo	back to summary
public int compareTo(Object o) Implements java.lang.Comparable.compareTo. Comparitor by init order. Parameters o:Object Doc from java.lang.Comparable.compareTo. the object to be compared. Returns:int Doc from java.lang.Comparable.compareTo. a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

compareTo

back to summary

public int compareTo(Object o)

Implements java.lang.Comparable.compareTo.

Comparitor by init order.

Parameters

o:Object

Doc from java.lang.Comparable.compareTo.

the object to be compared.

Returns:int

Doc from java.lang.Comparable.compareTo.

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

destroyInstance	back to summary
public void destroyInstance(Object o) throws Exception Overrides org.mortbay.jetty.servlet.Holder.destroyInstance.

doStart	back to summary
public void doStart() throws Exception Overrides org.mortbay.jetty.servlet.Holder.doStart.

doStop	back to summary
public void doStop() Overrides org.mortbay.jetty.servlet.Holder.doStop.

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise.

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

getForcedPath	back to summary
public String getForcedPath() Returns:String Returns the forcedPath.

getInitOrder	back to summary
public int getInitOrder()

getRoleMap	back to summary
public Map<K, V> getRoleMap()

getRunAs	back to summary
public String getRunAs()

getServlet	back to summary
public synchronized Servlet getServlet() throws ServletException Get the servlet. Returns:Servlet The servlet

getServlet

back to summary

public synchronized Servlet getServlet() throws ServletException

Get the servlet.

Returns:Servlet: The servlet

getUnavailableException	back to summary
public UnavailableException getUnavailableException() Returns:UnavailableException The unavailable exception or null if not unavailable

getUserRoleLink	back to summary
public String getUserRoleLink(String name) get a user role link. Parameters name:String The name of the role Returns:String The name as translated by the link. If no link exists, the name is returned.

getUserRoleLink

back to summary

public String getUserRoleLink(String name)

get a user role link.

Parameters

name:String: The name of the role

Returns:String

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

handle	back to summary
public void handle(ServletRequest request, ServletResponse response) throws ServletException, UnavailableException, IOException Service a request with this servlet.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int: a hash code value for this object

initServlet	back to summary
private void initServlet() throws ServletException

isAvailable	back to summary
public boolean isAvailable() Returns:boolean true if the holder is started and is not unavailable

makeUnavailable	back to summary
private void makeUnavailable(UnavailableException e)

makeUnavailable	back to summary
private void makeUnavailable(Throwable e)

setForcedPath	back to summary
public void setForcedPath(String forcedPath) Parameters forcedPath:String The forcedPath to set.

setInitOrder	back to summary
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.

setRunAs	back to summary
public void setRunAs(String role) Parameters role:String Role name that is added to UserPrincipal when this servlet is called.

setServlet	back to summary
public synchronized void setServlet(Servlet servlet)

setUserRoleLink	back to summary
public synchronized 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:String The role name as used by the servlet link:String The role name as used by the container.

setUserRoleLink

back to summary

public synchronized 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:String: The role name as used by the servlet
link:String: The role name as used by the container.

org.mortbay.jetty.servlet back to summary

pack-priv Class ServletHolder.Config

Class Inheritance

extends Object
implements ServletConfig

java.lang.Object
org.mortbay.jetty.servlet.ServletHolder.Config

All Implemented Interfaces

javax.servlet.ServletConfig

Constructor Summary

Access	Constructor and Description
pack-priv	Config()

Method Summary

Modifier and Type	Method and Description
public String	getInitParameter(String the name of the initialization parameter whose value to get param) Implements javax.servlet.ServletConfig.getInitParameter. Gets the value of the initialization parameter with the given name.
public Enumeration<E>	getInitParameterNames() Implements javax.servlet.ServletConfig.getInitParameterNames. Returns the names of the servlet's initialization parameters as an `Enumeration` of `String` objects, or an empty `Enumeration` if the servlet has no initialization parameters.
public ServletContext	getServletContext() Implements javax.servlet.ServletConfig.getServletContext. Returns a reference to the `ServletContext` in which the caller is executing.
public String	getServletName() Implements javax.servlet.ServletConfig.getServletName. Returns the name of this servlet instance.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

Config	back to summary
pack-priv Config()

Method Detail

getInitParameter back to summary

getInitParameter	back to summary
public String getInitParameter(String param) Implements javax.servlet.ServletConfig.getInitParameter. Doc from javax.servlet.ServletConfig.getInitParameter. Gets the value of the initialization parameter with the given name. Parameters param:String the name of the initialization parameter whose value to get Returns:String a `String` containing the value of the initialization parameter, or `null` if the initialization parameter does not exist

public String getInitParameter(String param)

Implements javax.servlet.ServletConfig.getInitParameter.

Doc from javax.servlet.ServletConfig.getInitParameter.

Gets the value of the initialization parameter with the given name.

Parameters

param:String: the name of the initialization parameter whose value to get

Returns:String

a String containing the value of the initialization parameter, or null if the initialization parameter does not exist

getInitParameterNames back to summary

getInitParameterNames	back to summary
public Enumeration<E> getInitParameterNames() Implements javax.servlet.ServletConfig.getInitParameterNames. Doc from javax.servlet.ServletConfig.getInitParameterNames. Returns the names of the servlet's initialization parameters as an `Enumeration` of `String` objects, or an empty `Enumeration` if the servlet has no initialization parameters. Returns:Enumeration<E> an `Enumeration` of `String` objects containing the names of the servlet's initialization parameters

public Enumeration<E> getInitParameterNames()

Implements javax.servlet.ServletConfig.getInitParameterNames.

Doc from javax.servlet.ServletConfig.getInitParameterNames.

Returns the names of the servlet's initialization parameters as an Enumeration of String objects, or an empty Enumeration if the servlet has no initialization parameters.

Returns:Enumeration<E>: an Enumeration of String objects containing the names of the servlet's initialization parameters

getServletContext back to summary

getServletContext	back to summary
public ServletContext getServletContext() Implements javax.servlet.ServletConfig.getServletContext. Doc from javax.servlet.ServletConfig.getServletContext. Returns a reference to the `ServletContext` in which the caller is executing. Returns:ServletContext a `ServletContext` object, used by the caller to interact with its servlet container

public ServletContext getServletContext()

Implements javax.servlet.ServletConfig.getServletContext.

Doc from javax.servlet.ServletConfig.getServletContext.

Returns a reference to the ServletContext in which the caller is executing.

Returns:ServletContext: a ServletContext object, used by the caller to interact with its servlet container

getServletName	back to summary
public String getServletName() Implements javax.servlet.ServletConfig.getServletName. Doc from javax.servlet.ServletConfig.getServletName. Returns the name of this servlet instance. The name may be provided via server administration, assigned in the web application deployment descriptor, or for an unregistered (and thus unnamed) servlet instance it will be the servlet's class name. Returns:String the name of the servlet instance

getServletName

back to summary

public String getServletName()

Implements javax.servlet.ServletConfig.getServletName.

Doc from javax.servlet.ServletConfig.getServletName.

Returns the name of this servlet instance. The name may be provided via server administration, assigned in the web application deployment descriptor, or for an unregistered (and thus unnamed) servlet instance it will be the servlet's class name.

Returns:String: the name of the servlet instance

org.mortbay.jetty.servlet back to summary

private Class ServletHolder.SingleThreadedWrapper

Class Inheritance

extends Object
implements Servlet

java.lang.Object
org.mortbay.jetty.servlet.ServletHolder.SingleThreadedWrapper

All Implemented Interfaces

javax.servlet.Servlet

Field Summary

Modifier and Type	Field and Description
pack-priv Stack<E>	_stack

Constructor Summary

Access	Constructor and Description
private	SingleThreadedWrapper()

Method Summary

Modifier and Type	Method and Description
public void	destroy() Implements javax.servlet.Servlet.destroy. Called by the servlet container to indicate to a servlet that the servlet is being taken out of service.
public ServletConfig	getServletConfig() Implements javax.servlet.Servlet.getServletConfig. Returns a `ServletConfig` object, which contains initialization and startup parameters for this servlet.
public String	getServletInfo() Implements javax.servlet.Servlet.getServletInfo. Returns information about the servlet, such as author, version, and copyright.
public void	init(ServletConfig a `ServletConfig` object containing the servlet's configuration and initialization parameters config) Implements javax.servlet.Servlet.init. Called by the servlet container to indicate to a servlet that the servlet is being placed into service.
public void	service(ServletRequest the `ServletRequest` object that contains the client's request req, ServletResponse the `ServletResponse` object that contains the servlet's response res) Implements javax.servlet.Servlet.service. Called by the servlet container to allow the servlet to respond to a request.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_stack	back to summary
pack-priv Stack<E> _stack

Constructor Detail

SingleThreadedWrapper	back to summary
private SingleThreadedWrapper()

Method Detail

destroy back to summary

public void destroy()

Implements javax.servlet.Servlet.destroy.

Doc from javax.servlet.Servlet.destroy.

Called by the servlet container to indicate to a servlet that the servlet is being taken out of service. This method is only called once all threads within the servlet's service method have exited or after a timeout period has passed. After the servlet container calls this method, it will not call the service method again on this servlet.

This method gives the servlet an opportunity to clean up any resources that are being held (for example, memory, file handles, threads) and make sure that any persistent state is synchronized with the servlet's current state in memory.

getServletConfig back to summary

public ServletConfig getServletConfig()

Implements javax.servlet.Servlet.getServletConfig.

Doc from javax.servlet.Servlet.getServletConfig.

Returns a ServletConfig object, which contains initialization and startup parameters for this servlet. The ServletConfig object returned is the one passed to the init method.

Implementations of this interface are responsible for storing the ServletConfig object so that this method can return it. The GenericServlet class, which implements this interface, already does this.

Returns:ServletConfig: the ServletConfig object that initializes this servlet

getServletInfo back to summary

public String getServletInfo()

Implements javax.servlet.Servlet.getServletInfo.

Doc from javax.servlet.Servlet.getServletInfo.

Returns information about the servlet, such as author, version, and copyright.

The string that this method returns should be plain text and not markup of any kind (such as HTML, XML, etc.).

Returns:String: a String containing servlet information

init back to summary

public void init(ServletConfig config) throws ServletException

Implements javax.servlet.Servlet.init.

Doc from javax.servlet.Servlet.init.

Called by the servlet container to indicate to a servlet that the servlet is being placed into service.

The servlet container calls the init method exactly once after instantiating the servlet. The init method must complete successfully before the servlet can receive any requests.

The servlet container cannot place the servlet into service if the init method

Throws a ServletException
Does not return within a time period defined by the Web server

Parameters

config:ServletConfig: a ServletConfig object containing the servlet's configuration and initialization parameters

Exceptions

ServletException:: if an exception has occurred that interferes with the servlet's normal operation

service back to summary

public void service(ServletRequest req, ServletResponse res) throws ServletException, IOException

Implements javax.servlet.Servlet.service.

Doc from javax.servlet.Servlet.service.

Called by the servlet container to allow the servlet to respond to a request.

This method is only called after the servlet's init() method has completed successfully.

The status code of the response always should be set for a servlet that throws or sends an error.

Servlets typically run inside multithreaded servlet containers that can handle multiple requests concurrently. Developers must be aware to synchronize access to any shared resources such as files, network connections, and as well as the servlet's class and instance variables. More information on multithreaded programming in Java is available in the Java tutorial on multi-threaded programming.

Parameters

req:ServletRequest: the ServletRequest object that contains the client's request
res:ServletResponse: the ServletResponse object that contains the servlet's response

Exceptions

ServletException:: if an exception occurs that interferes with the servlet's normal operation
IOException:: if an input or output exception occurs

public Class ServletHolder

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class ServletHolder.Config

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class ServletHolder.SingleThreadedWrapper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail