org.apache.turbine.services.template.TemplateService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of turbine Show documentation
Show all versions of turbine Show documentation
Turbine is a servlet based framework that allows experienced Java
developers to quickly build secure web applications. Parts of Turbine
can also be used independently of the web portion of Turbine as
well. In other words, we strive to make portions of Turbine easily
available for use in other applications.
package org.apache.turbine.services.template;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.turbine.pipeline.PipelineData;
import org.apache.turbine.services.Service;
/**
* This service provides a method for mapping templates to their
* appropriate Screens or Navigations. It also allows templates to
* define a layout/navigations/screen modularization within the
* template structure. It also performs caching if turned on in the
* properties file.
*
* @author John D. McNally
* @author Jason van Zyl
* @author Daniel Rall
* @author Ilkka Priha
* @version $Id: TemplateService.java 1773378 2016-12-09 13:19:59Z tv $
*/
public interface TemplateService
extends Service
{
/**
* The key under which this service is stored in TurbineServices.
*/
static final String SERVICE_NAME = "TemplateService";
/** Default Template Name. */
String DEFAULT_TEMPLATE_KEY = "default.template";
/** Default value for the Template Name */
String DEFAULT_TEMPLATE_VALUE = "Default";
/** Default Extension for the template names. */
String DEFAULT_EXTENSION_KEY = "default.extension";
/** Default value of the Turbine Module Caching */
String DEFAULT_EXTENSION_VALUE = "";
/** Character that separates a Template Name from the Extension */
char EXTENSION_SEPARATOR = '.';
/** Character that separates the various Template Parts */
char TEMPLATE_PARTS_SEPARATOR = ',';
/** "Default" name for Classes and Templates */
String DEFAULT_NAME = "Default";
/**
* Returns true if the Template Service has caching activated
*
* @return true if Caching is active.
*/
boolean isCaching();
/**
* Get the default template name extension specified
* in the template service properties.
*
* @return The default the extension.
*/
String getDefaultExtension();
/**
* Return Extension for a supplied template
*
* @param template The template name
*
* @return extension The extension for the supplied template
*/
String getExtension(String template);
/**
* Returns the Default Template Name with the Default Extension.
* If the extension is unset, return only the template name
*
* @return The default template Name
*/
String getDefaultTemplate();
/**
* Get the default page module name of the template engine
* service corresponding to the default template name extension.
*
* @return The default page module name.
*/
String getDefaultPage();
/**
* Get the default screen module name of the template engine
* service corresponding to the default template name extension.
*
* @return The default screen module name.
*/
String getDefaultScreen();
/**
* Get the default layout module name of the template engine
* service corresponding to the default template name extension.
*
* @return The default layout module name.
*/
String getDefaultLayout();
/**
* Get the default navigation module name of the template engine
* service corresponding to the default template name extension.
*
* @return The default navigation module name.
*/
String getDefaultNavigation();
/**
* Get the default layout template name of the template engine
* service corresponding to the default template name extension.
*
* @return The default layout template name.
*/
String getDefaultLayoutTemplate();
/**
* Get the default page module name of the template engine
* service corresponding to the template name extension of
* the named template.
*
* @param template The template name.
* @return The default page module name.
*/
String getDefaultPageName(String template);
/**
* Get the default screen module name of the template engine
* service corresponding to the template name extension of
* the named template.
*
* @param template The template name.
* @return The default screen module name.
*/
String getDefaultScreenName(String template);
/**
* Get the default layout module name of the template engine
* service corresponding to the template name extension of
* the named template.
*
* @param template The template name.
* @return The default layout module name.
*/
String getDefaultLayoutName(String template);
/**
* Get the default navigation module name of the template engine
* service corresponding to the template name extension of
* the named template.
*
* @param template The template name.
* @return The default navigation module name.
*/
String getDefaultNavigationName(String template);
/**
* Get the default layout template name of the template engine
* service corresponding to the template name extension of
* the named template.
*
* @param template The template name.
* @return The default layout template name.
*/
String getDefaultLayoutTemplateName(String template);
/**
* Find the default page module name for the given request.
*
* @param pipelineData The encapsulation of the request to retrieve the
* default page for.
* @return The default page module name.
*/
String getDefaultPageName(PipelineData pipelineData);
/**
* Find the default layout module name for the given request.
*
* @param pipelineData The encapsulation of the request to retrieve the
* default layout for.
* @return The default layout module name.
*/
String getDefaultLayoutName(PipelineData pipelineData);
/**
* Locate and return the name of the screen module to be used
* with the named screen template.
*
* @param template The screen template name.
* @return The found screen module name.
* @throws Exception a generic exception.
*/
String getScreenName(String template)
throws Exception;
/**
* Locate and return the name of the layout module to be used
* with the named layout template.
*
* @param template The layout template name.
* @return The found layout module name.
* @throws Exception a generic exception.
*/
String getLayoutName(String template)
throws Exception;
/**
* Locate and return the name of the navigation module to be used
* with the named navigation template.
*
* @param template The navigation template name.
* @return The found navigation module name.
* @throws Exception a generic exception.
*/
String getNavigationName(String template)
throws Exception;
/**
* Locate and return the name of the screen template corresponding
* to the given template name parameter.
*
* @param template The template name parameter.
* @return The found screen template name.
* @throws Exception a generic exception.
*/
String getScreenTemplateName(String template)
throws Exception;
/**
* Locate and return the name of the layout template corresponding
* to the given screen template name parameter.
*
* @param template The template name parameter.
* @return The found screen template name.
* @throws Exception a generic exception.
*/
String getLayoutTemplateName(String template)
throws Exception;
/**
* Locate and return the name of the navigation template corresponding
* to the given template name parameter.
*
* @param template The template name parameter.
* @return The found navigation template name.
* @throws Exception a generic exception.
*/
String getNavigationTemplateName(String template)
throws Exception;
/**
* Translates the supplied template paths into their Turbine-canonical
* equivalent (probably absolute paths).
*
* @param templatePaths An array of template paths.
* @return An array of translated template paths.
* @deprecated Each template engine service should know how to translate
* a request onto a file.
*/
@Deprecated
String[] translateTemplatePaths(String[] templatePaths);
/**
* Delegates to the appropriate {@link
* org.apache.turbine.services.template.TemplateEngineService} to
* check the existence of the specified template.
*
* @param template The template to check for the existence of.
* @param templatePaths The paths to check for the template.
* @return true if the given template exists
* @deprecated Use templateExists from the various Templating Engines
*/
@Deprecated
boolean templateExists(String template,
String[] templatePaths);
/**
* The {@link org.apache.turbine.services.template.TemplateEngineService}
* associated with the specified template's file extension.
*
* @param template The template name.
* @return The template engine service.
*/
TemplateEngineService getTemplateEngineService(String template);
/**
* Registers the provided template engine for use by the
* TemplateService.
*
* @param service The TemplateEngineService to register.
*/
void registerTemplateEngineService(TemplateEngineService service);
}