01: /*
02: * $Id: ComponentDefinitionsFactory.java 471754 2006-11-06 14:55:09Z husted $
03: *
04: * Licensed to the Apache Software Foundation (ASF) under one
05: * or more contributor license agreements. See the NOTICE file
06: * distributed with this work for additional information
07: * regarding copyright ownership. The ASF licenses this file
08: * to you under the Apache License, Version 2.0 (the
09: * "License"); you may not use this file except in compliance
10: * with the License. You may obtain a copy of the License at
11: *
12: * http://www.apache.org/licenses/LICENSE-2.0
13: *
14: * Unless required by applicable law or agreed to in writing,
15: * software distributed under the License is distributed on an
16: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17: * KIND, either express or implied. See the License for the
18: * specific language governing permissions and limitations
19: * under the License.
20: */
21:
22: package org.apache.struts.tiles;
23:
24: import java.io.Serializable;
25: import java.util.Map;
26:
27: import javax.servlet.ServletContext;
28: import javax.servlet.ServletRequest;
29:
30: /**
31: * Component repository interface.
32: * This interface allows to retrieve an definition by its name, independently of the
33: * factory implementation.
34: * Implementation must be Serializable, in order to be compliant with web Container
35: * having this constraint (Weblogic 6.x).
36: * @deprecated Use DefinitionsFactory instead.
37: */
38: public interface ComponentDefinitionsFactory extends Serializable {
39:
40: /**
41: * Get a definition by its name.
42: * @param name Name of requested definition.
43: * @param request Current servelet request
44: * @param servletContext current servlet context
45: * @throws DefinitionsFactoryException An error occur while getting definition.
46: * @throws NoSuchDefinitionException No definition found for specified name
47: * Implementation can throw more accurate exception as a subclass of this exception
48: */
49: public ComponentDefinition getDefinition(String name,
50: ServletRequest request, ServletContext servletContext)
51: throws NoSuchDefinitionException,
52: DefinitionsFactoryException;
53:
54: /**
55: * Init factory.
56: * This method is called exactly once immediately after factory creation in
57: * case of internal creation (by DefinitionUtil).
58: * @param servletContext Servlet Context passed to newly created factory.
59: * @param properties Map of name/property passed to newly created factory.
60: * Map can contains more properties than requested.
61: * @throws DefinitionsFactoryException An error occur during initialization.
62: */
63: public void initFactory(ServletContext servletContext,
64: Map properties) throws DefinitionsFactoryException;
65: }
|