001package org.apache.turbine.services.rundata;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import org.apache.fulcrum.parser.CookieParser;
023import org.apache.fulcrum.parser.ParameterParser;
024import org.apache.fulcrum.pool.Recyclable;
025import org.apache.turbine.util.RunData;
026
027/**
028 * TurbineRunData is an extension to the RunData interface to be
029 * implemented by RunData implementations to be distributed by
030 * the Turbine RunData Service. The extensions define methods
031 * that are used by the service for initializing the implementation,
032 * but which are not meant to be called by the actual client objects.
033 *
034 * <p>TurbineRunData extends also the Recyclable interface making
035 * it possible to pool its implementations for recycling.
036 *
037 * @author <a href="mailto:ilkka.priha@simsoft.fi">Ilkka Priha</a>
038 * @author <a href="mailto:jon@latchkey.com">Jon S. Stevens</a>
039 * @author <a href="mailto:bhoeneis@ee.ethz.ch">Bernie Hoeneisen</a>
040 * @author <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a>
041 * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
042 * @version $Id$
043 */
044public interface TurbineRunData
045    extends RunData,
046            Recyclable
047{
048    /**
049     * Gets the parameter parser without parsing the parameters.
050     *
051     * @return the parameter parser.
052     */
053    ParameterParser getParameterParser();
054
055    /**
056     * Gets the cookie parser without parsing the cookies.
057     *
058     * @return the cookie parser.
059     */
060    CookieParser getCookieParser();
061}