KickJava   Java API By Example, From Geeks To Geeks.

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


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 java.util.Hashtable JavaDoc;
60 import org.apache.fulcrum.ServiceException;
61
62 /**
63  * This is the interface that all template engine services must adhere
64  * to. This includes the Velocity, WebMacro, FreeMarker, and JSP
65  * services.
66  *
67  * @author <a HREF="mailto:jvanzyl@apache.org">Jason van Zyl</a>
68  * @author <a HREF="mailto:dlr@finemaltcoding.com">Daniel Rall</a>
69  * @version $Id: TemplateEngineService.java,v 1.1 2004/11/12 10:26:06 epugh Exp $ */
70 public interface TemplateEngineService
71 {
72     public static final String JavaDoc TEMPLATE_EXTENSIONS = "template.extension";
73     public static final String JavaDoc DEFAULT_TEMPLATE_EXTENSION = "template.default.extension";
74     public static final String JavaDoc DEFAULT_LAYOUT_TEMPLATE = "default.page.template";
75     public static final String JavaDoc DEFAULT_PAGE_TEMPLATE = "default.layout.template";
76
77     /**
78      * Return the configuration of the template engine in
79      * the form of a Hashtable.
80      */
81     public Hashtable JavaDoc getTemplateEngineServiceConfiguration();
82
83     /**
84      * Initializes file extension associations and registers with the
85      * template service.
86      *
87      * @param defaultExt The default file extension association to use
88      * in case of properties file misconfiguration.
89      */
90     public void registerConfiguration(String JavaDoc defaultExt);
91
92     /**
93      * Supplies the file extension to key this engine in {@link
94      * org.apache.fulcrum.template.TemplateService}'s
95      * registry with.
96      */
97     public String JavaDoc[] getAssociatedFileExtensions();
98
99     /**
100      * Use the specific template engine to determine whether
101      * a given template exists. This allows Turbine the TemplateService
102      * to delegate the search for a template to the template
103      * engine being used for the view. This gives us the
104      * advantage of fully utilizing the capabilities of
105      * template engine with respect to retrieving templates
106      * from arbitrary sources.
107      *
108      * @param template The name of the template to check the existance of.
109      * @return Whether the specified template exists.
110      */
111     public boolean templateExists(String JavaDoc template);
112
113     /**
114      * @see org.apache.fulcrum.template.TemplateEngineService
115      */
116     public abstract String JavaDoc handleRequest(TemplateContext context,
117                                          String JavaDoc template)
118         throws ServiceException;
119
120     /**
121      * @see org.apache.fulcrum.template.TemplateEngineService
122      */
123     public abstract void handleRequest(TemplateContext context,
124                                        String JavaDoc template,
125                                        OutputStream JavaDoc outputStream)
126         throws ServiceException;
127
128     /**
129      * @see org.apache.fulcrum.template.TemplateEngineService
130      */
131     void handleRequest(TemplateContext context, String JavaDoc template, Writer JavaDoc writer)
132         throws ServiceException;
133 }
134
Popular Tags