org.codehaus.plexus.summit.rundata
Interface RunData

All Superinterfaces:

SummitComponent

All Known Implementing Classes:

AbstractRunData, DefaultRunData

public interface RunData
extends SummitComponent

RunData is an interface to run-rime information that is passed within Summit. This provides the threading mechanism for the entire system because multiple requests can potentially come in at the same time. Thus, there is only one RunData implementation for each request that is being serviced.

Version:

$Id: RunData.java 2289 2005-07-11 04:22:34Z jvanzyl $

Author:

Jason van Zyl, Ilkka Priha

Field Summary

static java.lang.String

ROLE

Method Summary

java.lang.String	getContentType() Gets the HTTP content type to return.
java.lang.String	getContextPath() Get the servlet's context path for this webapp.
java.lang.Throwable	getError() Get the error that occurred during request processing
java.util.Map	getMap() Gets the map attribute of the RunData object
RequestParameters	getParameters() Gets the request parameters.
javax.servlet.http.HttpServletRequest	getRequest() Gets the request attribute of the RunData object
Resolution	getResolution() Gets the Resolver attribute of the RunData object
javax.servlet.http.HttpServletResponse	getResponse() Gets the response attribute of the RunData object
java.util.List	getResultMessages()
java.lang.String	getScriptName() Get the initial script name.
java.lang.String	getServerName() Get the server name.
int	getServerPort() Get the server port.
java.lang.String	getServerScheme() Get the server scheme.
javax.servlet.ServletConfig	getServletConfig() Gets the servletConfig attribute of the RunData object
javax.servlet.ServletContext	getServletContext() Get the servlet context for this turbine webapp.
javax.servlet.http.HttpSession	getSession() Gets the session attribute of the RunData object
java.lang.String	getTarget() Gets the target attribute of the RunData object
boolean	hasError() Determine whether an error has occured during request processing
boolean	hasResultMessages()
boolean	hasTarget() Description of the Method
void	setContentType(java.lang.String ct) Sets the HTTP content type to return.
void	setError(java.lang.Throwable error) Set the error that occurred during request processing
void	setMap(java.util.Map map) Sets the map attribute of the RunData object
void	setRequest(javax.servlet.http.HttpServletRequest r) Sets the request attribute of the RunData object
void	setResolution(Resolution resolution) Sets the Resolver attribute of the RunData object
void	setResponse(javax.servlet.http.HttpServletResponse r) Sets the response attribute of the RunData object
void	setResultMessages(java.util.List resulttMessages)
void	setServletConfig(javax.servlet.ServletConfig servletConfig) Sets the servletConfig attribute of the RunData object
void	setTarget(java.lang.String template) Sets the target attribute of the RunData object

Methods inherited from interface org.codehaus.plexus.summit.SummitComponent

getContainer, lookup, lookup

Field Detail

ROLE

static final java.lang.String ROLE

Method Detail

getTarget

java.lang.String getTarget()

Gets the target attribute of the RunData object

setTarget

void setTarget(java.lang.String template)

Sets the target attribute of the RunData object

hasTarget

boolean hasTarget()

Description of the Method

setRequest

void setRequest(javax.servlet.http.HttpServletRequest r)

Sets the request attribute of the RunData object

getRequest

javax.servlet.http.HttpServletRequest getRequest()

Gets the request attribute of the RunData object

setResponse

void setResponse(javax.servlet.http.HttpServletResponse r)

Sets the response attribute of the RunData object

getResponse

javax.servlet.http.HttpServletResponse getResponse()

Gets the response attribute of the RunData object

getSession

javax.servlet.http.HttpSession getSession()

Gets the session attribute of the RunData object

setServletConfig

void setServletConfig(javax.servlet.ServletConfig servletConfig)

Sets the servletConfig attribute of the RunData object

getServletConfig

javax.servlet.ServletConfig getServletConfig()

Gets the servletConfig attribute of the RunData object

setMap

void setMap(java.util.Map map)

Sets the map attribute of the RunData object

getMap

java.util.Map getMap()

Gets the map attribute of the RunData object

getContentType

java.lang.String getContentType()

Gets the HTTP content type to return. If a charset has been specified, it is included in the content type. If the charset has not been specified and the main type of the content type is "text", the default charset is included. If the default charset is undefined, but the default locale is defined and it is not the US locale, a locale specific charset is included.

Returns:

the content type or an empty string.

setContentType

void setContentType(java.lang.String ct)

Sets the HTTP content type to return.

Parameters:

ct - the new content type.

getParameters

RequestParameters getParameters()

Gets the request parameters.

setResolution

void setResolution(Resolution resolution)

Sets the Resolver attribute of the RunData object

getResolution

Resolution getResolution()

Gets the Resolver attribute of the RunData object

getServerName

java.lang.String getServerName()

Get the server name.

getServerPort

int getServerPort()

Get the server port.

getServerScheme

java.lang.String getServerScheme()

Get the server scheme.

getScriptName

java.lang.String getScriptName()

Get the initial script name.

getContextPath

java.lang.String getContextPath()

Get the servlet's context path for this webapp.

getServletContext

javax.servlet.ServletContext getServletContext()

Get the servlet context for this turbine webapp.

hasError

boolean hasError()

Determine whether an error has occured during request processing

setError

void setError(java.lang.Throwable error)

Set the error that occurred during request processing

getError

java.lang.Throwable getError()

Get the error that occurred during request processing

hasResultMessages

boolean hasResultMessages()

setResultMessages

void setResultMessages(java.util.List resulttMessages)

getResultMessages

java.util.List getResultMessages()