org.apache.tomcat.core
Class ServletWrapper

java.lang.Object
  |
  +--org.apache.tomcat.core.Handler
        |
        +--org.apache.tomcat.core.ServletWrapper

public class ServletWrapper

extends Handler

Class used to represent a servlet inside a Context.

Author:

James Duncan Davidson [duncan@eng.sun.com], Jason Hunter [jch@eng.sun.com], James Todd [gonzo@eng.sun.com], Harish Prabandham, costin@dnt.ro

Field Summary

protected javax.servlet.ServletConfig	configF
protected java.lang.String	description
protected boolean	isReloadable
protected long	lastAccessed
protected int	serviceCount
protected javax.servlet.Servlet	servlet
protected java.lang.Class	servletClass
protected java.lang.String	servletClassName
protected java.lang.String	servletName

Fields inherited from class org.apache.tomcat.core.Handler

ACC_ERRORS, ACC_IN_INCLUDE, ACC_INVOCATION_COUNT, ACC_LAST_ACCESSED, ACC_OVERHEAD, ACC_SERVICE_TIME, ACCOUNTS, context, contextM, debug, debugHead, initialized, internal, name, origin, ORIGIN_ADMIN, ORIGIN_DYNAMIC, ORIGIN_INVOKER, ORIGIN_JSP, ORIGIN_WEB_XML

Constructor Summary

ServletWrapper()

Method Summary

void	addSecurityMapping(java.lang.String name, java.lang.String role, java.lang.String description) Security Role Ref represent a mapping between servlet role names and server roles
protected void	doDestroy() This method will be called when the handler is removed ( by admin or timeout ).
protected void	doInit() Initialize the handler.
protected void	doService(Request req, Response res) This is the actual content generator.
boolean	getLoadOnStartUp()
int	getLoadOnStartUpLevel()
java.lang.String	getPath()
java.lang.String	getSecurityRole(java.lang.String name)
javax.servlet.Servlet	getServlet()
java.lang.String	getServletClass()
java.lang.String	getServletDescription()
java.lang.String	getServletName()
void	init() Override Handler's init - load the servlet before calling and interceptor
void	service(Request req, Response res) Override service to hook reloading - it can be done in a clean interceptor.
void	setContext(Context context)
void	setDescription(java.lang.String d)
void	setLoadOnStartUp(int level)
void	setLoadOnStartUp(java.lang.String level)
void	setPath(java.lang.String path)
void	setServletClass(java.lang.String servletClassName)
void	setServletDescription(java.lang.String description)
void	setServletName(java.lang.String servletName)
java.lang.String	toString()

Methods inherited from class org.apache.tomcat.core.Handler

addInitParam, destroy, getAccount, getContext, getInitParameter, getInitParameterNames, getName, getNote, getOrigin, isInternal, log, setAccount, setDebug, setName, setNote, setOrigin

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

servletName

protected java.lang.String servletName

servletClassName

protected java.lang.String servletClassName

servletClass

protected java.lang.Class servletClass

servlet

protected javax.servlet.Servlet servlet

configF

protected javax.servlet.ServletConfig configF

description

protected java.lang.String description

isReloadable

protected boolean isReloadable

lastAccessed

protected long lastAccessed

serviceCount

protected int serviceCount

Constructor Detail

ServletWrapper

public ServletWrapper()

Method Detail

setContext

public void setContext(Context context)

Overrides:

setContext in class Handler

toString

public java.lang.String toString()

Overrides:

toString in class Handler

setLoadOnStartUp

public void setLoadOnStartUp(int level)

setLoadOnStartUp

public void setLoadOnStartUp(java.lang.String level)

getLoadOnStartUp

public boolean getLoadOnStartUp()

getLoadOnStartUpLevel

public int getLoadOnStartUpLevel()

getServletName

public java.lang.String getServletName()

setServletName

public void setServletName(java.lang.String servletName)

getServletDescription

public java.lang.String getServletDescription()

setDescription

public void setDescription(java.lang.String d)

setServletDescription

public void setServletDescription(java.lang.String description)

getServletClass

public java.lang.String getServletClass()

setServletClass

public void setServletClass(java.lang.String servletClassName)

addSecurityMapping

public void addSecurityMapping(java.lang.String name,
                               java.lang.String role,
                               java.lang.String description)

Security Role Ref represent a mapping between servlet role names and server roles

getSecurityRole

public java.lang.String getSecurityRole(java.lang.String name)

getPath

public java.lang.String getPath()

setPath

public void setPath(java.lang.String path)

getServlet

public javax.servlet.Servlet getServlet()

doDestroy

protected void doDestroy()
                  throws TomcatException

Description copied from class: Handler

This method will be called when the handler is removed ( by admin or timeout ). Various handlers can implement this, but it can't be called from outside. ( the "guarded" doDestroy is public )

Overrides:

doDestroy in class Handler

init

public void init()
          throws java.lang.Exception

Override Handler's init - load the servlet before calling and interceptor

Overrides:

init in class Handler

doInit

protected void doInit()
               throws java.lang.Exception

Description copied from class: Handler

Initialize the handler. Handler can override this method to initialize themself. The method must set initialised=true if successfull.

Overrides:

doInit in class Handler

service

public void service(Request req,
                    Response res)

Override service to hook reloading - it can be done in a clean interceptor. It also hooks jsp - we should have a separate JspHandler

Overrides:

service in class Handler

doService

protected void doService(Request req,
                         Response res)
                  throws java.lang.Exception

Description copied from class: Handler

This is the actual content generator. Can't be called from outside.

Overrides:

doService in class Handler