Java Doc for DefaultTurbineRunData.java in » Web-Framework » TURBINE » org » apache » turbine » services » rundata » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Web Framework » TURBINE » org.apache.turbine.services.rundata

Source Cross Reference

Class Diagram

Java Document (Java Doc)

java.lang .Object

org.apache.turbine.util.pool .RecyclableSupport

org.apache.turbine.services.rundata .DefaultTurbineRunData

DefaultTurbineRunData
public class DefaultTurbineRunData extends RecyclableSupport implements TurbineRunData(Code)
	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. author: Ilkka Priha author: Jon S. Stevens author: Bernie Hoeneisen author: Daniel Rall author: Henning P. Schmiedehausen author: Quinton McCombs version: $Id: DefaultTurbineRunData.java 534527 2007-05-02 16:10:59Z tv $

Field Summary
public CookieParser	cookies A reference to a cookie parser.

Constructor Summary
public	DefaultTurbineRunData() Constructs a run data object.

Method Summary
public void	addMessage(String msg) Adds the string to message.
public void	addMessage(Element msg) Adds the ECS element to message.
public void	declareDirectResponse() Declares that output will be direct to the response stream, even though getOut() may never be called.
public void	dispose() Disposes a run data object.
public AccessControlList	getACL() Gets the access control list.
public String	getAction() Gets the action.
public String	getCharSet() Gets the charset.
public String	getContentType() Gets the HTTP content type to return.
public String	getContextPath() Gets the cached context path.
public CookieParser	getCookieParser() Gets the cookie parser without parsing the cookies.
public CookieParser	getCookies() Gets the cookies.
public Map	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".
public Map	getJNDIContexts() Gets JNDI Contexts.
public String	getLayout() If the Layout has not been defined by the screen then set the layout to be "DefaultLayout".
public String	getLayoutTemplate() Convenience method for a template info that returns the layout template being used.
public Locale	getLocale() Gets the locale.
public String	getMessage() Gets the results of an action or another message to be displayed as a string.
public StringElement	getMessageAsHTML() Gets the results of an action or another message to be displayed as an ECS string element.
public FormMessages	getMessages() Gets a FormMessages object where all the messages to the user should be stored.
public PrintWriter	getOut() Gets the print writer.
public Document	getPage() Gets the page.
public ParameterParser	getParameterParser() Gets the parameter parser without parsing the parameters.
public ParameterParser	getParameters() Gets the parameters.
public String	getRedirectURI() Gets the redirect URI.
public String	getRemoteAddr() Gets the IP address of the client that sent the request.
public String	getRemoteHost() Gets the qualified name of the client that sent the request.
public HttpServletRequest	getRequest() Gets the servlet request.
public HttpServletResponse	getResponse() Gets the servlet response.
public String	getScreen() Gets the screen to execute.
public String	getScreenTemplate() Convenience method for a template info that returns the name of the template being used.
public String	getScriptName() Gets the cached script name.
public ServerData	getServerData() Gets the server data ofy the request.
public String	getServerName() Gets the cached server name.
public int	getServerPort() Gets the cached server port.
public String	getServerScheme() Gets the cached server scheme.
public ServletConfig	getServletConfig() Gets the servlet configuration used during servlet init.
public ServletContext	getServletContext() Gets the servlet context used during servlet init.
public HttpSession	getSession() Gets the servlet session information.
public String	getStackTrace() Gets the stack trace if set.
public Throwable	getStackTraceException() Gets the stack trace exception if set.
public int	getStatusCode() Gets the HTTP status code to return.
public SystemError[]	getSystemErrors() Gets an array of system errors.
public String	getTemplateEncoding() Gets the character encoding to use for reading template files.
public TemplateInfo	getTemplateInfo() Gets the template info.
public String	getTitle() Gets the title of the page.
public User	getUser() Gets the user.
public String	getUserAgent() Get the user agent for the request.
public static User	getUserFromSession(HttpSession session) Attempts to get the User object from the session.
public User	getUserFromSession() Attempts to get the user from the session.
public Map	getVarDebug() Gets a Map of debug variables.
public boolean	hasAction() Whether or not an action has been defined.
public boolean	hasMessage() Whether or not a message has been defined.
public boolean	hasScreen() Whether or not a screen has been defined.
public boolean	isOutSet() Checks to see if out is set.
public boolean	isPageSet() Checks to see if the page is set.
public void	populate() Pulls a user object from the session and increments the access counter and sets the last access date for the object.
public void	recycle() Recycles a run data object.
public static boolean	removeUserFromSession(HttpSession session) Allows one to invalidate the user in a session. Parameters: session - An HttpSession.
public boolean	removeUserFromSession() Allows one to invalidate the user in the default session.
public void	save() Saves a user object into the session.
public void	setACL(AccessControlList acl) Sets the access control list.
public void	setAction(String action) Sets the action for the request.
public void	setCharSet(String charSet) Sets the charset.
public 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.
public void	setCookieParser(CookieParser parser) Sets the cookie parser.
public void	setDebugVariable(String name, Object value) Sets a name/value pair in an internal Map that is accessible from the Error screen.
public void	setJNDIContexts(Map contexts) Sets JNDI Contexts.
public void	setLayout(String layout) Set the layout for the request.
public void	setLayoutTemplate(String layout) Modifies the layout template for the screen.
public void	setLocale(Locale locale) Sets the locale.
public void	setMessage(String msg) Sets the message for the request as a string.
public void	setMessage(Element msg) Sets the message for the request as an ECS element.
public void	setMessages(FormMessages msgs) Sets the FormMessages object for the request.
protected void	setOut(PrintWriter out) Sets the print writer.
public void	setParameterParser(ParameterParser parser) Sets the parameter parser.
public void	setRedirectURI(String ruri) Sets the redirect uri.
public void	setRequest(HttpServletRequest req) Sets the servlet request.
public void	setResponse(HttpServletResponse res) Sets the servlet response.
public void	setScreen(String screen) Sets the screen for the request.
public 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.
public 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.
public void	setServletConfig(ServletConfig config) Sets the servlet configuration used during servlet init.
public void	setSession(HttpSession sess) Sets the servlet session information.
public void	setStackTrace(String trace, Throwable exp) Sets the stack trace.
public void	setStatusCode(int statusCode) Sets the HTTP status code to return.
public void	setSystemError(SystemError err) Adds a critical system error.
public void	setTemplateEncoding(String encoding) Sets the character encoding to use for reading template files.
public void	setTitle(String title) Sets the title of the page.
public void	setUser(User user) Sets the user.
public void	unsetMessage() Unsets the message for the request.
public boolean	userExists() Checks if a user exists in this session.

