org.mortbay.jetty.servlet

Class ServletHolder

public class ServletHolder extends Holder implements 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.

Version: $Id: ServletHolder.java,v 1.53 2005/11/03 08:52:48 gregwilkins Exp $

Author: Greg Wilkins

Constructor Summary
ServletHolder()
Constructor for Serialization.
ServletHolder(ServletHandler handler, String name, String className)
Constructor.
ServletHolder(ServletHandler handler, String name, String className, String forcedPath)
Constructor.
Method Summary
intcompareTo(Object o)
Comparitor by init order.
booleanequals(Object o)
intgetInitOrder()
StringgetRunAs()
ServletgetServlet()
Get the servlet.
ServletContextgetServletContext()
StringgetUserRoleLink(String name)
get a user role link.
voidhandle(ServletRequest request, ServletResponse response)
Service a request with this servlet.
inthashCode()
voidsetInitOrder(int order)
Set the initialize order.
voidsetRunAs(String role)
voidsetUserRoleLink(String name, String link)
Link a user role.
voidstart()
voidstop()

Constructor Detail

ServletHolder

public ServletHolder()
Constructor for Serialization.

ServletHolder

public ServletHolder(ServletHandler handler, String name, String className)
Constructor.

Parameters: handler The ServletHandler instance for this servlet. name The name of the servlet. className The class name of the servlet.

ServletHolder

public ServletHolder(ServletHandler handler, String name, String className, String forcedPath)
Constructor.

Parameters: handler The ServletHandler instance for this servlet. name The name of the servlet. className The class name of the servlet. forcedPath If non null, the request attribute javax.servlet.include.servlet_path will be set to this path before service is called.

Method Detail

compareTo

public int compareTo(Object o)
Comparitor by init order.

equals

public boolean equals(Object o)

getInitOrder

public int getInitOrder()

getRunAs

public String getRunAs()

getServlet

public Servlet getServlet()
Get the servlet.

Returns: The servlet

getServletContext

public ServletContext getServletContext()

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.

handle

public void handle(ServletRequest request, ServletResponse response)
Service a request with this servlet.

hashCode

public int hashCode()

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.

setRunAs

public void setRunAs(String role)

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

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.

start

public void start()

stop

public void stop()
Copyright © 2004 Mortbay Consulting Pty. Ltd. All Rights Reserved.