1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.kernel.velocity;
24  
25  import com.liferay.portal.SystemException;
26  
27  import java.io.IOException;
28  import java.io.Writer;
29  
30  /**
31   * <a href="VelocityEngine.java.html"><b><i>View Source</i></b></a>
32   *
33   * @author Raymond Augé
34   *
35   */
36  public interface VelocityEngine {
37  
38      public void flushTemplate(String resource);
39  
40      public void init();
41  
42      public VelocityContext getEmptyContext();
43  
44      public VelocityContext getRestrictedToolsContext();
45  
46      public VelocityContext getStandardToolsContext();
47  
48      public VelocityContext getWrappedRestrictedToolsContext();
49  
50      public VelocityContext getWrappedStandardToolsContext();
51  
52      public boolean mergeTemplate(
53              String velocityTemplateId, VelocityContext velocityContext,
54              Writer writer)
55          throws SystemException, IOException;
56  
57      public boolean mergeTemplate(
58              String velocityTemplateId, String velocityTemplateContent,
59              VelocityContext velocityContext, Writer writer)
60          throws SystemException, IOException;
61  
62      public boolean resourceExists(String resource);
63  
64  }