Field Detail

cookies
public CookieParser cookies(Code)
	A reference to a cookie parser.

Constructor Detail

DefaultTurbineRunData
public DefaultTurbineRunData()(Code)
	Constructs a run data object.

Method Detail

addMessage
public void addMessage(String msg)(Code)
	Adds the string to message. If message has prior messages from other actions or screens, this method can be used to chain them. Parameters: msg - a string.

addMessage
public void addMessage(Element msg)(Code)
	Adds the ECS element to message. If message has prior messages from other actions or screens, this method can be used to chain them. Parameters: msg - an element.

declareDirectResponse
public void declareDirectResponse()(Code)
	Declares that output will be direct to the response stream, even though getOut() may never be called. Useful for response mechanisms that may call res.getWriter() themselves (such as JSP.)

dispose
public void dispose()(Code)
	Disposes a run data object.

getACL
public AccessControlList getACL()(Code)
	Gets the access control list. the access control list.

getAction
public String getAction()(Code)
	Gets the action. It returns an empty string if null so that it is easy to do conditionals on it based on the equalsIgnoreCase() method. a string, "" if null.

getCharSet
public String getCharSet()(Code)
	Gets the charset. If it has not already been defined with setCharSet(), then a property named "locale.default.charset" is checked from the Resource Service and returned. If this property is undefined, the default charset of the locale is returned. If the locale is undefined, null is returned. the name of the charset or null.

getContentType
public String getContentType()(Code)
	Gets the HTTP content type to return. If a charset has been specified, it is included in the content type. If the charset has not been specified and the main type of the content type is "text", the default charset is included. If the default charset is undefined, but the default locale is defined and it is not the US locale, a locale specific charset is included. the content type or an empty string.

getContextPath
public String getContextPath()(Code)
	Gets the cached context path. a string.

getCookieParser
public CookieParser getCookieParser()(Code)
	Gets the cookie parser without parsing the cookies. the cookie parser.

getCookies
public CookieParser getCookies()(Code)
	Gets the cookies. a cookie parser.

getDebugVariables
public Map getDebugVariables()(Code)
	Gets a Map of debug variables. a Map of debug variables.

getDefaultCharSet
protected String getDefaultCharSet()(Code)
	Gets the default charset defined by a property named "locale.default.charset" or by the specified locale. If the specified locale is null, the default locale is applied. the name of the default charset or null.

getDefaultLocale
protected static Locale getDefaultLocale()(Code)
	Gets the default locale defined by properties named "locale.default.lang" and "locale.default.country". This changed from earlier Turbine versions that you can rely on getDefaultLocale() to never return null. A Locale object.

getJNDIContexts
public Map getJNDIContexts()(Code)
	Gets JNDI Contexts. a hashtable.

getLayout
public String getLayout()(Code)
	If the Layout has not been defined by the screen then set the layout to be "DefaultLayout". The screen object can also override this method to provide intelligent determination of the Layout to execute. You can also define that logic here as well if you want it to apply on a global scale. For example, if you wanted to allow someone to define layout "preferences" where they could dynamicially change the layout for the entire site. a string.

getLayoutTemplate
public String getLayoutTemplate()(Code)
	Convenience method for a template info that returns the layout template being used. a string.

getLocale
public Locale getLocale()(Code)
	Gets the locale. If it has not already been defined with setLocale(), then properties named "locale.default.lang" and "locale.default.country" are checked from the Resource Service and the corresponding locale is returned. If these properties are undefined, JVM's default locale is returned. the locale.

getMessage
public String getMessage()(Code)
	Gets the results of an action or another message to be displayed as a string. a string.

getMessageAsHTML
public StringElement getMessageAsHTML()(Code)
	Gets the results of an action or another message to be displayed as an ECS string element. a string element.

getMessages
public FormMessages getMessages()(Code)
	Gets a FormMessages object where all the messages to the user should be stored. a FormMessages.

getOut
public PrintWriter getOut() throws IOException(Code)
	Gets the print writer. First time calling this will set the print writer via the response. a print writer. throws: IOException -

getPage
public Document getPage()(Code)
	Gets the page. a document.

getParameterParser
public ParameterParser getParameterParser()(Code)
	Gets the parameter parser without parsing the parameters. the parameter parser.

getParameters
public ParameterParser getParameters()(Code)
	Gets the parameters. a parameter parser.

getRedirectURI
public String getRedirectURI()(Code)
	Gets the redirect URI. If this is set, also make sure to set the status code to 302. a string, "" if null.

getRemoteAddr
public String getRemoteAddr()(Code)
	Gets the IP address of the client that sent the request. a string.

getRemoteHost
public String getRemoteHost()(Code)
	Gets the qualified name of the client that sent the request. a string.

getRequest
public HttpServletRequest getRequest()(Code)
	Gets the servlet request. the request.

getResponse
public HttpServletResponse getResponse()(Code)
	Gets the servlet response. the response.

getScreen
public String getScreen()(Code)
	Gets the screen to execute. a string.

getScreenTemplate
public String getScreenTemplate()(Code)
	Convenience method for a template info that returns the name of the template being used. a string.

getScriptName
public String getScriptName()(Code)
	Gets the cached script name. a string.

getServerData
public ServerData getServerData()(Code)
	Gets the server data ofy the request. server data.

getServerName
public String getServerName()(Code)
	Gets the cached server name. a string.

getServerPort
public int getServerPort()(Code)
	Gets the cached server port. an int.

getServerScheme
public String getServerScheme()(Code)
	Gets the cached server scheme. a string.

getServletConfig
public ServletConfig getServletConfig()(Code)
	Gets the servlet configuration used during servlet init. the configuration.

getServletContext
public ServletContext getServletContext()(Code)
	Gets the servlet context used during servlet init. the context.

getSession
public HttpSession getSession()(Code)
	Gets the servlet session information. the session.

getStackTrace
public String getStackTrace()(Code)
	Gets the stack trace if set. the stack trace.

getStackTraceException
public Throwable getStackTraceException()(Code)
	Gets the stack trace exception if set. the stack exception.

getStatusCode
public int getStatusCode()(Code)
	Gets the HTTP status code to return. the status.

getSystemErrors
public SystemError[] getSystemErrors()(Code)
	Gets an array of system errors. a SystemError[].

getTemplateEncoding
public String getTemplateEncoding()(Code)
	Gets the character encoding to use for reading template files. the template encoding or null if not specified.

getTemplateInfo
public TemplateInfo getTemplateInfo()(Code)
	Gets the template info. Creates a new one if needed. a template info.

getTitle
public String getTitle()(Code)
	Gets the title of the page. a string.

getUser
public User getUser()(Code)
	Gets the user. a user.

getUserAgent
public String getUserAgent()(Code)
	Get the user agent for the request. The semantics here are muddled because RunData caches the value after the first invocation. This is different e.g. from getCharSet(). a string.

getUserFromSession
public static User getUserFromSession(HttpSession session)(Code)
	Attempts to get the User object from the session. If it does not exist, it returns null. Parameters: session - An HttpSession. A User.

getUserFromSession
public User getUserFromSession()(Code)
	Attempts to get the user from the session. If it does not exist, it returns null. a user.

getVarDebug
public Map getVarDebug()(Code)
	Gets a Map of debug variables. a Map of debug variables.DefaultTurbineRunData.getDebugVariables

hasAction
public boolean hasAction()(Code)
	Whether or not an action has been defined. true if an action has been defined.

hasMessage
public boolean hasMessage()(Code)
	Whether or not a message has been defined. true if a message has been defined.

hasScreen
public boolean hasScreen()(Code)
	Whether or not a screen has been defined. true if a screen has been defined.

isOutSet
public boolean isOutSet()(Code)
	Checks to see if out is set. true if out is set.

isPageSet
public boolean isPageSet()(Code)
	Checks to see if the page is set. true if the page is set.

populate
public void populate()(Code)
	Pulls a user object from the session and increments the access counter and sets the last access date for the object.

recycle
public void recycle()(Code)
	Recycles a run data object.

removeUserFromSession
public static boolean removeUserFromSession(HttpSession session)(Code)
	Allows one to invalidate the user in a session. Parameters: session - An HttpSession. True if user was invalidated.

removeUserFromSession
public boolean removeUserFromSession()(Code)
	Allows one to invalidate the user in the default session. true if user was invalidated.

save
public void save()(Code)
	Saves a user object into the session.

setACL
public void setACL(AccessControlList acl)(Code)
	Sets the access control list. Parameters: acl - an access control list.

setAction
public void setAction(String action)(Code)
	Sets the action for the request. Parameters: action - a atring.

setCharSet
public void setCharSet(String charSet)(Code)
	Sets the charset. Parameters: charSet - the name of the new charset.

setContentType
public void setContentType(String contentType)(Code)
	Sets the HTTP content type to return. Parameters: contentType - a string.

setContextPath
protected void setContextPath(String contextPath)(Code)
	Sets the cached context path that is stored in the server data. Parameters: contextPath - a string.

setCookieParser
public void setCookieParser(CookieParser parser)(Code)
	Sets the cookie parser. Parameters: parser - a cookie parser.

setDebugVariable
public void setDebugVariable(String name, Object value)(Code)
	Sets a name/value pair in an internal Map that is accessible from the Error screen. This is a good way to get debugging information when an exception is thrown. Parameters: name - name of the variable Parameters: value - value of the variable.

setJNDIContexts
public void setJNDIContexts(Map contexts)(Code)
	Sets JNDI Contexts. Parameters: contexts - a hashtable.

setLayout
public void setLayout(String layout)(Code)
	Set the layout for the request. Parameters: layout - a string.

setLayoutTemplate
public void setLayoutTemplate(String layout)(Code)
	Modifies the layout template for the screen. This convenience method allows for a layout to be modified from within a template. For example; $data.setLayoutTemplate("NewLayout.vm") Parameters: layout - a layout template.

setLocale
public void setLocale(Locale locale)(Code)
	Sets the locale. Parameters: locale - the new locale.

setMessage
public void setMessage(String msg)(Code)
	Sets the message for the request as a string. Parameters: msg - a string.

setMessage
public void setMessage(Element msg)(Code)
	Sets the message for the request as an ECS element. Parameters: msg - an element.

setMessages
public void setMessages(FormMessages msgs)(Code)
	Sets the FormMessages object for the request. Parameters: msgs - A FormMessages.

setOut
protected void setOut(PrintWriter out)(Code)
	Sets the print writer. Parameters: out - a print writer.

setParameterParser
public void setParameterParser(ParameterParser parser)(Code)
	Sets the parameter parser. Parameters: parser - a parameter parser.

setRedirectURI
public void setRedirectURI(String ruri)(Code)
	Sets the redirect uri. If this is set, also make sure to set the status code to 302. Parameters: ruri - a string.

setRequest
public void setRequest(HttpServletRequest req)(Code)
	Sets the servlet request. Parameters: req - a request.

setResponse
public void setResponse(HttpServletResponse res)(Code)
	Sets the servlet response. Parameters: res - a response.

setScreen
public void setScreen(String screen)(Code)
	Sets the screen for the request. Parameters: screen - a string.

setScreenTemplate
public void setScreenTemplate(String screen)(Code)
	Sets the screen template for the request. For example; $data.setScreenTemplate("NewScreen.vm") Parameters: screen - a screen template.

setScriptName
protected void setScriptName(String scriptName)(Code)
	Sets the cached script name that is stored in the server data. Parameters: scriptName - a string.

setServerData
public void setServerData(ServerData serverData)(Code)
	Sets the server data of the request. Parameters: serverData - server data.

setServerName
protected void setServerName(String serverName)(Code)
	Sets the cached server same that is stored in the server data. Parameters: serverName - a string.

setServerPort
protected void setServerPort(int port)(Code)
	Sets the cached server port that is stored in the server data. Parameters: port - an int.

setServerScheme
protected void setServerScheme(String serverScheme)(Code)
	Sets the cached server scheme that is stored in the server data. Parameters: serverScheme - a string.

setServletConfig
public void setServletConfig(ServletConfig config)(Code)
	Sets the servlet configuration used during servlet init. Parameters: config - a configuration.

setSession
public void setSession(HttpSession sess)(Code)
	Sets the servlet session information. Parameters: sess - a session.

setStackTrace
public void setStackTrace(String trace, Throwable exp)(Code)
	Sets the stack trace. Parameters: trace - the stack trace. Parameters: exp - the exception.

setStatusCode
public void setStatusCode(int statusCode)(Code)
	Sets the HTTP status code to return. Parameters: statusCode - the status.

setSystemError
public void setSystemError(SystemError err)(Code)
	Adds a critical system error. Parameters: err - a system error.

setTemplateEncoding
public void setTemplateEncoding(String encoding)(Code)
	Sets the character encoding to use for reading template files. Parameters: encoding - the template encoding.

setTitle
public void setTitle(String title)(Code)
	Sets the title of the page. Parameters: title - a string.

setUser
public void setUser(User user)(Code)
	Sets the user. Parameters: user - a user.

unsetMessage
public void unsetMessage()(Code)
	Unsets the message for the request.

userExists
public boolean userExists()(Code)
	Checks if a user exists in this session. true if a user exists in this session.

Methods inherited from org.apache.turbine.util.pool.RecyclableSupport

public void Recyclable()(Code)(Java Doc)
public void dispose()(Code)(Java Doc)
protected boolean doDispose()(Code)(Java Doc)
public boolean isDisposed()(Code)(Java Doc)
public void recycle()(Code)(Java Doc)

Methods inherited from java.lang.Object

native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.