public class DefaultTurbineRunData extends DefaultPipelineData implements TurbineRunData
DefaultTurbineRunData implements the Recyclable interface making it possible to pool its instances for recycling.
Constructor and Description |
---|
DefaultTurbineRunData()
Constructs a run data object.
|
Modifier and Type | Method and Description |
---|---|
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.
|
<A extends org.apache.fulcrum.security.acl.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.
|
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.
|
String |
getMessageAsHTML()
Gets the results of an action or another message
to be displayed as a string (never null).
|
FormMessages |
getMessages()
Gets a FormMessages object where all the messages to the
user should be stored.
|
PrintWriter |
getOut()
Gets the print writer.
|
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.
|
HttpServletRequest |
getRequest()
Gets the servlet request.
|
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.
|
ServletConfig |
getServletConfig()
Gets the servlet configuration used during servlet init.
|
ServletContext |
getServletContext()
Gets the servlet context used during servlet init.
|
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.
|
<T extends User> |
getUser()
Gets the user.
|
String |
getUserAgent()
Get the user agent for the request.
|
<T extends User> |
getUserFromSession()
Attempts to get the user from the session.
|
static <T extends User> |
getUserFromSession(HttpSession session)
Attempts to get the User object from the session.
|
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
|
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(HttpSession session)
Allows one to invalidate the user in a session.
|
void |
save()
Saves a user object into the session.
|
void |
setACL(org.apache.fulcrum.security.acl.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 |
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(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 |
setRedirectURI(String ruri)
Sets the redirect uri.
|
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.
|
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 |
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.
|
close, get, get, put
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
get, get, getRunData, put
close
public DefaultTurbineRunData()
public static <T extends User> T getUserFromSession(HttpSession session)
T
- a type extending User
session
- An HttpSession.public static boolean removeUserFromSession(HttpSession session)
session
- An HttpSession.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 HttpServletRequest getRequest()
getRequest
in interface RunData
public HttpServletResponse getResponse()
getResponse
in interface RunData
public HttpSession getSession()
getSession
in interface RunData
public ServletConfig getServletConfig()
getServletConfig
in interface RunData
public ServletContext getServletContext()
getServletContext
in interface RunData
public <A extends org.apache.fulcrum.security.acl.AccessControlList> A getACL()
public void setACL(org.apache.fulcrum.security.acl.AccessControlList acl)
TurbineConstants.ACL_SESSION_KEY
.
Invalidate session, if session persist.public boolean hasAction()
public String getAction()
public String getLayout()
public String getLayoutTemplate()
getLayoutTemplate
in interface RunData
public void setLayoutTemplate(String layout)
setLayoutTemplate
in interface RunData
layout
- a layout template.public boolean hasScreen()
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 String getMessageAsHTML()
getMessageAsHTML
in interface RunData
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 boolean userExists()
userExists
in interface RunData
public <T extends User> T getUserFromSession()
getUserFromSession
in interface RunData
T
- a type extending User
public boolean removeUserFromSession()
removeUserFromSession
in interface RunData
@Deprecated public boolean isOutSet()
public PrintWriter getOut() throws IOException
getOut
in interface RunData
IOException
- on failure getting the PrintWriterpublic void declareDirectResponse()
declareDirectResponse
in interface RunData
public Locale getLocale()
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 hashmap.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()
public void save()
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.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 org.apache.fulcrum.parser.CookieParser getCookieParser()
getCookieParser
in interface TurbineRunData
@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
Copyright © 2000–2019 The Apache Software Foundation. All rights reserved.