/*
* $Id: ComponentDefinitionsFactory.java 471754 2006-11-06 14:55:09Z husted $
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.struts.tiles;
import java.io.Serializable;
import java.util.Map;
import javax.servlet.ServletContext;
import javax.servlet.ServletRequest;
/**
* Component repository interface.
* This interface allows to retrieve an definition by its name, independently of the
* factory implementation.
* Implementation must be Serializable, in order to be compliant with web Container
* having this constraint (Weblogic 6.x).
* @deprecated Use DefinitionsFactory instead.
*/
public interface ComponentDefinitionsFactory extends Serializable
{
/**
* Get a definition by its name.
* @param name Name of requested definition.
* @param request Current servelet request
* @param servletContext current servlet context
* @throws DefinitionsFactoryException An error occur while getting definition.
* @throws NoSuchDefinitionException No definition found for specified name
* Implementation can throw more accurate exception as a subclass of this exception
*/
public ComponentDefinition getDefinition(String name, ServletRequest request, ServletContext servletContext) throws NoSuchDefinitionException,DefinitionsFactoryException;
/**
* Init factory.
* This method is called exactly once immediately after factory creation in
* case of internal creation (by DefinitionUtil).
* @param servletContext Servlet Context passed to newly created factory.
* @param properties Map of name/property passed to newly created factory.
* Map can contains more properties than requested.
* @throws DefinitionsFactoryException An error occur during initialization.
*/
public void initFactory(ServletContext servletContext, Map properties) throws DefinitionsFactoryException;
}