View Javadoc
1   package org.apache.turbine.services.rundata;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.fulcrum.parser.CookieParser;
23  import org.apache.fulcrum.parser.ParameterParser;
24  import org.apache.fulcrum.pool.Recyclable;
25  import org.apache.turbine.util.RunData;
26  
27  /**
28   * TurbineRunData is an extension to the RunData interface to be
29   * implemented by RunData implementations to be distributed by
30   * the Turbine RunData Service. The extensions define methods
31   * that are used by the service for initializing the implementation,
32   * but which are not meant to be called by the actual client objects.
33   *
34   * <p>TurbineRunData extends also the Recyclable interface making
35   * it possible to pool its implementations for recycling.
36   *
37   * @author <a href="mailto:ilkka.priha@simsoft.fi">Ilkka Priha</a>
38   * @author <a href="mailto:jon@latchkey.com">Jon S. Stevens</a>
39   * @author <a href="mailto:bhoeneis@ee.ethz.ch">Bernie Hoeneisen</a>
40   * @author <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a>
41   * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
42   * @version $Id: TurbineRunData.java 1695634 2015-08-13 00:35:47Z tv $
43   */
44  public interface TurbineRunData
45      extends RunData,
46              Recyclable
47  {
48      /**
49       * Gets the parameter parser without parsing the parameters.
50       *
51       * @return the parameter parser.
52       */
53      ParameterParser getParameterParser();
54  
55      /**
56       * Gets the cookie parser without parsing the cookies.
57       *
58       * @return the cookie parser.
59       */
60      CookieParser getCookieParser();
61  }