GlobalRequestLifecycleComponent


1   /*
2    * Copyright 1999-2004 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.apache.cocoon.components;
17  
18  import java.io.IOException  ;
19  import java.util.Map  ;
20  
21  import org.apache.cocoon.ProcessingException;
22  import org.apache.cocoon.environment.SourceResolver;
23  import org.xml.sax.SAXException  ;
24  
25  /**
26   * Components implementing this marker interface have a lifecycle of one
27   * request-response cycle. This means if during one cycle a component accepting this
28   * interface is looked up several times, it's always the same instance.
29   * Each internal subrequest happens in the same cycle, so an instance looked up in 
30   * either the "main" request or in any of the subrequests is available to all
31   * other requests in this cycle. 
32   * In addition, the first time this component is looked up during a request,
33   * the {@link #setup(SourceResolver, Map)} method is called.
34   *
35   * @see org.apache.cocoon.components.RequestLifecycleComponent
36   * @deprecated Use the {@link org.apache.cocoon.components.persistence.RequestDataStore} instead.
37   * 
38   * @author <a HREF="mailto:cziegeler@apache.org">Carsten Ziegeler</a>
39   * @version CVS $Id: GlobalRequestLifecycleComponent.java 30932 2004-07-29 17:35:38Z vgritsenko $
40   */
41  public interface GlobalRequestLifecycleComponent {
42  
43      /**
44       * Set the {@link SourceResolver} and the objectModel 
45       * used to process the current request.
46       */
47      void setup(SourceResolver resolver, Map   objectModel)
48      throws ProcessingException, SAXException  , IOException  ;
49  }
50
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags