001: package org.tigris.scarab.pipeline;
002:
003: /* ================================================================
004: * Copyright (c) 2001 Collab.Net. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions are
008: * met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in the
015: * documentation and/or other materials provided with the distribution.
016: *
017: * 3. The end-user documentation included with the redistribution, if
018: * any, must include the following acknowlegement: "This product includes
019: * software developed by Collab.Net <http://www.Collab.Net/>."
020: * Alternately, this acknowlegement may appear in the software itself, if
021: * and wherever such third-party acknowlegements normally appear.
022: *
023: * 4. The hosted project names must not be used to endorse or promote
024: * products derived from this software without prior written
025: * permission. For written permission, please contact info@collab.net.
026: *
027: * 5. Products derived from this software may not use the "Tigris" or
028: * "Scarab" names nor may "Tigris" or "Scarab" appear in their names without
029: * prior written permission of Collab.Net.
030: *
031: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
032: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
033: * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
034: * IN NO EVENT SHALL COLLAB.NET OR ITS CONTRIBUTORS BE LIABLE FOR ANY
035: * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
036: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
037: * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
038: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
039: * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
040: * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
041: * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
042: *
043: * ====================================================================
044: *
045: * This software consists of voluntary contributions made by many
046: * individuals on behalf of Collab.Net.
047: */
048:
049: import java.io.IOException;
050:
051: import org.apache.log4j.Logger;
052: import org.apache.turbine.RunData;
053: import org.apache.turbine.TurbineException;
054: import org.apache.turbine.ValveContext;
055: import org.apache.turbine.modules.Module;
056: import org.apache.turbine.pipeline.AbstractValve;
057: import org.tigris.scarab.tools.ScarabRequestTool;
058:
059: /**
060: * This valve stores the system time in the request object on first invocation
061: * and reports the elapsed time on later invocations. It generally would be
062: * set as the first and last valve in a pipeline. This valve also sets a
063: * large response buffer, so that timing results are those of the server.
064: * This will actually make the system appear slower to clients so it should
065: * not be used in a production system. You need to compile this valve
066: * with DEBUG=true for it to be functional.
067: *
068: * @author <a href="mailto:jmcnally@collab.net">John McNally</a>
069: * @version $Id: TimingInfoValve.java 9255 2004-11-14 21:07:04Z dep4b $
070: */
071: public class TimingInfoValve extends AbstractValve {
072: private static final Logger LOG = Logger
073: .getLogger(TimingInfoValve.class);
074:
075: private static String KEY;
076:
077: private static final boolean DEBUG = false;
078:
079: public void initialize() throws Exception {
080: super .initialize();
081: KEY = TimingInfoValve.class.getName() + ".start";
082:
083: }
084:
085: /**
086: * @see org.apache.turbine.Valve#invoke(RunData, ValveContext)
087: */
088: public void invoke(RunData data, ValveContext context)
089: throws IOException, TurbineException {
090: if (DEBUG) {
091: Long start = (Long) data.getRequest().getAttribute(KEY);
092: if (start == null) {
093: try {
094: data.getResponse().setBufferSize(10000000);
095: } catch (Exception e) {
096: LOG
097: .debug("Could not set high buffer size so client may "
098: + "affect timing results.");
099: }
100: ((ScarabRequestTool) Module.getTemplateContext(data)
101: .get("scarabR")).startTimer();
102: data.getRequest().setAttribute(KEY,
103: new Long(System.currentTimeMillis()));
104: } else {
105: String s = "Action="
106: + data.getAction()
107: + " and template="
108: + data.getTarget()
109: + " took: "
110: + (System.currentTimeMillis() - start
111: .longValue()) + " ms";
112: LOG.debug(s);
113: try {
114: data.getResponse().getWriter().println(s);
115: } catch (Exception ignore) {
116: // maybe this was a binary response?
117: // we still logged it, so ignore
118: }
119: }
120: }
121:
122: // Pass control to the next Valve in the Pipeline
123: context.invokeNext(data);
124: }
125: }
|