1 package org.apache.turbine.services.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.util.Hashtable;
58
59 /***
60 * This is the interface that all template engine services must adhere
61 * to. This includes the Velocity, WebMacro, FreeMarker, and JSP
62 * services.
63 *
64 * @author <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a>
65 * @author <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a>
66 * @version $Id: TemplateEngineService.java,v 1.1.1.1 2001/08/16 05:09:22 jvanzyl Exp $ */
67 public interface TemplateEngineService
68 {
69 public static final String TEMPLATE_EXTENSIONS = "template.extension";
70 public static final String DEFAULT_TEMPLATE_EXTENSION = "template.default.extension";
71 public static final String DEFAULT_PAGE = "default.page";
72 public static final String DEFAULT_SCREEN = "default.screen";
73 public static final String DEFAULT_LAYOUT = "default.layout";
74 public static final String DEFAULT_NAVIGATION = "default.navigation";
75 public static final String DEFAULT_ERROR_SCREEN = "default.error.screen";
76 public static final String DEFAULT_LAYOUT_TEMPLATE = "default.layout.template";
77
78 /***
79 * Return the configuration of the template engine in
80 * the form of a Hashtable.
81 */
82 public Hashtable getTemplateEngineServiceConfiguration();
83
84 /***
85 * Initializes file extension associations and registers with the
86 * template service.
87 *
88 * @param defaultExt The default file extension association to use
89 * in case of properties file misconfiguration.
90 */
91 public void registerConfiguration(String defaultExt);
92
93 /***
94 * Supplies the file extension to key this engine in {@link
95 * org.apache.turbine.services.template.TemplateService}'s
96 * registry with.
97 */
98 public String[] getAssociatedFileExtensions();
99
100 /***
101 * Use the specific template engine to determine whether
102 * a given template exists. This allows Turbine the TemplateService
103 * to delegate the search for a template to the template
104 * engine being used for the view. This gives us the
105 * advantage of fully utilizing the capabilities of
106 * template engine with respect to retrieving templates
107 * from arbitrary sources.
108 *
109 * @param template The name of the template to check the existance of.
110 * @return Whether the specified template exists.
111 */
112 public boolean templateExists(String template);
113 }
This page was automatically generated by Maven