org.apache.turbine.services.rundata
Class TurbineRunDataService

java.lang.Object
  extended by org.apache.turbine.services.BaseInitable
      extended by org.apache.turbine.services.BaseService
          extended by org.apache.turbine.services.TurbineBaseService
              extended by org.apache.turbine.services.rundata.TurbineRunDataService
All Implemented Interfaces:
Initable, RunDataService, Service

public class TurbineRunDataService
extends TurbineBaseService
implements RunDataService

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: TurbineRunDataService.java 1078552 2011-03-06 19:58:46Z tv $
Author:
Ilkka Priha, Henning P. Schmiedehausen

Field Summary
 
Fields inherited from class org.apache.turbine.services.BaseService
configuration, name, serviceBroker
 
Fields inherited from class org.apache.turbine.services.BaseInitable
initableBroker, isInitialized
 
Fields inherited from interface org.apache.turbine.services.rundata.RunDataService
COOKIE_PARSER_KEY, DEFAULT_CONFIG, PARAMETER_PARSER_KEY, RUN_DATA_KEY, SERVICE_NAME
 
Constructor Summary
TurbineRunDataService()
          Constructs a RunData Service.
 
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(String key, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, javax.servlet.ServletConfig config)
          Gets a RunData instance from a specific configuration.
 void init()
          Initializes the service by setting the pool capacity.
 boolean putRunData(RunData data)
          Puts the used RunData object back to the factory for recycling.
 
Methods inherited from class org.apache.turbine.services.TurbineBaseService
init, init, init, shutdown
 
Methods inherited from class org.apache.turbine.services.BaseService
getConfiguration, getName, getProperties, getServiceBroker, setName, setServiceBroker
 
Methods inherited from class org.apache.turbine.services.BaseInitable
getInit, getInitableBroker, setInit, setInitableBroker
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
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, setInitableBroker, shutdown
 

Constructor Detail

TurbineRunDataService

public TurbineRunDataService()
Constructs a RunData Service.

Method Detail

init

public void init()
          throws InitializationException
Initializes the service by setting the pool capacity.

Specified by:
init in interface Initable
Overrides:
init in class TurbineBaseService
Throws:
InitializationException - if initialization fails.

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.

Specified by:
getRunData in interface RunDataService
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(String key,
                          javax.servlet.http.HttpServletRequest req,
                          javax.servlet.http.HttpServletResponse res,
                          javax.servlet.ServletConfig config)
                   throws TurbineException,
                          IllegalArgumentException
Gets a RunData instance from a specific configuration.

Specified by:
getRunData in interface RunDataService
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.
IllegalArgumentException - if any of the parameters are null.

putRunData

public boolean putRunData(RunData data)
Puts the used RunData object back to the factory for recycling.

Specified by:
putRunData in interface RunDataService
Parameters:
data - the used RunData object.
Returns:
true, if pooling is supported and the object was accepted.


Copyright © 2000-2011 The Apache Software Foundation. All Rights Reserved.