001: package org.apache.turbine.services.template;
002:
003: /*
004: * Licensed to the Apache Software Foundation (ASF) under one
005: * or more contributor license agreements. See the NOTICE file
006: * distributed with this work for additional information
007: * regarding copyright ownership. The ASF licenses this file
008: * to you under the Apache License, Version 2.0 (the
009: * "License"); you may not use this file except in compliance
010: * with the License. You may obtain a copy of the License at
011: *
012: * http://www.apache.org/licenses/LICENSE-2.0
013: *
014: * Unless required by applicable law or agreed to in writing,
015: * software distributed under the License is distributed on an
016: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017: * KIND, either express or implied. See the License for the
018: * specific language governing permissions and limitations
019: * under the License.
020: */
021:
022: import java.util.Hashtable;
023:
024: import org.apache.commons.configuration.Configuration;
025:
026: import org.apache.turbine.services.TurbineBaseService;
027:
028: /**
029: * The base implementation of Turbine {@link
030: * org.apache.turbine.services.template.TemplateEngineService}.
031: *
032: * @author <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a>
033: * @author <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a>
034: * @version $Id: BaseTemplateEngineService.java 534527 2007-05-02 16:10:59Z tv $
035: */
036: public abstract class BaseTemplateEngineService extends
037: TurbineBaseService implements TemplateEngineService {
038: /**
039: * A Map containing the configuration for the template
040: * engine service. The configuration contains:
041: *
042: * 1) template extensions
043: * 2) default page
044: * 3) default screen
045: * 4) default layout
046: * 5) default navigation
047: * 6) default error screen
048: */
049: private Hashtable configuration = new Hashtable();
050:
051: /**
052: * @see org.apache.turbine.services.template.TemplateEngineService#registerConfiguration
053: */
054: public void registerConfiguration(String defaultExt) {
055: initConfiguration(defaultExt);
056: TurbineTemplate.registerTemplateEngineService(this );
057: }
058:
059: /**
060: * @see org.apache.turbine.services.template.TemplateEngineService#getTemplateEngineServiceConfiguration
061: */
062: public Hashtable getTemplateEngineServiceConfiguration() {
063: return configuration;
064: }
065:
066: /**
067: * @see org.apache.turbine.services.template.TemplateEngineService#getAssociatedFileExtensions
068: */
069: public String[] getAssociatedFileExtensions() {
070: return (String[]) configuration.get(TEMPLATE_EXTENSIONS);
071: }
072:
073: /**
074: * Initialize the Template Engine Service.
075: *
076: * Note engine file extension associations. First attempts to
077: * pull a list of custom extensions from the property file value
078: * keyed by <code>template.extension</code>. If none are defined,
079: * uses the value keyed by
080: * <code>template.default.extension</code>, defaulting to the
081: * emergency value supplied by <code>defaultExt</code>.
082: *
083: * @param defaultExt The default used when the default defined in the
084: * properties file is missing or misconfigured.
085: */
086: protected void initConfiguration(String defaultExt) {
087: Configuration config = getConfiguration();
088:
089: //
090: // Should modify the configuration class to take defaults
091: // here, should have to do this.
092: //
093: String[] fileExtensionAssociations = config
094: .getStringArray(TEMPLATE_EXTENSIONS);
095:
096: if (fileExtensionAssociations == null
097: || fileExtensionAssociations.length == 0) {
098: fileExtensionAssociations = new String[1];
099: fileExtensionAssociations[0] = config.getString(
100: DEFAULT_TEMPLATE_EXTENSION, defaultExt);
101: }
102:
103: configuration.put(TEMPLATE_EXTENSIONS,
104: fileExtensionAssociations);
105:
106: /*
107: * We need some better error checking here and should probably
108: * throw an exception here if these things aren't set
109: * up correctly.
110: */
111:
112: String[] copyParams = { DEFAULT_PAGE, DEFAULT_SCREEN,
113: DEFAULT_LAYOUT, DEFAULT_NAVIGATION,
114: DEFAULT_ERROR_SCREEN, DEFAULT_LAYOUT_TEMPLATE,
115: DEFAULT_SCREEN_TEMPLATE };
116:
117: for (int i = 0; i < copyParams.length; i++) {
118: configuration.put(copyParams[i], config.getString(
119: copyParams[i], ""));
120: }
121: }
122:
123: /**
124: * @see org.apache.turbine.services.template.TemplateEngineService#templateExists
125: */
126: public abstract boolean templateExists(String template);
127: }
|