com.arsdigita.kernel
Class KernelDispatcherServlet

java.lang.Object
  extended byjavax.servlet.GenericServlet
      extended byjavax.servlet.http.HttpServlet
          extended bycom.arsdigita.dispatcher.BaseDispatcherServlet
              extended bycom.arsdigita.kernel.KernelDispatcherServlet
All Implemented Interfaces:
Dispatcher, com.arsdigita.dispatcher.DispatcherConstants, Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig
Direct Known Subclasses:
SiteNodeDispatcher

public abstract class KernelDispatcherServlet
extends BaseDispatcherServlet

Extends BaseDispatcherServlet to include functionality for user authentication, which is part of Kernel. Any ACS entry point that needs to authenticate the currently logged-in user should extend this class.

See Also:
Serialized Form

Field Summary
static String versionId
           
 
Fields inherited from class com.arsdigita.dispatcher.BaseDispatcherServlet
DISPATCHER_PREFIX_ATTR, ERROR_REQUEST_ATTRIBUTE, INCLUDE_URI, JSP_EXCEPTION_ATTRIBUTE, ORIGINAL_REQUEST_ATTR, REDIRECT_SEMAPHORE, REENTRANCE_ATTRIBUTE, REQUEST_CONTEXT_ATTR, WELCOME_FILES, WRAPPED_REQUEST_ATTR
 
Constructor Summary
KernelDispatcherServlet()
           
 
Method Summary
protected  RequestContext authenticateUser(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, RequestContext ctx)
          A placeholder method for performing user authentication during request processing.
 void init()
          Reads web.xml to get the configured list of welcome files.
 
Methods inherited from class com.arsdigita.dispatcher.BaseDispatcherServlet
addRequestListener, fireFinishedListener, fireStartListener, service
 
Methods inherited from class javax.servlet.http.HttpServlet
doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service
 
Methods inherited from class javax.servlet.GenericServlet
destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.arsdigita.dispatcher.Dispatcher
dispatch
 

Field Detail

versionId

public static final String versionId
See Also:
Constant Field Values
Constructor Detail

KernelDispatcherServlet

public KernelDispatcherServlet()
Method Detail

init

public void init()
          throws javax.servlet.ServletException
Description copied from class: BaseDispatcherServlet
Reads web.xml to get the configured list of welcome files. We have to read web.xml ourselves because there is no public API to get this information from the ServletContext.

Overrides:
init in class BaseDispatcherServlet
Throws:
javax.servlet.ServletException

authenticateUser

protected RequestContext authenticateUser(javax.servlet.http.HttpServletRequest req,
                                          javax.servlet.http.HttpServletResponse res,
                                          RequestContext ctx)
                                   throws RedirectException
Description copied from class: BaseDispatcherServlet
A placeholder method for performing user authentication during request processing. Subclasses should override this method.

Specified by:
authenticateUser in class BaseDispatcherServlet
Parameters:
req - the current servlet request object
Returns:
the updated request context (which may be the same as the context context parameter).
Throws:
RedirectException - if the dispatcher should redirect the client to the page contained in the exception


Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 20 2004:2337 UTC