KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > fulcrum > template > TemplateService


1 package org.apache.fulcrum.template;
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 java.io.OutputStream JavaDoc;
58 import java.io.Writer JavaDoc;
59 import org.apache.fulcrum.Service;
60 import org.apache.fulcrum.ServiceException;
61
62 /**
63  * This service provides a method for mapping templates to their
64  * appropriate Screens or Navigations. It also allows templates to
65  * define a layout/navigations/screen modularization within the
66  * template structure. It also performs caching if turned on in the
67  * properties file.
68  *
69  * @author <a HREF="mailto:jmcnally@collab.net">John D. McNally</a>
70  * @author <a HREF="mailto:jvanzyl@apache.org">Jason van Zyl</a>
71  * @author <a HREF="mailto:dlr@finemaltcoding.com">Daniel Rall</a>
72  * @author <a HREF="mailto:ilkka.priha@simsoft.fi">Ilkka Priha</a>
73  * @version $Id: TemplateService.java,v 1.1 2004/11/12 10:26:06 epugh Exp $
74  */
75 public interface TemplateService
76     extends Service
77 {
78     /**
79      * The key under which this service is stored in TurbineServices.
80      */
81     public static final String JavaDoc SERVICE_NAME = "TemplateService";
82
83     /**
84      * The key to the template context.
85      */
86     public static final String JavaDoc CONTEXT = "TEMPLATE_CONTEXT";
87
88     /**
89      * Translates the supplied template paths into their Turbine-canonical
90      * equivalent (probably absolute paths).
91      *
92      * @param templatePaths An array of template paths.
93      * @return An array of translated template paths.
94      */
95     public String JavaDoc[] translateTemplatePaths(String JavaDoc[] templatePaths);
96
97     /**
98      * Delegates to the appropriate {@link
99      * org.apache.fulcrum.template.TemplateEngineService} to
100      * check the existance of the specified template.
101      *
102      * @param template The template to check for the existance of.
103      * @param templatePaths The paths to check for the template.
104      */
105     public boolean templateExists(String JavaDoc template,
106                                   String JavaDoc[] templatePaths);
107
108     /**
109      * Registers the provided template engine for use by the
110      * <code>TemplateService</code>.
111      *
112      * @param service The <code>TemplateEngineService</code> to register.
113      */
114     public void registerTemplateEngineService(TemplateEngineService service);
115
116     public String JavaDoc handleRequest(TemplateContext context, String JavaDoc template)
117         throws ServiceException;
118
119     public void handleRequest(TemplateContext context, String JavaDoc template,
120                               OutputStream JavaDoc outputStream)
121         throws ServiceException;
122
123     public void handleRequest(TemplateContext context, String JavaDoc template,
124                               Writer JavaDoc writer)
125         throws ServiceException;
126
127     public TemplateContext getTemplateContext();
128
129     public boolean templateExists(String JavaDoc template);
130 }
131
Popular Tags