|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.turbine.pipeline.DefaultPipelineData
org.apache.turbine.services.rundata.DefaultTurbineRunData
public class DefaultTurbineRunData
DefaultTurbineRunData is the default implementation of the TurbineRunData interface, which is distributed by the Turbine RunData service, if another implementation is not defined in the default or specified RunData configuration. TurbineRunData is an extension to RunData, which is an interface to run-rime 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.
DefaultTurbineRunData implements the Recyclable interface making it possible to pool its instances for recycling.
Field Summary | |
---|---|
org.apache.fulcrum.parser.CookieParser |
cookies
A reference to a cookie parser. |
Constructor Summary | |
---|---|
DefaultTurbineRunData()
Constructs a run data object. |
Method Summary | |
---|---|
void |
addMessage(org.apache.ecs.Element msg)
Adds the ECS element to message. |
void |
addMessage(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. |
void |
dispose()
Disposes a run data object. |
AccessControlList |
getACL()
Gets the access control list. |
String |
getAction()
Gets the action. |
String |
getCharSet()
Gets the charset. |
String |
getContentType()
Gets the HTTP content type to return. |
String |
getContextPath()
Gets the cached context path. |
org.apache.fulcrum.parser.CookieParser |
getCookieParser()
Gets the cookie parser without parsing the cookies. |
org.apache.fulcrum.parser.CookieParser |
getCookies()
Gets the cookies. |
Map<String,Object> |
getDebugVariables()
Gets a Map of debug variables. |
protected String |
getDefaultCharSet()
Gets the default charset defined by a property named "locale.default.charset" or by the specified locale. |
protected static Locale |
getDefaultLocale()
Gets the default locale defined by properties named "locale.default.lang" and "locale.default.country". |
Map<String,Context> |
getJNDIContexts()
Gets JNDI Contexts. |
String |
getLayout()
If the Layout has not been defined by the screen then set the layout to be "DefaultLayout". |
String |
getLayoutTemplate()
Convenience method for a template info that returns the layout template being used. |
Locale |
getLocale()
Gets the locale. |
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. |
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 |
org.apache.fulcrum.parser.ParameterParser |
getParameterParser()
Gets the parameter parser without parsing the parameters. |
org.apache.fulcrum.parser.ParameterParser |
getParameters()
Gets the parameters. |
String |
getRedirectURI()
Gets the redirect URI. |
String |
getRemoteAddr()
Gets the IP address of the client that sent the request. |
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. |
String |
getScreen()
Gets the screen to execute. |
String |
getScreenTemplate()
Convenience method for a template info that returns the name of the template being used. |
String |
getScriptName()
Gets the cached script name. |
ServerData |
getServerData()
Gets the server data ofy the request. |
String |
getServerName()
Gets the cached server name. |
int |
getServerPort()
Gets the cached server port. |
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. |
String |
getStackTrace()
Gets the stack trace if set. |
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. |
String |
getTemplateEncoding()
Gets the character encoding to use for reading template files. |
TemplateInfo |
getTemplateInfo()
Gets the template info. |
String |
getTitle()
Gets the title of the page. |
User |
getUser()
Gets the user. |
String |
getUserAgent()
Get the user agent for the request. |
User |
getUserFromSession()
Attempts to get the user from the session. |
static User |
getUserFromSession(javax.servlet.http.HttpSession session)
Attempts to get the User object from the session. |
Map<String,Object> |
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 |
isDisposed()
Checks whether the object is disposed. |
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. |
void |
recycle()
Recycles the object by removing its disposed flag. |
boolean |
removeUserFromSession()
Allows one to invalidate the user in the default session. |
static boolean |
removeUserFromSession(javax.servlet.http.HttpSession session)
Allows one to invalidate the user in a session. |
void |
save()
Saves a user object into the session. |
void |
setACL(AccessControlList acl)
Sets the access control list. |
void |
setAction(String action)
Sets the action for the request. |
void |
setCharSet(String charSet)
Sets the charset. |
void |
setContentType(String contentType)
Sets the HTTP content type to return. |
protected void |
setContextPath(String contextPath)
Sets the cached context path that is stored in the server data. |
void |
setCookieParser(org.apache.fulcrum.parser.CookieParser parser)
Sets the cookie parser. |
void |
setDebugVariable(String name,
Object value)
Sets a name/value pair in an internal Map that is accessible from the Error screen. |
void |
setJNDIContexts(Map<String,Context> contexts)
Sets JNDI Contexts. |
void |
setLayout(String layout)
Set the layout for the request. |
void |
setLayoutTemplate(String layout)
Modifies the layout template for the screen. |
void |
setLocale(Locale locale)
Sets the locale. |
void |
setMessage(org.apache.ecs.Element msg)
Sets the message for the request as an ECS element. |
void |
setMessage(String msg)
Sets the message for the request as a string. |
void |
setMessages(FormMessages msgs)
Sets the FormMessages object for the request. |
protected void |
setOut(PrintWriter out)
Deprecated. no replacement planned, response writer will not be cached |
void |
setParameterParser(org.apache.fulcrum.parser.ParameterParser parser)
Sets the parameter parser. |
void |
setRedirectURI(String ruri)
Sets the redirect uri. |
void |
setRequest(javax.servlet.http.HttpServletRequest req)
Sets the servlet request. |
void |
setResponse(javax.servlet.http.HttpServletResponse res)
Sets the servlet response. |
void |
setScreen(String screen)
Sets the screen for the request. |
void |
setScreenTemplate(String screen)
Sets the screen template for the request. |
protected void |
setScriptName(String scriptName)
Sets the cached script name that is stored in the server data. |
void |
setServerData(ServerData serverData)
Sets the server data of the request. |
protected void |
setServerName(String serverName)
Sets the cached server same that is stored in the server data. |
protected void |
setServerPort(int port)
Sets the cached server port that is stored in the server data. |
protected void |
setServerScheme(String serverScheme)
Sets the cached server scheme that is stored in the server data. |
void |
setServletConfig(javax.servlet.ServletConfig config)
Sets the servlet configuration used during servlet init. |
void |
setStackTrace(String trace,
Throwable exp)
Sets the stack trace. |
void |
setStatusCode(int statusCode)
Sets the HTTP status code to return. |
void |
setSystemError(SystemError err)
Adds a critical system error. |
void |
setTemplateEncoding(String encoding)
Sets the character encoding to use for reading template files. |
void |
setTitle(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. |
Methods inherited from class org.apache.turbine.pipeline.DefaultPipelineData |
---|
get, get, put |
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.pipeline.PipelineData |
---|
get, get, put |
Field Detail |
---|
public org.apache.fulcrum.parser.CookieParser cookies
Constructor Detail |
---|
public DefaultTurbineRunData()
Method Detail |
---|
public static User getUserFromSession(javax.servlet.http.HttpSession session)
session
- An HttpSession.
public static boolean removeUserFromSession(javax.servlet.http.HttpSession session)
session
- An HttpSession.
protected static Locale getDefaultLocale()
protected String getDefaultCharSet()
public void recycle()
recycle
in interface org.apache.fulcrum.pool.Recyclable
public void dispose()
dispose
in interface org.apache.fulcrum.pool.Recyclable
public org.apache.fulcrum.parser.ParameterParser getParameters()
getParameters
in interface RunData
public org.apache.fulcrum.parser.CookieParser getCookies()
getCookies
in interface RunData
public javax.servlet.http.HttpServletRequest getRequest()
getRequest
in interface RunData
public javax.servlet.http.HttpServletResponse getResponse()
getResponse
in interface RunData
public javax.servlet.http.HttpSession getSession()
getSession
in interface RunData
public javax.servlet.ServletConfig getServletConfig()
getServletConfig
in interface RunData
public javax.servlet.ServletContext getServletContext()
getServletContext
in interface RunData
public AccessControlList getACL()
getACL
in interface RunData
public void setACL(AccessControlList acl)
setACL
in interface RunData
acl
- an access control list.@Deprecated public boolean isPageSet()
isPageSet
in interface RunData
@Deprecated public org.apache.ecs.Document getPage()
getPage
in interface RunData
public boolean hasAction()
hasAction
in interface RunData
public String getAction()
getAction
in interface RunData
public void setAction(String action)
setAction
in interface RunData
action
- a atring.public String getLayout()
getLayout
in interface RunData
public void setLayout(String layout)
setLayout
in interface RunData
layout
- a string.public String getLayoutTemplate()
getLayoutTemplate
in interface RunData
public void setLayoutTemplate(String layout)
setLayoutTemplate
in interface RunData
layout
- a layout template.public boolean hasScreen()
hasScreen
in interface RunData
public String getScreen()
getScreen
in interface RunData
public void setScreen(String screen)
setScreen
in interface RunData
screen
- a string.public String getScreenTemplate()
getScreenTemplate
in interface RunData
public void setScreenTemplate(String screen)
setScreenTemplate
in interface RunData
screen
- a screen template.public String getTemplateEncoding()
getTemplateEncoding
in interface RunData
public void setTemplateEncoding(String encoding)
setTemplateEncoding
in interface RunData
encoding
- the template encoding.public TemplateInfo getTemplateInfo()
getTemplateInfo
in interface RunData
public boolean hasMessage()
hasMessage
in interface RunData
public String getMessage()
getMessage
in interface RunData
public void setMessage(String msg)
setMessage
in interface RunData
msg
- a string.public void addMessage(String msg)
addMessage
in interface RunData
msg
- a string.public org.apache.ecs.StringElement getMessageAsHTML()
getMessageAsHTML
in interface RunData
public void setMessage(org.apache.ecs.Element msg)
setMessage
in interface RunData
msg
- an element.public void addMessage(org.apache.ecs.Element msg)
addMessage
in interface RunData
msg
- an element.public void unsetMessage()
unsetMessage
in interface RunData
public FormMessages getMessages()
getMessages
in interface RunData
public void setMessages(FormMessages msgs)
setMessages
in interface RunData
msgs
- A FormMessages.public String getTitle()
getTitle
in interface RunData
public void setTitle(String title)
setTitle
in interface RunData
title
- a string.public boolean userExists()
userExists
in interface RunData
public User getUser()
getUser
in interface RunData
public void setUser(User user)
setUser
in interface RunData
user
- a user.public User getUserFromSession()
getUserFromSession
in interface RunData
public boolean removeUserFromSession()
removeUserFromSession
in interface RunData
@Deprecated public boolean isOutSet()
isOutSet
in interface RunData
@Deprecated public PrintWriter getOut() throws IOException
getOut
in interface RunData
IOException
public void declareDirectResponse()
declareDirectResponse
in interface RunData
public Locale getLocale()
getLocale
in interface RunData
public void setLocale(Locale locale)
setLocale
in interface RunData
locale
- the new locale.public String getCharSet()
getCharSet
in interface RunData
public void setCharSet(String charSet)
setCharSet
in interface RunData
charSet
- the name of the new charset.public String getContentType()
getContentType
in interface RunData
public void setContentType(String contentType)
setContentType
in interface RunData
contentType
- a string.public String getRedirectURI()
getRedirectURI
in interface RunData
public void setRedirectURI(String ruri)
setRedirectURI
in interface RunData
ruri
- a string.public int getStatusCode()
getStatusCode
in interface RunData
public void setStatusCode(int statusCode)
setStatusCode
in interface RunData
statusCode
- the status.public SystemError[] getSystemErrors()
getSystemErrors
in interface RunData
public void setSystemError(SystemError err)
setSystemError
in interface RunData
err
- a system error.public Map<String,Context> getJNDIContexts()
getJNDIContexts
in interface RunData
public void setJNDIContexts(Map<String,Context> contexts)
setJNDIContexts
in interface RunData
contexts
- a hashtable.public String getServerScheme()
getServerScheme
in interface RunData
public String getServerName()
getServerName
in interface RunData
public int getServerPort()
getServerPort
in interface RunData
public String getContextPath()
getContextPath
in interface RunData
public String getScriptName()
getScriptName
in interface RunData
public ServerData getServerData()
getServerData
in interface RunData
public String getRemoteAddr()
getRemoteAddr
in interface RunData
public String getRemoteHost()
getRemoteHost
in interface RunData
public String getUserAgent()
getUserAgent
in interface RunData
public void populate()
populate
in interface RunData
public void save()
save
in interface RunData
public String getStackTrace()
getStackTrace
in interface RunData
public Throwable getStackTraceException()
getStackTraceException
in interface RunData
public void setStackTrace(String trace, Throwable exp)
setStackTrace
in interface RunData
trace
- the stack trace.exp
- the exception.@Deprecated public Map<String,Object> getVarDebug()
getDebugVariables()
instead
getVarDebug
in interface RunData
public void setDebugVariable(String name, Object value)
setDebugVariable
in interface RunData
name
- name of the variablevalue
- value of the variable.public Map<String,Object> getDebugVariables()
getDebugVariables
in interface RunData
public org.apache.fulcrum.parser.ParameterParser getParameterParser()
getParameterParser
in interface TurbineRunData
public void setParameterParser(org.apache.fulcrum.parser.ParameterParser parser)
setParameterParser
in interface TurbineRunData
parser
- a parameter parser.public org.apache.fulcrum.parser.CookieParser getCookieParser()
getCookieParser
in interface TurbineRunData
public void setCookieParser(org.apache.fulcrum.parser.CookieParser parser)
setCookieParser
in interface TurbineRunData
parser
- a cookie parser.public void setRequest(javax.servlet.http.HttpServletRequest req)
setRequest
in interface TurbineRunData
req
- a request.public void setResponse(javax.servlet.http.HttpServletResponse res)
setResponse
in interface TurbineRunData
res
- a response.public void setServletConfig(javax.servlet.ServletConfig config)
setServletConfig
in interface TurbineRunData
config
- a configuration.public void setServerData(ServerData serverData)
setServerData
in interface TurbineRunData
serverData
- server data.@Deprecated protected void setOut(PrintWriter out)
out
- a print writer.protected void setServerScheme(String serverScheme)
serverScheme
- a string.protected void setServerName(String serverName)
serverName
- a string.protected void setServerPort(int port)
port
- an int.protected void setContextPath(String contextPath)
contextPath
- a string.protected void setScriptName(String scriptName)
scriptName
- a string.public boolean isDisposed()
isDisposed
in interface org.apache.fulcrum.pool.Recyclable
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |