com.arsdigita.dispatcher
Class RequestEvent

java.lang.Object
  extended bycom.arsdigita.dispatcher.RequestEvent

public class RequestEvent
extends Object

Request event class. Passed as a parameter to the methods of RequestListener.

Since:
4.5
Version:
$Revision: #9 $ $Date: 2004/04/07 $
Author:
Bill Schneider
See Also:
RequestListener

Field Summary
static String versionId
           
 
Constructor Summary
RequestEvent(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, RequestContext ctx, boolean start)
          Creates a new RequestEvent with no status code.
RequestEvent(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, RequestContext ctx, boolean start, boolean finishedNormal)
          Creates a new RequestEvent with a success/failure status code.
 
Method Summary
 boolean finishedNormal()
          Returns a status code to indicate whether the request finished without error.
 javax.servlet.http.HttpServletRequest getRequest()
          Returns the current request for the request event.
 RequestContext getRequestContext()
          Returns the current request context for the request event.
 javax.servlet.http.HttpServletResponse getResponse()
          Returns the current response for the request event.
 boolean isStart()
          Returns true if the event is a start-request event; false for an end-request event.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

versionId

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

RequestEvent

public RequestEvent(javax.servlet.http.HttpServletRequest req,
                    javax.servlet.http.HttpServletResponse resp,
                    RequestContext ctx,
                    boolean start,
                    boolean finishedNormal)
Creates a new RequestEvent with a success/failure status code.

Parameters:
req - the current request
resp - the current response
ctx - the current request context
start - if true, indicates that this is a start-request event; if false, this is an end-request event.
finishedNormal - if true, indicates the request finished without error.

RequestEvent

public RequestEvent(javax.servlet.http.HttpServletRequest req,
                    javax.servlet.http.HttpServletResponse resp,
                    RequestContext ctx,
                    boolean start)
Creates a new RequestEvent with no status code.

Parameters:
req - the current request
resp - the current response
ctx - the current request context
start - if true, indicates that this is a start-request event; if false, this is an end-request event.
Method Detail

getRequest

public javax.servlet.http.HttpServletRequest getRequest()
Returns the current request for the request event.

Returns:
the current request

getResponse

public javax.servlet.http.HttpServletResponse getResponse()
Returns the current response for the request event.

Returns:
the current response

getRequestContext

public RequestContext getRequestContext()
Returns the current request context for the request event.

Returns:
the current request context

isStart

public boolean isStart()
Returns true if the event is a start-request event; false for an end-request event.

Returns:
true if we're starting a request, false at end.

finishedNormal

public boolean finishedNormal()
Returns a status code to indicate whether the request finished without error.

Returns:
true if the request finished without exception. false if the request finished with an error, or if the request event is a start-request.


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