Package org.apache.catalina.valves

Class RequestDumperValve

java.lang.Object

org.apache.catalina.valves.ValveBase

org.apache.catalina.valves.RequestDumperValve

All Implemented Interfaces:

Contained, Lifecycle, Valve, GlassFishValve

public class RequestDumperValve
extends ValveBase

Implementation of a Valve that logs interesting contents from the specified Request (before processing) and the corresponding Response (after processing). It is especially useful in debugging problems related to headers and cookies.

This Valve may be attached to any Container, depending on the granularity of the logging you wish to perform.

Version:

$Revision: 1.3 $ $Date: 2005/12/08 01:28:25 $

Author:

Craig R. McClanahan

Field Summary

Fields inherited from class org.apache.catalina.valves.ValveBase

container, controller, debug, domain, lifecycle, log, next, oname, rb, started

Fields inherited from interface org.glassfish.web.valve.GlassFishValve

END_PIPELINE, INVOKE_NEXT

Fields inherited from interface org.apache.catalina.Lifecycle

AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, INIT_EVENT, START_EVENT, STOP_EVENT

Constructor Summary

Constructors

Constructor	Description
RequestDumperValve()

Method Summary

Modifier and Type	Method	Description
String	getInfo()	Return descriptive information about this Valve implementation.
int	invoke(Request request, Response response)	Log the interesting request parameters, invoke the next Valve in the sequence, and log the interesting response parameters.
protected void	log(String message)	Log a message on the Logger associated with our Container (if any).
protected void	log(String message, Throwable t)	Log a message on the Logger associated with our Container (if any).
void	postInvoke(Request request, Response response)	Log the interesting response parameters.
String	toString()	Return a String rendering of this object.

Methods inherited from class org.apache.catalina.valves.ValveBase

addLifecycleListener, backgroundProcess, createObjectName, event, findLifecycleListeners, getContainer, getController, getDebug, getDomain, getNext, getObjectName, getParentName, invoke, isStarted, removeLifecycleListener, setContainer, setController, setDebug, setNext, setObjectName, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestDumperValve

public RequestDumperValve()

Method Detail

getInfo

public String getInfo()

Return descriptive information about this Valve implementation.

Specified by:

getInfo in interface GlassFishValve

Specified by:

getInfo in interface Valve

Overrides:

getInfo in class ValveBase

invoke

public int invoke(Request request,
                  Response response)
           throws IOException,
                  jakarta.servlet.ServletException

Log the interesting request parameters, invoke the next Valve in the sequence, and log the interesting response parameters.

Specified by:

invoke in interface GlassFishValve

Specified by:

invoke in class ValveBase

Parameters:

request - The servlet request to be processed

response - The servlet response to be created

Returns:

INVOKE_NEXT or END_PIPELINE

Throws:

IOException - if an input/output error occurs

jakarta.servlet.ServletException - if a servlet error occurs

postInvoke

public void postInvoke(Request request,
                       Response response)
                throws IOException,
                       jakarta.servlet.ServletException

Log the interesting response parameters.

Specified by:

postInvoke in interface GlassFishValve

Overrides:

postInvoke in class ValveBase

Parameters:

request - The servlet request to be processed

response - The servlet response to be created

Throws:

IOException - if an input/output error occurs

jakarta.servlet.ServletException - if a servlet error occurs

toString

public String toString()

Return a String rendering of this object.

Overrides:

toString in class Object

log

protected void log(String message)

Log a message on the Logger associated with our Container (if any).

Parameters:

message - Message to be logged

log

protected void log(String message,
                   Throwable t)

Log a message on the Logger associated with our Container (if any).

Parameters:

message - Message to be logged

t - Associated exception