public interface RunData extends PipelineData
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.
|
<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 |
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.
|
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 |
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 used by 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.
|
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
|
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.
|
<A extends org.apache.fulcrum.security.acl.AccessControlList> |
setACL(A 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 ct)
Sets the HTTP content type to return.
|
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.
|
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.
|
void |
setStackTrace(String trace,
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(String encoding)
Sets the character encoding to use for reading template files.
|
void |
setTitle(String title)
Sets the title of the page.
|
<T extends User> |
setUser(T user)
Sets the user.
|
void |
unsetMessage()
Unsets the message for the request.
|
boolean |
userExists()
Checks if a user exists in this session.
|
get, get, getRunData, put
close
org.apache.fulcrum.parser.ParameterParser getParameters()
org.apache.fulcrum.parser.CookieParser getCookies()
HttpServletRequest getRequest()
HttpServletResponse getResponse()
HttpSession getSession()
ServletConfig getServletConfig()
ServletContext getServletContext()
<A extends org.apache.fulcrum.security.acl.AccessControlList> A getACL()
A
- a type extending AccessControlList
<A extends org.apache.fulcrum.security.acl.AccessControlList> void setACL(A acl)
A
- ACL typeacl
- an access control list.boolean hasAction()
String getAction()
void setAction(String action)
action
- a string.String getLayout()
void setLayout(String layout)
layout
- a string.String getLayoutTemplate()
void setLayoutTemplate(String layout)
layout
- a layout template.boolean hasScreen()
void setScreen(String screen)
screen
- a string.String getScreenTemplate()
void setScreenTemplate(String screen)
screen
- a screen template.String getTemplateEncoding()
void setTemplateEncoding(String encoding)
encoding
- the template encoding.TemplateInfo getTemplateInfo()
boolean hasMessage()
String getMessage()
void setMessage(String msg)
msg
- a string.void addMessage(String msg)
msg
- a string.String getMessageAsHTML()
void unsetMessage()
FormMessages getMessages()
void setMessages(FormMessages msgs)
msgs
- A FormMessages.boolean userExists()
<T extends User> T getUser()
T
- a type extending User
<T extends User> void setUser(T user)
T
- a type extending User
user
- a user.<T extends User> T getUserFromSession()
T
- a type extending User
boolean removeUserFromSession()
@Deprecated boolean isOutSet()
PrintWriter getOut() throws IOException
IOException
- on failure getting the PrintWritervoid declareDirectResponse()
Locale getLocale()
String getCharSet()
void setCharSet(String charset)
charset
- the name of the new charset.String getContentType()
void setContentType(String ct)
ct
- the new content type.String getRedirectURI()
void setRedirectURI(String ruri)
ruri
- a string.int getStatusCode()
void setStatusCode(int sc)
sc
- the status.SystemError[] getSystemErrors()
void setSystemError(SystemError err)
err
- a system error.Map<String,Context> getJNDIContexts()
void setJNDIContexts(Map<String,Context> contexts)
contexts
- a hashtable.String getServerScheme()
String getServerName()
int getServerPort()
String getContextPath()
String getScriptName()
ServerData getServerData()
String getRemoteAddr()
String getRemoteHost()
String getUserAgent()
void populate()
void save()
String getStackTrace()
Throwable getStackTraceException()
void setStackTrace(String trace, Throwable exp)
trace
- the stack trace.exp
- the exception.void setDebugVariable(String name, Object value)
name
- name of the variablevalue
- value of the variable.Map<String,Object> getDebugVariables()
Copyright © 2000–2019 The Apache Software Foundation. All rights reserved.