|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RunData
RunData is an interface to run-time information that is passed within Turbine. 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.
Method Summary | |
---|---|
void |
addMessage(org.apache.ecs.Element msg)
Adds the ECS element to message. |
void |
addMessage(java.lang.String msg)
Adds the string to message. |
void |
declareDirectResponse()
Declares that output will be direct to the response stream, even though getOut() may never be called. |
AccessControlList |
getACL()
Gets the access control list. |
java.lang.String |
getAction()
Gets the action. |
java.lang.String |
getCharSet()
Gets the charset. |
java.lang.String |
getContentType()
Gets the HTTP content type to return. |
java.lang.String |
getContextPath()
Gets the cached context path. |
CookieParser |
getCookies()
Gets the cookies. |
java.util.Map |
getDebugVariables()
Gets a Map of debug variables. |
java.util.Map |
getJNDIContexts()
Gets JNDI Contexts. |
java.lang.String |
getLayout()
If the Layout has not been defined by the screen then set the layout to be "DefaultLayout". |
java.lang.String |
getLayoutTemplate()
Convenience method for a template info that returns the layout template being used. |
java.util.Locale |
getLocale()
Gets the locale. |
java.lang.String |
getMessage()
Gets the results of an action or another message to be displayed as a string. |
org.apache.ecs.StringElement |
getMessageAsHTML()
Gets the results of an action or another message to be displayed as an ECS string element. |
FormMessages |
getMessages()
Gets a FormMessages object where all the messages to the user should be stored. |
java.io.PrintWriter |
getOut()
Deprecated. no replacement planned, response writer will not be cached |
org.apache.ecs.Document |
getPage()
Deprecated. no replacement planned, ECS is no longer a requirement |
ParameterParser |
getParameters()
Gets the parameters. |
java.lang.String |
getRedirectURI()
Gets the redirect URI. |
java.lang.String |
getRemoteAddr()
Gets the IP address of the client that sent the request. |
java.lang.String |
getRemoteHost()
Gets the qualified name of the client that sent the request. |
javax.servlet.http.HttpServletRequest |
getRequest()
Gets the servlet request. |
javax.servlet.http.HttpServletResponse |
getResponse()
Gets the servlet response. |
java.lang.String |
getScreen()
Gets the screen to execute. |
java.lang.String |
getScreenTemplate()
Convenience method for a template info that returns the name of the template being used. |
java.lang.String |
getScriptName()
Gets the cached script name. |
ServerData |
getServerData()
Gets the server data used by the request. |
java.lang.String |
getServerName()
Gets the cached server name. |
int |
getServerPort()
Gets the cached server port. |
java.lang.String |
getServerScheme()
Gets the cached server scheme. |
javax.servlet.ServletConfig |
getServletConfig()
Gets the servlet configuration used during servlet init. |
javax.servlet.ServletContext |
getServletContext()
Gets the servlet context used during servlet init. |
javax.servlet.http.HttpSession |
getSession()
Gets the servlet session information. |
java.lang.String |
getStackTrace()
Gets the stack trace if set. |
java.lang.Throwable |
getStackTraceException()
Gets the stack trace exception if set. |
int |
getStatusCode()
Gets the HTTP status code to return. |
SystemError[] |
getSystemErrors()
Gets an array of system errors. |
java.lang.String |
getTemplateEncoding()
Gets the character encoding to use for reading template files. |
TemplateInfo |
getTemplateInfo()
Gets the template info. |
java.lang.String |
getTitle()
Gets the title of the page. |
User |
getUser()
Gets the user. |
java.lang.String |
getUserAgent()
Get the user agent for the request. |
User |
getUserFromSession()
Attempts to get the user from the session. |
java.util.Map |
getVarDebug()
Deprecated. use getDebugVariables() instead |
boolean |
hasAction()
Whether or not an action has been defined. |
boolean |
hasMessage()
Whether or not a message has been defined. |
boolean |
hasScreen()
Whether or not a screen has been defined. |
boolean |
isOutSet()
Deprecated. no replacement planned, response writer will not be cached |
boolean |
isPageSet()
Deprecated. no replacement planned, ECS is no longer a requirement |
void |
populate()
Pulls a user object from the session and increments the access counter and sets the last access date for the object. |
boolean |
removeUserFromSession()
Allows one to invalidate the user in the default session. |
void |
save()
Saves a user object into the session. |
void |
setACL(AccessControlList acl)
Sets the access control list. |
void |
setAction(java.lang.String action)
Sets the action for the request. |
void |
setCharSet(java.lang.String charset)
Sets the charset. |
void |
setContentType(java.lang.String ct)
Sets the HTTP content type to return. |
void |
setDebugVariable(java.lang.String name,
java.lang.Object value)
Sets a name/value pair in an internal Map that is accessible from the Error screen. |
void |
setJNDIContexts(java.util.Map contexts)
Sets JNDI Contexts. |
void |
setLayout(java.lang.String layout)
Set the layout for the request. |
void |
setLayoutTemplate(java.lang.String layout)
Modifies the layout template for the screen. |
void |
setLocale(java.util.Locale locale)
Sets the locale. |
void |
setMessage(org.apache.ecs.Element msg)
Sets the message for the request as an ECS element. |
void |
setMessage(java.lang.String msg)
Sets the message for the request as a string. |
void |
setMessages(FormMessages msgs)
Sets the FormMessages object for the request. |
void |
setRedirectURI(java.lang.String ruri)
Sets the redirect uri. |
void |
setScreen(java.lang.String screen)
Sets the screen for the request. |
void |
setScreenTemplate(java.lang.String screen)
Sets the screen template for the request. |
void |
setStackTrace(java.lang.String trace,
java.lang.Throwable exp)
Sets the stack trace. |
void |
setStatusCode(int sc)
Sets the HTTP status code to return. |
void |
setSystemError(SystemError err)
Adds a critical system error. |
void |
setTemplateEncoding(java.lang.String encoding)
Sets the character encoding to use for reading template files. |
void |
setTitle(java.lang.String title)
Sets the title of the page. |
void |
setUser(User user)
Sets the user. |
void |
unsetMessage()
Unsets the message for the request. |
boolean |
userExists()
Checks if a user exists in this session. |
Method Detail |
---|
ParameterParser getParameters()
CookieParser getCookies()
javax.servlet.http.HttpServletRequest getRequest()
javax.servlet.http.HttpServletResponse getResponse()
javax.servlet.http.HttpSession getSession()
javax.servlet.ServletConfig getServletConfig()
javax.servlet.ServletContext getServletContext()
AccessControlList getACL()
void setACL(AccessControlList acl)
acl
- an access control list.boolean isPageSet()
org.apache.ecs.Document getPage()
boolean hasAction()
java.lang.String getAction()
void setAction(java.lang.String action)
action
- a atring.java.lang.String getLayout()
void setLayout(java.lang.String layout)
layout
- a string.java.lang.String getLayoutTemplate()
void setLayoutTemplate(java.lang.String layout)
layout
- a layout template.boolean hasScreen()
java.lang.String getScreen()
void setScreen(java.lang.String screen)
screen
- a string.java.lang.String getScreenTemplate()
void setScreenTemplate(java.lang.String screen)
screen
- a screen template.java.lang.String getTemplateEncoding()
void setTemplateEncoding(java.lang.String encoding)
encoding
- the template encoding.TemplateInfo getTemplateInfo()
boolean hasMessage()
java.lang.String getMessage()
void setMessage(java.lang.String msg)
msg
- a string.void addMessage(java.lang.String msg)
msg
- a string.org.apache.ecs.StringElement getMessageAsHTML()
void setMessage(org.apache.ecs.Element msg)
msg
- an element.void addMessage(org.apache.ecs.Element msg)
msg
- an element.void unsetMessage()
FormMessages getMessages()
void setMessages(FormMessages msgs)
msgs
- A FormMessages.java.lang.String getTitle()
void setTitle(java.lang.String title)
title
- a string.boolean userExists()
User getUser()
void setUser(User user)
user
- a user.User getUserFromSession()
boolean removeUserFromSession()
boolean isOutSet()
java.io.PrintWriter getOut() throws java.io.IOException
java.io.IOException
void declareDirectResponse()
java.util.Locale getLocale()
void setLocale(java.util.Locale locale)
locale
- the new locale.java.lang.String getCharSet()
void setCharSet(java.lang.String charset)
charset
- the name of the new charset.java.lang.String getContentType()
void setContentType(java.lang.String ct)
ct
- the new content type.java.lang.String getRedirectURI()
void setRedirectURI(java.lang.String ruri)
ruri
- a string.int getStatusCode()
void setStatusCode(int sc)
sc
- the status.SystemError[] getSystemErrors()
void setSystemError(SystemError err)
err
- a system error.java.util.Map getJNDIContexts()
void setJNDIContexts(java.util.Map contexts)
contexts
- a hashtable.java.lang.String getServerScheme()
java.lang.String getServerName()
int getServerPort()
java.lang.String getContextPath()
java.lang.String getScriptName()
ServerData getServerData()
java.lang.String getRemoteAddr()
java.lang.String getRemoteHost()
java.lang.String getUserAgent()
void populate()
void save()
java.lang.String getStackTrace()
java.lang.Throwable getStackTraceException()
void setStackTrace(java.lang.String trace, java.lang.Throwable exp)
trace
- the stack trace.exp
- the exception.java.util.Map getVarDebug()
getDebugVariables()
instead
void setDebugVariable(java.lang.String name, java.lang.Object value)
name
- name of the variablevalue
- value of the variable.java.util.Map getDebugVariables()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |