org.apache.turbine.services.rundata
Interface RunDataService

All Superinterfaces:

Initable, Service

All Known Implementing Classes:

TurbineRunDataService

public interface RunDataService

extends Service

The RunData Service provides the implementations for RunData and related interfaces required by request processing. It supports different configurations of implementations, which can be selected by specifying a configuration key. It may use pooling, in which case the implementations should implement the Recyclable interface.

Version:

$Id: RunDataService.java 534527 2007-05-02 16:10:59Z tv $

Author:

Ilkka Priha, Henning P. Schmiedehausen

Field Summary

static java.lang.String	COOKIE_PARSER_KEY The property for the implemention of the CookieParser.
static java.lang.String	DEFAULT_CONFIG The default parser configuration key.
static java.lang.String	PARAMETER_PARSER_KEY The property for the implemention of the ParameterParser.
static java.lang.String	RUN_DATA_KEY The property for the implemention of the RunData object
static java.lang.String	SERVICE_NAME The key under which this service is stored in TurbineServices.

Method Summary

RunData	getRunData(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, javax.servlet.ServletConfig config) Gets a default RunData object.
RunData	getRunData(java.lang.String key, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, javax.servlet.ServletConfig config) Gets a RunData object from a specific configuration.
boolean	putRunData(RunData data) Puts the used RunData object back to the factory for recycling.

Methods inherited from interface org.apache.turbine.services.Service

getConfiguration, getName, getProperties, setName, setServiceBroker

Methods inherited from interface org.apache.turbine.services.Initable

getInit, init, init, setInitableBroker, shutdown

Field Detail

SERVICE_NAME

public static final java.lang.String SERVICE_NAME

The key under which this service is stored in TurbineServices.

See Also:

Constant Field Values

DEFAULT_CONFIG

public static final java.lang.String DEFAULT_CONFIG

The default parser configuration key.

See Also:

Constant Field Values

RUN_DATA_KEY

public static final java.lang.String RUN_DATA_KEY

The property for the implemention of the RunData object

See Also:

Constant Field Values

PARAMETER_PARSER_KEY

public static final java.lang.String PARAMETER_PARSER_KEY

The property for the implemention of the ParameterParser.

See Also:

Constant Field Values

COOKIE_PARSER_KEY

public static final java.lang.String COOKIE_PARSER_KEY

The property for the implemention of the CookieParser.

See Also:

Constant Field Values

Method Detail

getRunData

public RunData getRunData(javax.servlet.http.HttpServletRequest req,
                          javax.servlet.http.HttpServletResponse res,
                          javax.servlet.ServletConfig config)
                   throws TurbineException

Gets a default RunData object.

Parameters:

req - a servlet request.

res - a servlet response.

config - a servlet config.

Returns:

a new or recycled RunData object.

Throws:

TurbineException - if the operation fails.

getRunData

public RunData getRunData(java.lang.String key,
                          javax.servlet.http.HttpServletRequest req,
                          javax.servlet.http.HttpServletResponse res,
                          javax.servlet.ServletConfig config)
                   throws TurbineException

Gets a RunData object from a specific configuration.

Parameters:

key - a configuration key.

req - a servlet request.

res - a servlet response.

config - a servlet config.

Returns:

a new or recycled RunData object.

Throws:

TurbineException - if the operation fails.

putRunData

public boolean putRunData(RunData data)

Puts the used RunData object back to the factory for recycling.

Parameters:

data - the used RunData object.

Returns:

true, if pooling is supported and the object was accepted.