1 //
2 //Copyright (c) 2003, Caltha - Gajda, Krzewski, Mach, Potempski Sp.J.
3 //All rights reserved.
4 //
5 //Redistribution and use in source and binary forms, with or without modification,
6 //are permitted provided that the following conditions are met:
7 //
8 //* Redistributions of source code must retain the above copyright notice,
9 //this list of conditions and the following disclaimer.
10 //* Redistributions in binary form must reproduce the above copyright notice,
11 //this list of conditions and the following disclaimer in the documentation
12 //and/or other materials provided with the distribution.
13 //* Neither the name of the Caltha - Gajda, Krzewski, Mach, Potempski Sp.J.
14 //nor the names of its contributors may be used to endorse or promote products
15 //derived from this software without specific prior written permission.
16 //
17 //THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18 //AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 //WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 //IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
21 //INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
22 //BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
23 //OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24 //WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 //ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 //POSSIBILITY OF SUCH DAMAGE.
27 //
28
29 package org.objectledge.templating.tools;
30
31 import org.objectledge.context.Context;
32 import org.objectledge.pipeline.ProcessingException;
33 import org.objectledge.pipeline.Valve;
34 import org.objectledge.templating.TemplatingContext;
35
36 /**
37 * The pipeline processing valve that populates the templating context with configured tool objects.
38 *
39 * @author <a href="mailto:pablo@caltha.pl">Pawel Potempski</a>
40 * @version $Id: ContextToolPopulatorValve.java,v 1.5 2005/07/22 17:19:43 pablo Exp $
41 */
42 public class ContextToolPopulatorValve
43 implements Valve
44 {
45 /*** tool component */
46 private ContextTools contextTools;
47
48 /***
49 * Component constructor.
50 *
51 * @param contextTools the context tool component.
52 */
53 public ContextToolPopulatorValve(ContextTools contextTools)
54 {
55 this.contextTools = contextTools;
56 }
57
58 /***
59 * Get the tools from factory objects and put them into the context.
60 *
61 * @param context the thread's processing context.
62 */
63 public void process(Context context)
64 throws ProcessingException
65 {
66 TemplatingContext templatingContext = TemplatingContext.getTemplatingContext(context);
67 contextTools.populateTools(templatingContext);
68 }
69 }