org.apache.turbine.services.rundata
Interface TurbineRunData

All Superinterfaces:

Recyclable, RunData

All Known Implementing Classes:

DefaultTurbineRunData

public interface TurbineRunData

extends RunData, Recyclable

TurbineRunData is an extension to the RunData interface to be implemented by RunData implementations to be distributed by the Turbine RunData Service. The extensions define methods that are used by the service for initilizing the implementation, but which are not meant to be called by the actual client objects.

TurbineRunData extends also the Recyclable interface making it possible to pool its implementations for recycling.

Version:

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

Author:

Ilkka Priha, Jon S. Stevens, Bernie Hoeneisen, Daniel Rall, Henning P. Schmiedehausen

Method Summary

CookieParser	getCookieParser() Gets the cookie parser without parsing the cookies.
ParameterParser	getParameterParser() Gets the parameter parser without parsing the parameters.
void	setCookieParser(CookieParser parser) Sets the cookie parser.
void	setParameterParser(ParameterParser parser) Sets the parameter parser.
void	setRequest(javax.servlet.http.HttpServletRequest req) Sets the servlet request.
void	setResponse(javax.servlet.http.HttpServletResponse res) Sets the servlet response.
void	setServerData(ServerData serverData) Sets the server data of the request.
void	setServletConfig(javax.servlet.ServletConfig config) Sets the servlet configuration used during servlet init.
void	setSession(javax.servlet.http.HttpSession sess) Deprecated. No replacement. This method no longer does anything.

Methods inherited from interface org.apache.turbine.util.RunData

addMessage, addMessage, declareDirectResponse, getACL, getAction, getCharSet, getContentType, getContextPath, getCookies, getDebugVariables, getJNDIContexts, getLayout, getLayoutTemplate, getLocale, getMessage, getMessageAsHTML, getMessages, getOut, getPage, getParameters, getRedirectURI, getRemoteAddr, getRemoteHost, getRequest, getResponse, getScreen, getScreenTemplate, getScriptName, getServerData, getServerName, getServerPort, getServerScheme, getServletConfig, getServletContext, getSession, getStackTrace, getStackTraceException, getStatusCode, getSystemErrors, getTemplateEncoding, getTemplateInfo, getTitle, getUser, getUserAgent, getUserFromSession, getVarDebug, hasAction, hasMessage, hasScreen, isOutSet, isPageSet, populate, removeUserFromSession, save, setACL, setAction, setCharSet, setContentType, setDebugVariable, setJNDIContexts, setLayout, setLayoutTemplate, setLocale, setMessage, setMessage, setMessages, setRedirectURI, setScreen, setScreenTemplate, setStackTrace, setStatusCode, setSystemError, setTemplateEncoding, setTitle, setUser, unsetMessage, userExists

Methods inherited from interface org.apache.turbine.util.pool.Recyclable

dispose, isDisposed, recycle

Method Detail

getParameterParser

public ParameterParser getParameterParser()

Gets the parameter parser without parsing the parameters.

Returns:

the parameter parser.

setParameterParser

public void setParameterParser(ParameterParser parser)

Sets the parameter parser.

Parameters:

parser - a parameter parser.

getCookieParser

public CookieParser getCookieParser()

Gets the cookie parser without parsing the cookies.

Returns:

the cookie parser.

setCookieParser

public void setCookieParser(CookieParser parser)

Sets the cookie parser.

Parameters:

parser - a cookie parser.

setRequest

public void setRequest(javax.servlet.http.HttpServletRequest req)

Sets the servlet request.

Parameters:

req - a request.

setResponse

public void setResponse(javax.servlet.http.HttpServletResponse res)

Sets the servlet response.

Parameters:

res - a response.

setSession

public void setSession(javax.servlet.http.HttpSession sess)

Deprecated. No replacement. This method no longer does anything.

Sets the servlet session information.

Parameters:

sess - a session.

setServletConfig

public void setServletConfig(javax.servlet.ServletConfig config)

Sets the servlet configuration used during servlet init.

Parameters:

config - a configuration.

setServerData

public void setServerData(ServerData serverData)

Sets the server data of the request.

Parameters:

serverData - server data.