|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.turbine.util.pool.RecyclableSupport | +--org.apache.turbine.services.rundata.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 | |
private AccessControlList |
acl
The access control list. |
private java.lang.String |
action
Cached action name to execute for this request. |
private java.lang.String |
charSet
The HTTP charset. |
private javax.servlet.ServletConfig |
config
The servlet configuration. |
private java.lang.String |
contentType
The HTTP content type to return. |
CookieParser |
cookies
A reference to a cookie parser. |
private static java.lang.String |
defaultCharSet
The default charset. |
private static boolean |
defaultCharSetChecked
The default charset checked flag. |
private static java.util.Locale |
defaultLocale
The default locale. |
private static boolean |
defaultLocaleChecked
The default locale checked flag. |
private java.util.Vector |
errors
This is a vector to hold critical system errors. |
private java.util.Hashtable |
jndiContexts
JNDI Contexts. |
private java.lang.String |
layout
This is the layout that the page will use to render the screen. |
private java.util.Locale |
locale
The locale. |
private org.apache.ecs.StringElement |
message
This is where output messages from actions should go. |
private FormMessages |
messages
This is a dedicated message class where output messages from actions should go. |
private java.io.PrintWriter |
out
Cache the output stream because it can be used in many different places. |
private boolean |
outSet
Determines if there is information in the outputstream or not. |
private org.apache.ecs.Document |
page
This creates an ECS Document. |
private boolean |
pageSet
Determines if there is information in the document or not. |
private ParameterParser |
parameters
A reference to the GET/POST data parser. |
private java.lang.String |
redirectURI
If this is set, also set the status code to 302. |
private java.lang.String |
remoteAddr
|
private java.lang.String |
remoteHost
|
private javax.servlet.http.HttpServletRequest |
req
The servlet request interface. |
private javax.servlet.http.HttpServletResponse |
res
The servlet response interface. |
private java.lang.String |
screen
Cached screen name to execute for this request. |
private ServerData |
serverData
Holds ServerData (basic properties) about this RunData object. |
private javax.servlet.ServletContext |
servletContext
The servlet context information. |
private javax.servlet.http.HttpSession |
session
The servlet session information. |
private java.lang.String |
stackTrace
A holder for stack trace. |
private java.lang.Throwable |
stackTraceException
A holder ofr stack trace exception. |
private int |
statusCode
The HTTP status code to return. |
private java.lang.String |
templateEncoding
The character encoding of template files. |
private TemplateInfo |
templateInfo
Information used by a Template system (such as Velocity/Freemarker). |
private java.lang.String |
title
This is what will build the |
private User |
user
The user object. |
private java.lang.String |
userAgent
|
private java.util.Hashtable |
varDebug
Put things here and they will be shown on the default Error screen. |
Fields inherited from class org.apache.turbine.util.pool.RecyclableSupport |
disposed |
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(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. |
void |
dispose()
Disposes a run data object. |
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 |
getCookieParser()
Gets the cookie parser without parsing the cookies. |
CookieParser |
getCookies()
Gets the cookies. |
protected java.lang.String |
getDefaultCharSet()
Gets the default charset defined by a property named "locale.default.charset" or by the specified locale. |
protected static java.util.Locale |
getDefaultLocale()
Gets the default locale defined by properties named "locale.default.lang" and "locale.default.country". |
java.util.Hashtable |
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()
Gets the print writer. |
org.apache.ecs.Document |
getPage()
Gets the page. |
ParameterParser |
getParameterParser()
Gets the parameter parser without parsing the parameters. |
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 ofy 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. |
static User |
getUserFromSession(javax.servlet.http.HttpSession session)
Attempts to get the User object from the session. |
java.util.Hashtable |
getVarDebug()
Gets a table of debug variables. |
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()
Checks to see if out is set. |
boolean |
isPageSet()
Checks to see if the page is set. |
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 a run data object. |
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(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. |
protected void |
setContextPath(java.lang.String cp)
Sets the cached context path that is stored in the server data. |
void |
setCookieParser(CookieParser parser)
Sets the cookie parser. |
void |
setJNDIContexts(java.util.Hashtable 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. |
protected void |
setOut(java.io.PrintWriter out)
Sets the print writer. |
void |
setParameterParser(ParameterParser parser)
Sets the parameter parser. |
void |
setRedirectURI(java.lang.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(java.lang.String screen)
Sets the screen for the request. |
void |
setScreenTemplate(java.lang.String screen)
Sets the screen template for the request. |
protected void |
setScriptName(java.lang.String sn)
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(java.lang.String sn)
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(java.lang.String ss)
Sets the cached server scheme that is stored in the server data. |
void |
setServletConfig(javax.servlet.ServletConfig config)
Setsthe servlet configuration used during servlet init. |
void |
setSession(javax.servlet.http.HttpSession sess)
Sets the servlet session inforamtion. |
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. |
Methods inherited from class org.apache.turbine.util.pool.RecyclableSupport |
doDispose, isDisposed, Recyclable |
Methods inherited from class java.lang.Object |
|
Methods inherited from interface org.apache.turbine.util.pool.Recyclable |
isDisposed |
Field Detail |
private static java.util.Locale defaultLocale
private static boolean defaultLocaleChecked
private static java.lang.String defaultCharSet
private static boolean defaultCharSetChecked
private ParameterParser parameters
public CookieParser cookies
private javax.servlet.http.HttpServletRequest req
private javax.servlet.http.HttpServletResponse res
private javax.servlet.http.HttpSession session
private javax.servlet.ServletConfig config
private javax.servlet.ServletContext servletContext
private AccessControlList acl
private boolean pageSet
private org.apache.ecs.Document page
private java.lang.String action
private java.lang.String layout
private java.lang.String screen
private java.lang.String templateEncoding
private TemplateInfo templateInfo
private org.apache.ecs.StringElement message
private FormMessages messages
private User user
private java.lang.String title
private boolean outSet
private java.io.PrintWriter out
private java.util.Locale locale
private java.lang.String charSet
private java.lang.String contentType
private java.lang.String redirectURI
private int statusCode
private java.util.Vector errors
private java.util.Hashtable jndiContexts
private ServerData serverData
private java.lang.String remoteAddr
getRemoteAddr()
private java.lang.String remoteHost
getRemoteHost()
private java.lang.String userAgent
getUserAgent()
private java.lang.String stackTrace
private java.lang.Throwable stackTraceException
private java.util.Hashtable varDebug
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 java.util.Locale getDefaultLocale()
protected java.lang.String getDefaultCharSet()
locale
- the locale of the charset.public void recycle()
recycle
in interface Recyclable
recycle
in class RecyclableSupport
public void dispose()
dispose
in interface Recyclable
dispose
in class RecyclableSupport
public ParameterParser getParameters()
getParameters
in interface RunData
public 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.public boolean isPageSet()
isPageSet
in interface RunData
public org.apache.ecs.Document getPage()
getPage
in interface RunData
public boolean hasAction()
hasAction
in interface RunData
public java.lang.String getAction()
getAction
in interface RunData
public void setAction(java.lang.String action)
setAction
in interface RunData
action
- a atring.public java.lang.String getLayout()
getLayout
in interface RunData
public void setLayout(java.lang.String layout)
setLayout
in interface RunData
layout
- a string.public java.lang.String getLayoutTemplate()
getLayoutTemplate
in interface RunData
public void setLayoutTemplate(java.lang.String layout)
setLayoutTemplate
in interface RunData
layout
- a layout template.public boolean hasScreen()
hasScreen
in interface RunData
public java.lang.String getScreen()
getScreen
in interface RunData
public void setScreen(java.lang.String screen)
setScreen
in interface RunData
screen
- a string.public java.lang.String getScreenTemplate()
getScreenTemplate
in interface RunData
public void setScreenTemplate(java.lang.String screen)
setScreenTemplate
in interface RunData
screen
- a screen template.public java.lang.String getTemplateEncoding()
getTemplateEncoding
in interface RunData
public void setTemplateEncoding(java.lang.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 java.lang.String getMessage()
getMessage
in interface RunData
public void setMessage(java.lang.String msg)
setMessage
in interface RunData
msg
- a string.public void addMessage(java.lang.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 java.lang.String getTitle()
getTitle
in interface RunData
public void setTitle(java.lang.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
public boolean isOutSet()
isOutSet
in interface RunData
public java.io.PrintWriter getOut() throws java.io.IOException
getOut
in interface RunData
IOException.
- public void declareDirectResponse()
declareDirectResponse
in interface RunData
public java.util.Locale getLocale()
getLocale
in interface RunData
public void setLocale(java.util.Locale locale)
setLocale
in interface RunData
locale
- the new locale.public java.lang.String getCharSet()
getCharSet
in interface RunData
public void setCharSet(java.lang.String charset)
setCharSet
in interface RunData
charset
- the name of the new charset.public java.lang.String getContentType()
getContentType
in interface RunData
public void setContentType(java.lang.String ct)
setContentType
in interface RunData
ct
- a string.public java.lang.String getRedirectURI()
getRedirectURI
in interface RunData
public void setRedirectURI(java.lang.String ruri)
setRedirectURI
in interface RunData
ruri
- a string.public int getStatusCode()
getStatusCode
in interface RunData
public void setStatusCode(int sc)
setStatusCode
in interface RunData
sc
- the status.public SystemError[] getSystemErrors()
getSystemErrors
in interface RunData
public void setSystemError(SystemError err)
setSystemError
in interface RunData
err
- a system error.public java.util.Hashtable getJNDIContexts()
getJNDIContexts
in interface RunData
public void setJNDIContexts(java.util.Hashtable contexts)
setJNDIContexts
in interface RunData
contexts
- a hashtable.public java.lang.String getServerScheme()
getServerScheme
in interface RunData
public java.lang.String getServerName()
getServerName
in interface RunData
public int getServerPort()
getServerPort
in interface RunData
public java.lang.String getContextPath()
getContextPath
in interface RunData
public java.lang.String getScriptName()
getScriptName
in interface RunData
public ServerData getServerData()
getServerData
in interface RunData
public java.lang.String getRemoteAddr()
getRemoteAddr
in interface RunData
public java.lang.String getRemoteHost()
getRemoteHost
in interface RunData
public java.lang.String getUserAgent()
getUserAgent
in interface RunData
public void populate()
populate
in interface RunData
public void save()
save
in interface RunData
public java.lang.String getStackTrace()
getStackTrace
in interface RunData
public java.lang.Throwable getStackTraceException()
getStackTraceException
in interface RunData
public void setStackTrace(java.lang.String trace, java.lang.Throwable exp)
setStackTrace
in interface RunData
trace
- the stack trace.exp
- the exception.public java.util.Hashtable getVarDebug()
getVarDebug
in interface RunData
public ParameterParser getParameterParser()
getParameterParser
in interface TurbineRunData
public void setParameterParser(ParameterParser parser)
setParameterParser
in interface TurbineRunData
parser
- a parameter parser.public CookieParser getCookieParser()
getCookieParser
in interface TurbineRunData
public void setCookieParser(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 setSession(javax.servlet.http.HttpSession sess)
setSession
in interface TurbineRunData
sess
- a session.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.protected void setOut(java.io.PrintWriter out)
out
- a print writer.protected void setServerScheme(java.lang.String ss)
ss
- a string.protected void setServerName(java.lang.String sn)
sn
- a string.protected void setServerPort(int port)
port
- an int.protected void setContextPath(java.lang.String cp)
cp
- a string.protected void setScriptName(java.lang.String sn)
sn
- a string.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |