1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.fulcrum.yaafi.framework.configuration;
20
21 import java.util.Properties;
22
23 /**
24 * This interface allows to resolve component configuration properties. These
25 * properties are used to expand variables found in the componentConfiguration.xml.
26 * The main motivation for this interface is to allow users to hook up
27 * commons-configuration to resolve global parameters easily without
28 * coupling this implementation to any external libraries.
29 *
30 * @author <a href="mailto:siegfried.goeschl@it20one.at">Siegfried Goeschl</a>
31 */
32 public interface ComponentConfigurationPropertiesResolver
33 {
34 /** default file name of the component config property file */
35 String COMPONENT_CONFIG_PROPERTIES_VALUE = "/componentConfiguration.properties";
36
37 /**
38 * Resolve custom properties
39 *
40 * @param defaults the default properties
41 * @return the custom properties
42 * @throws Exception throws an exception if failed to resolve
43 */
44 Properties resolve(Properties defaults) throws Exception;
45 }