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: import java.io.IOException;
20: import java.util.Map;
21:
22: import org.apache.avalon.excalibur.pool.Poolable;
23: import org.apache.cocoon.ProcessingException;
24: import org.apache.cocoon.environment.SourceResolver;
25: import org.xml.sax.SAXException;
26:
27: /**
28: * Components implementing this marker interface have a lifecycle of one
29: * request. This means if during one request a component accepting this
30: * interface is looked up several times, it's always the same instance.
31: * Each internal subrequest, e.g. using the cocoon protocol, is considered
32: * as a new request. So an instance looked up in the "main" request is
33: * not available to a subrequest.
34: * In addition, the first time this component is looked up during a request,
35: * the {@link #setup(SourceResolver, Map)} method is called.
36: *
37: * @see org.apache.cocoon.components.GlobalRequestLifecycleComponent
38: * @deprecated Use the {@link org.apache.cocoon.components.persistence.RequestDataStore} instead.
39: *
40: * @author <a href="mailto:cziegeler@apache.org">Carsten Ziegeler</a>
41: * @version CVS $Id: RequestLifecycleComponent.java 433543 2006-08-22 06:22:54Z crossley $
42: */
43: public interface RequestLifecycleComponent extends Poolable {
44:
45: /**
46: * Set the {@link SourceResolver} and the objectModel
47: * used to process the current request.
48: */
49: void setup(SourceResolver resolver, Map objectModel)
50: throws ProcessingException, SAXException, IOException;
51: }
|