RELEASE_2_1_13/src/java/org/apache/cocoon/components/RequestLifecycleComponent.java

/*
 * 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.cocoon.components;

import java.io.IOException;
import java.util.Map;

import org.apache.avalon.excalibur.pool.Poolable;
import org.apache.cocoon.ProcessingException;
import org.apache.cocoon.environment.SourceResolver;
import org.xml.sax.SAXException;

/**
 * Components implementing this marker interface have a lifecycle of one
 * request. This means if during one request a component accepting this
 * interface is looked up several times, it's always the same instance.
 * Each internal subrequest, e.g. using the cocoon protocol, is considered
 * as a new request. So an instance looked up in the "main" request is
 * not available to a subrequest.
 * In addition, the first time this component is looked up during a request,
 * the {@link #setup(SourceResolver, Map)} method is called.
 * 
 * @see org.apache.cocoon.components.GlobalRequestLifecycleComponent
 * @deprecated Use the {@link org.apache.cocoon.components.persistence.RequestDataStore} instead.
 * 
 * @author <a href="mailto:cziegeler@apache.org">Carsten Ziegeler</a>
 * @version CVS $Id$
 */
public interface RequestLifecycleComponent extends Poolable {

    /**
     * Set the {@link SourceResolver} and the objectModel 
     * used to process the current request.
     */
    void setup(SourceResolver resolver, Map objectModel)
    throws ProcessingException, SAXException, IOException;
}