1 package org.apache.turbine.services.pull;
2
3 /* ====================================================================
4 * The Apache Software License, Version 1.1
5 *
6 * Copyright (c) 2001 The Apache Software Foundation. All rights
7 * reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 *
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 *
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
19 * distribution.
20 *
21 * 3. The end-user documentation included with the redistribution,
22 * if any, must include the following acknowledgment:
23 * "This product includes software developed by the
24 * Apache Software Foundation (http://www.apache.org/)."
25 * Alternately, this acknowledgment may appear in the software itself,
26 * if and wherever such third-party acknowledgments normally appear.
27 *
28 * 4. The names "Apache" and "Apache Software Foundation" and
29 * "Apache Turbine" must not be used to endorse or promote products
30 * derived from this software without prior written permission. For
31 * written permission, please contact apache@apache.org.
32 *
33 * 5. Products derived from this software may not be called "Apache",
34 * "Apache Turbine", nor may "Apache" appear in their name, without
35 * prior written permission of the Apache Software Foundation.
36 *
37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48 * SUCH DAMAGE.
49 * ====================================================================
50 *
51 * This software consists of voluntary contributions made by many
52 * individuals on behalf of the Apache Software Foundation. For more
53 * information on the Apache Software Foundation, please see
54 * <http://www.apache.org/>.
55 */
56
57 import org.apache.velocity.context.Context;
58
59 import org.apache.turbine.services.Service;
60 import org.apache.turbine.util.RunData;
61
62 /***
63 * The Pull Service manages the creation of application
64 * tools that are available to all templates in a
65 * Turbine application. By using the Pull Service you
66 * can avoid having to make Screens to populate a
67 * context for use in a particular template. The Pull
68 * Service creates a set of tools, as specified in
69 * the TR.props file.
70 *
71 * These tools can have global scope, request scope,
72 * session scope (i.e. stored in user temp hashmap)
73 * or persistent scope (i.e. stored in user perm hashmap)
74 *
75 * The standard way of referencing these global
76 * tools is through the toolbox handle. This handle
77 * is typically $toolbox, but can be specified in the
78 * TR.props file.
79 *
80 * So, for example, if you had a UI Manager tool
81 * which created a set of UI attributes from a
82 * properties file, and one of the properties
83 * was 'bgcolor', then you could access this
84 * UI attribute with $ui.bgcolor. The identifier
85 * that is given to the tool, in this case 'ui', can
86 * be specified as well.
87 *
88 * @author <a href="mailto:jvanzyl@periapt.com">Jason van Zyl</a>
89 * @version $Id: PullService.java,v 1.1.1.1 2001/08/16 05:09:10 jvanzyl Exp $
90 */
91 public interface PullService extends Service
92 {
93 /***
94 * The key under which this service is stored in TurbineServices.
95 */
96 public static final String SERVICE_NAME = "PullService";
97
98 /***
99 * Get the context containing global tools that will be
100 * use as part of the Turbine Pull Model.
101 */
102 public Context getGlobalContext();
103
104 /***
105 * Populate the given context with all request, session
106 * and persistent scope tools (it is assumed that the context
107 * already wraps the global context, and thus already contains
108 * the global tools).
109 *
110 * @param context a Velocity Context to populate
111 * @param data a RunData object for request specific data
112 */
113 public void populateContext(Context context, RunData data);
114
115 /***
116 * Return the absolute path of the resources directory
117 * used by application tools.
118 */
119 public String getAbsolutePathToResourcesDirectory();
120
121 /***
122 * Return the resources directory. This is relative
123 * to the webapp context.
124 */
125 public String getResourcesDirectory();
126
127 /***
128 * Refresh the global tools .
129 */
130 public void refreshGlobalTools();
131
132 /***
133 * Shoud we refresh the tools
134 * on each request. For development purposes.
135 */
136 public boolean refreshToolsPerRequest();
137
138 /***
139 * Release tool instances from the given context to the
140 * object pool
141 *
142 * @param context a Velocity Context to release tools from
143 */
144 public void releaseTools(Context context);
145
146 }
This page was automatically generated by Maven