org.apache.cocoon.servletservice
Class CallStackHelper

java.lang.Object
  extended byorg.apache.cocoon.servletservice.CallStackHelper

public class CallStackHelper
extends Object

Helper class used for geting hold on the current servlet service

Since:
2.2
Version:
$Id: CallStackHelper.java 504299 2007-02-06 21:27:51Z danielf $

Field Summary
static String SUPER_CALL
          Key for a value determing wether a call frame contains a super call or not
 
Constructor Summary
CallStackHelper()
           
 
Method Summary
static void enterServlet(ServletContext context)
          This hook must be called each time a servlet service is entered.
static void enterSuperServlet(ServletContext context)
          This hook must be called each time a super servlet service is entered.
static ServletContext getBaseServletContext()
          Use this method for getting the context that should be used for resolving a polymorphic servlet protocol call
static ServletContext getCurrentServletContext()
          Use this method for getting the context that should be used for resolving a servlet protocol call to a super servlet service
static void leaveServlet()
          This hook must be called each time a servlet service is left.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SUPER_CALL

public static final String SUPER_CALL
Key for a value determing wether a call frame contains a super call or not

See Also:
Constant Field Values
Constructor Detail

CallStackHelper

public CallStackHelper()
Method Detail

enterServlet

public static void enterServlet(ServletContext context)
                         throws ServletException
This hook must be called each time a servlet service is entered.

This method should never raise an exception, except when the parameters are not set!

Throws:
ServletException - if block is null

enterSuperServlet

public static void enterSuperServlet(ServletContext context)
                              throws ServletException
This hook must be called each time a super servlet service is entered.

This method should never raise an exception, except when the parameters are not set!

Throws:
ServletException - if the context is null

leaveServlet

public static void leaveServlet()
This hook must be called each time a servlet service is left.

It's the counterpart to the enterServlet(ServletContext) method.


getBaseServletContext

public static ServletContext getBaseServletContext()
Use this method for getting the context that should be used for resolving a polymorphic servlet protocol call

Returns:
a servlet context

getCurrentServletContext

public static ServletContext getCurrentServletContext()
Use this method for getting the context that should be used for resolving a servlet protocol call to a super servlet service

Returns:
a servlet context


Copyright © 1999-2007 The Apache Software Foundation. All Rights Reserved.