001: /*
002: * $Id: DefinitionsFactory.java 471754 2006-11-06 14:55:09Z husted $
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: package org.apache.struts.tiles;
023:
024: import java.io.Serializable;
025:
026: import javax.servlet.ServletContext;
027: import javax.servlet.ServletRequest;
028:
029: /**
030: * Tiles Definition factory.
031: * This interface replace old ComponentDefinitionsFactory.
032: * Main method getDefinition() is exactly the same. Initialization method change.
033: * This interface allows to retrieve a definition by its name, independently of
034: * the factory implementation.
035: * Object life cycle is as follow:
036: * <ul>
037: * <li>Constructor: create object</li>
038: * <li>setConfig: set config and initialize factory. After first call to this
039: * method, factory is operational.</li>
040: * <li>destroy: factory is being shutdown.</li>
041: * </ul>
042: * Implementation must be Serializable, in order to be compliant with web Container
043: * having this constraint (Weblogic 6.x).
044: */
045: public interface DefinitionsFactory extends Serializable {
046:
047: /**
048: * Get a definition by its name.
049: * @param name Name of requested definition.
050: * @param request Current servelet request
051: * @param servletContext current servlet context
052: * @throws DefinitionsFactoryException An error occur while getting definition.
053: * @throws NoSuchDefinitionException No definition found for specified name
054: * Implementation can throw more accurate exception as a subclass of this exception
055: */
056: public ComponentDefinition getDefinition(String name,
057: ServletRequest request, ServletContext servletContext)
058: throws NoSuchDefinitionException,
059: DefinitionsFactoryException;
060:
061: /**
062: * Init definition factory.
063: * This method is called immediately after factory creation, and prior any call
064: * to setConfig().
065: *
066: * @param config Configuration object used to set factory configuration.
067: * @param servletContext Servlet Context passed to factory.
068: * @throws DefinitionsFactoryException An error occur during initialization.
069: */
070: public void init(DefinitionsFactoryConfig config,
071: ServletContext servletContext)
072: throws DefinitionsFactoryException;
073:
074: /**
075: * <p>Receive notification that the factory is being
076: * shut down.</p>
077: */
078: public void destroy();
079:
080: /**
081: * Set factory configuration.
082: * This method is used to change factory configuration.
083: * This method is optional, and can send an exception if implementation
084: * doesn't allow change in configuration.
085: *
086: * @param config Configuration object used to set factory configuration.
087: * @param servletContext Servlet Context passed to factory.
088: * @throws DefinitionsFactoryException An error occur during initialization.
089: */
090: public void setConfig(DefinitionsFactoryConfig config,
091: ServletContext servletContext)
092: throws DefinitionsFactoryException;
093:
094: /**
095: * Get factory configuration.
096: * @return TilesConfig
097: */
098: public DefinitionsFactoryConfig getConfig();
099:
100: }
|