KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > tigris > scarab > pipeline > TimingInfoValve


1 package org.tigris.scarab.pipeline;
2
3 /* ================================================================
4  * Copyright (c) 2001 Collab.Net. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are
8  * met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in the
15  * documentation and/or other materials provided with the distribution.
16  *
17  * 3. The end-user documentation included with the redistribution, if
18  * any, must include the following acknowlegement: "This product includes
19  * software developed by Collab.Net <http://www.Collab.Net/>."
20  * Alternately, this acknowlegement may appear in the software itself, if
21  * and wherever such third-party acknowlegements normally appear.
22  *
23  * 4. The hosted project names must not be used to endorse or promote
24  * products derived from this software without prior written
25  * permission. For written permission, please contact info@collab.net.
26  *
27  * 5. Products derived from this software may not use the "Tigris" or
28  * "Scarab" names nor may "Tigris" or "Scarab" appear in their names without
29  * prior written permission of Collab.Net.
30  *
31  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
32  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
33  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
34  * IN NO EVENT SHALL COLLAB.NET OR ITS CONTRIBUTORS BE LIABLE FOR ANY
35  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
37  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
38  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
39  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
40  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42  *
43  * ====================================================================
44  *
45  * This software consists of voluntary contributions made by many
46  * individuals on behalf of Collab.Net.
47  */
48
49 import java.io.IOException JavaDoc;
50
51 import org.apache.log4j.Logger;
52 import org.apache.turbine.RunData;
53 import org.apache.turbine.TurbineException;
54 import org.apache.turbine.ValveContext;
55 import org.apache.turbine.modules.Module;
56 import org.apache.turbine.pipeline.AbstractValve;
57 import org.tigris.scarab.tools.ScarabRequestTool;
58
59 /**
60  * This valve stores the system time in the request object on first invocation
61  * and reports the elapsed time on later invocations. It generally would be
62  * set as the first and last valve in a pipeline. This valve also sets a
63  * large response buffer, so that timing results are those of the server.
64  * This will actually make the system appear slower to clients so it should
65  * not be used in a production system. You need to compile this valve
66  * with DEBUG=true for it to be functional.
67  *
68  * @author <a HREF="mailto:jmcnally@collab.net">John McNally</a>
69  * @version $Id: TimingInfoValve.java 9255 2004-11-14 21:07:04Z dep4b $
70  */
71 public class TimingInfoValve
72     extends AbstractValve
73 {
74     private static final Logger LOG =
75         Logger.getLogger(TimingInfoValve.class);
76         
77     private static String JavaDoc KEY;
78
79     private static final boolean DEBUG = false;
80     
81     public void initialize() throws Exception JavaDoc{
82         super.initialize();
83         KEY = TimingInfoValve.class.getName() + ".start";
84
85     }
86
87     /**
88      * @see org.apache.turbine.Valve#invoke(RunData, ValveContext)
89      */
90     public void invoke(RunData data, ValveContext context)
91         throws IOException JavaDoc, TurbineException
92     {
93         if (DEBUG)
94         {
95             Long JavaDoc start = (Long JavaDoc)data.getRequest().getAttribute(KEY);
96             if (start == null)
97             {
98                 try
99                 {
100                     data.getResponse().setBufferSize(10000000);
101                 }
102                 catch (Exception JavaDoc e)
103                 {
104                     LOG.debug("Could not set high buffer size so client may " +
105                               "affect timing results.");
106                 }
107                 ((ScarabRequestTool)Module.getTemplateContext(data)
108                     .get("scarabR")).startTimer();
109                 data.getRequest()
110                     .setAttribute(KEY, new Long JavaDoc(System.currentTimeMillis()));
111             }
112             else
113             {
114                 String JavaDoc s = "Action=" + data.getAction() + " and template=" +
115                     data.getTarget() + " took: " +
116                     (System.currentTimeMillis() - start.longValue()) + " ms";
117                 LOG.debug(s);
118                 try
119                 {
120                     data.getResponse().getWriter().println(s);
121                 }
122                 catch (Exception JavaDoc ignore)
123                 {
124                     // maybe this was a binary response?
125 // we still logged it, so ignore
126 }
127             }
128         }
129             
130         // Pass control to the next Valve in the Pipeline
131 context.invokeNext(data);
132     }
133 }
134
Popular Tags