01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package org.apache.cocoon.components;
18:
19: /**
20: * A {@link SitemapConfigurable} component gets the sitemap configuration
21: * using this object.
22: *
23: * @since 2.1
24: * @deprecated This functionality will be replaced in 2.2 with a more flexible
25: * configuration mechanism.
26: * @author <a href="mailto:cziegeler@apache.org">Carsten Ziegeler</a>
27: * @version $Id: SitemapConfigurationHolder.java 433543 2006-08-22 06:22:54Z crossley $
28: */
29: public interface SitemapConfigurationHolder {
30:
31: /**
32: * Get the configuration for the current sitemap
33: * @return The configuration
34: */
35: ChainedConfiguration getConfiguration();
36:
37: /**
38: * Get the prepared configuration for the current sitemap
39: * @return The configuration or null if no prepared is available
40: */
41: Object getPreparedConfiguration();
42:
43: /**
44: * Set the prepared configuration for the current sitemap.
45: * After it is set by a component, it can be get using
46: * {@link #getPreparedConfiguration()}.
47: *
48: * @param preparedConfig The prepared configuration
49: */
50: void setPreparedConfiguration(ChainedConfiguration configuration,
51: Object preparedConfig);
52: }
|