01: package org.tigris.scarab.pipeline;
02:
03: /* ================================================================
04: * Copyright (c) 2001 Collab.Net. All rights reserved.
05: *
06: * Redistribution and use in source and binary forms, with or without
07: * modification, are permitted provided that the following conditions are
08: * met:
09: *
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;
50: import org.apache.turbine.RunData;
51: import org.apache.turbine.TurbineException;
52: import org.apache.turbine.pipeline.AbstractValve;
53: import org.apache.turbine.ValveContext;
54: import org.apache.turbine.modules.Module;
55:
56: import org.tigris.scarab.tools.ScarabRequestTool;
57: import org.tigris.scarab.util.ScarabConstants;
58:
59: /**
60: * This valve adds an informational message to the response. This valve exists
61: * early in the pipeline, so it is possible this message may get overridden
62: * by some more relevant message in a particular case. But most actions and
63: * those requests that don't involve an action will not set the info message;
64: * in these cases this message will be shown. The message is set through an
65: * administrator action and only persists until the server is restarted.
66: *
67: * @author <a href="mailto:jmcnally@collab.net">John McNally</a>
68: * @version $Id: SetInfoMessageValve.java 7365 2003-03-15 21:56:59Z jon $
69: */
70: public class SetInfoMessageValve extends AbstractValve {
71: private static String message = null;
72:
73: /**
74: * @see org.apache.turbine.Valve#invoke(RunData, ValveContext)
75: */
76: public void invoke(RunData data, ValveContext context)
77: throws IOException, TurbineException {
78: ((ScarabRequestTool) Module.getTemplateContext(data).get(
79: ScarabConstants.SCARAB_REQUEST_TOOL))
80: .setInfoMessage(message);
81:
82: // Pass control to the next Valve in the Pipeline
83: context.invokeNext(data);
84: }
85:
86: public static void setMessage(String msg) {
87: message = msg;
88: }
89: }
|