org.mortbay.jetty.servlet
Class ServletHolder

java.lang.Object
  |
  +--java.util.AbstractMap
        |
        +--org.mortbay.jetty.servlet.ServletHolder
All Implemented Interfaces:
java.lang.Comparable, java.util.Map

public class ServletHolder
extends java.util.AbstractMap
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.

Version:
$Id: ServletHolder.java,v 1.1 2001/09/02 01:13:08 gregwilkins Exp $
Author:
Greg Wilkins
See Also:
org.mortbay.jetty.ServletHandler

Inner classes inherited from class java.util.Map
java.util.Map.Entry
 
Constructor Summary
ServletHolder(ServletHandler handler, java.lang.String className)
          Construct a Servlet property mostly from the servers config.
ServletHolder(ServletHandler handler, java.lang.String className, java.lang.String path)
          Constructor.
 
Method Summary
 int compareTo(java.lang.Object o)
          Comparitor by init order.
 void destroy()
          Destroy.
 java.util.Set entrySet()
          Map method.
 boolean equals(java.lang.Object o)
           
 java.lang.String getClassName()
           
 int getInitOrder()
           
 java.lang.String getInitParameter(java.lang.String param)
          Gets an initialization parameter of the servlet.
 java.util.Enumeration getInitParameterNames()
           
 Servlet getServlet()
          Get the servlet.
 ServletContext getServletContext()
           
 java.lang.String getServletName()
           
 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.
 void initialize()
           
 boolean isInitOnStartup()
          Deprecated. Use getInitOrder()
 java.lang.Object put(java.lang.Object name, java.lang.Object value)
          Map method.
 void setClassName(java.lang.String className)
           
 void setInitOnStartup(boolean b)
          Deprecated. Use setInitOrder(int)
 void setInitOrder(int order)
          Set the initialize order.
 void setInitParameter(java.lang.String param, java.lang.String value)
           
 void setServletName(java.lang.String name)
           
 void setUserRoleLink(java.lang.String name, java.lang.String link)
          Link a user role.
 java.lang.String toString()
          Get the name of the Servlet.
 
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, get, hashCode, isEmpty, keySet, putAll, remove, size, values
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ServletHolder

public ServletHolder(ServletHandler handler,
                     java.lang.String className)
Construct a Servlet property mostly from the servers config. file.
Parameters:
handler - ServletHandler
className - Servlet class name (fully qualified)

ServletHolder

public ServletHolder(ServletHandler handler,
                     java.lang.String className,
                     java.lang.String path)
Constructor.
Parameters:
handler -  
className -  
pathName -  
Method Detail

getServletName

public java.lang.String getServletName()

setServletName

public void setServletName(java.lang.String name)

getClassName

public java.lang.String getClassName()

setClassName

public void setClassName(java.lang.String className)

isInitOnStartup

public boolean isInitOnStartup()
Deprecated. Use getInitOrder()


setInitOnStartup

public void setInitOnStartup(boolean b)
Deprecated. Use setInitOrder(int)


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.util.AbstractMap

initialize

public void initialize()

destroy

public void destroy()
Destroy.

getServlet

public Servlet getServlet()
                   throws UnavailableException
Get the servlet. The state of the servlet is unknown, specially if using SingleThreadModel
Returns:
The servlet

getServletContext

public ServletContext getServletContext()

setInitParameter

public void setInitParameter(java.lang.String param,
                             java.lang.String value)

getInitParameter

public java.lang.String getInitParameter(java.lang.String param)
Gets an initialization parameter of the servlet.
Parameters:
name - the parameter name

getInitParameterNames

public java.util.Enumeration getInitParameterNames()

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.

handle

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

entrySet

public java.util.Set entrySet()
Map method. ServletHolder implements the Map interface as a configuration conveniance. The methods are mapped to the servlet properties.
Overrides:
entrySet in class java.util.AbstractMap
Returns:
The entrySet of the initParameter map

put

public java.lang.Object put(java.lang.Object name,
                            java.lang.Object value)
Map method. ServletHolder implements the Map interface as a configuration conveniance. The methods are mapped to the servlet properties.
Overrides:
put in class java.util.AbstractMap

toString

public java.lang.String toString()
Get the name of the Servlet.
Overrides:
toString in class java.util.AbstractMap
Returns:
Servlet name


Copyright © 2000 Mortbay Consulting Pty. Ltd. All Rights Reserved.