| <!DOCTYPE HTML> |
| <html lang> |
| <head> |
| <!-- Generated by javadoc (21) --> |
| <title>RunData (Apache Turbine 7.1-SNAPSHOT API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.turbine.util, interface: RunData"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/RunData.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Summary:</p> |
| <ul> |
| <li>Nested</li> |
| <li>Field</li> |
| <li>Constr</li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <li>Field</li> |
| <li>Constr</li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><a href="../../../../search.html">SEARCH</a> |
| <input type="text" id="search-input" disabled placeholder="Search"> |
| <input type="reset" id="reset-button" disabled value="reset"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.turbine.util</a></div> |
| <h1 title="Interface RunData" class="title">Interface RunData</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code>, <code><a href="../pipeline/PipelineData.html" title="interface in org.apache.turbine.pipeline">PipelineData</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="../services/rundata/TurbineRunData.html" title="interface in org.apache.turbine.services.rundata">TurbineRunData</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../services/rundata/DefaultTurbineRunData.html" title="class in org.apache.turbine.services.rundata">DefaultTurbineRunData</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-58">RunData</a></span><span class="extends-implements"> |
| extends <a href="../pipeline/PipelineData.html" title="interface in org.apache.turbine.pipeline">PipelineData</a></span></div> |
| <div class="block">RunData is an interface to run-time 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 instance |
| for each request that is being serviced.</div> |
| <dl class="notes"> |
| <dt>Version:</dt> |
| <dd>$Id$</dd> |
| <dt>Author:</dt> |
| <dd><a href="mailto:ilkka.priha@simsoft.fi">Ilkka Priha</a>, <a href="mailto:jon@clearink.com">Jon S. Stevens</a>, <a href="mailto:bhoeneis@ee.ethz.ch">Bernie Hoeneisen</a>, <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a>, <a href="mailto:quintonm@bellsouth.net">Quinton McCombs</a></dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addMessage(java.lang.String)" class="member-name-link">addMessage</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> msg)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Adds the string to message.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#declareDirectResponse()" class="member-name-link">declareDirectResponse</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Declares that output will be direct to the response stream, |
| even though getOut() may never be called.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><A extends org.apache.fulcrum.security.acl.AccessControlList><br>A</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getACL()" class="member-name-link">getACL</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the access control list.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getAction()" class="member-name-link">getAction</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the action.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getCharset()" class="member-name-link">getCharset</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the charset.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code><a href="#getCharSet()" class="member-name-link">getCharSet</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getContentType()" class="member-name-link">getContentType</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the HTTP content type to return.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getContextPath()" class="member-name-link">getContextPath</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the cached context path.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>org.apache.fulcrum.parser.CookieParser</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getCookies()" class="member-name-link">getCookies</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the cookies.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><wbr><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getDebugVariables()" class="member-name-link">getDebugVariables</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets a Map of debug variables.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><wbr><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.naming/javax/naming/Context.html" title="class or interface in javax.naming" class="external-link">Context</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getJNDIContexts()" class="member-name-link">getJNDIContexts</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets JNDI Contexts.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getLayout()" class="member-name-link">getLayout</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">If the Layout has not been defined by the screen then set the |
| layout to be "DefaultLayout".</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getLayoutTemplate()" class="member-name-link">getLayoutTemplate</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Convenience method for a template info that |
| returns the layout template being used.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getLocale()" class="member-name-link">getLocale</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the locale.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMessage()" class="member-name-link">getMessage</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the results of an action or another message |
| to be displayed as a string.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMessageAsHTML()" class="member-name-link">getMessageAsHTML</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the results of an action or another message |
| to be displayed as a string.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="FormMessages.html" title="class in org.apache.turbine.util">FormMessages</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMessages()" class="member-name-link">getMessages</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets a FormMessages object where all the messages to the |
| user should be stored.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintWriter.html" title="class or interface in java.io" class="external-link">PrintWriter</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getOut()" class="member-name-link">getOut</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the print writer.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>org.apache.fulcrum.parser.ParameterParser</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getParameters()" class="member-name-link">getParameters</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the parameters.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRedirectURI()" class="member-name-link">getRedirectURI</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the redirect URI.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRemoteAddr()" class="member-name-link">getRemoteAddr</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the IP address of the client that sent the request.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRemoteHost()" class="member-name-link">getRemoteHost</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the qualified name of the client that sent the request.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>jakarta.servlet.http.HttpServletRequest</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRequest()" class="member-name-link">getRequest</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the servlet request.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>jakarta.servlet.http.HttpServletResponse</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getResponse()" class="member-name-link">getResponse</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the servlet response.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getScreen()" class="member-name-link">getScreen</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the screen to execute.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getScreenTemplate()" class="member-name-link">getScreenTemplate</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Convenience method for a template info that |
| returns the name of the template being used.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getScriptName()" class="member-name-link">getScriptName</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the cached script name.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ServerData.html" title="class in org.apache.turbine.util">ServerData</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getServerData()" class="member-name-link">getServerData</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the server data used by the request.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getServerName()" class="member-name-link">getServerName</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the cached server name.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getServerPort()" class="member-name-link">getServerPort</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the cached server port.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getServerScheme()" class="member-name-link">getServerScheme</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the cached server scheme.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>jakarta.servlet.ServletConfig</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getServletConfig()" class="member-name-link">getServletConfig</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the servlet configuration used during servlet init.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>jakarta.servlet.ServletContext</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getServletContext()" class="member-name-link">getServletContext</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the servlet context used during servlet init.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>jakarta.servlet.http.HttpSession</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSession()" class="member-name-link">getSession</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the servlet session information.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getStackTrace()" class="member-name-link">getStackTrace</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the stack trace if set.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getStackTraceException()" class="member-name-link">getStackTraceException</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the stack trace exception if set.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getStatusCode()" class="member-name-link">getStatusCode</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the HTTP status code to return.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SystemError.html" title="class in org.apache.turbine.util">SystemError</a>[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSystemErrors()" class="member-name-link">getSystemErrors</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets an array of system errors.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTemplateEncoding()" class="member-name-link">getTemplateEncoding</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the character encoding to use for reading template files.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="template/TemplateInfo.html" title="class in org.apache.turbine.util.template">TemplateInfo</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTemplateInfo()" class="member-name-link">getTemplateInfo</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the template info.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTitle()" class="member-name-link">getTitle</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the title of the page.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><T extends <a href="../om/security/User.html" title="interface in org.apache.turbine.om.security">User</a>><br>T</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getUser()" class="member-name-link">getUser</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the user.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getUserAgent()" class="member-name-link">getUserAgent</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the user agent for the request.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><T extends <a href="../om/security/User.html" title="interface in org.apache.turbine.om.security">User</a>><br>T</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getUserFromSession()" class="member-name-link">getUserFromSession</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Attempts to get the user from the session.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#hasAction()" class="member-name-link">hasAction</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Whether or not an action has been defined.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#hasMessage()" class="member-name-link">hasMessage</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Whether or not a message has been defined.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#hasScreen()" class="member-name-link">hasScreen</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Whether or not a screen has been defined.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code><a href="#isOutSet()" class="member-name-link">isOutSet</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">no replacement planned, response writer will not be cached</div> |
| </div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#populate()" class="member-name-link">populate</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Pulls a user object from the session and increments the access |
| counter and sets the last access date for the object.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#removeUserFromSession()" class="member-name-link">removeUserFromSession</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Allows one to invalidate the user in the default session.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#save()" class="member-name-link">save</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Saves a user object into the session.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><A extends org.apache.fulcrum.security.acl.AccessControlList><br>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setACL(A)" class="member-name-link">setACL</a><wbr>(A acl)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the access control list.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setAction(java.lang.String)" class="member-name-link">setAction</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> action)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the action for the request.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setCharset(java.nio.charset.Charset)" class="member-name-link">setCharset</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a> charset)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the charset.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code><a href="#setCharSet(java.lang.String)" class="member-name-link">setCharSet</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> charset)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setContentType(java.lang.String)" class="member-name-link">setContentType</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> ct)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the HTTP content type to return.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setDebugVariable(java.lang.String,java.lang.Object)" class="member-name-link">setDebugVariable</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets a name/value pair in an internal Map that is accessible from the |
| Error screen.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setJNDIContexts(java.util.Map)" class="member-name-link">setJNDIContexts</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.naming/javax/naming/Context.html" title="class or interface in javax.naming" class="external-link">Context</a>> contexts)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets JNDI Contexts.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setLayout(java.lang.String)" class="member-name-link">setLayout</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> layout)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Set the layout for the request.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setLayoutTemplate(java.lang.String)" class="member-name-link">setLayoutTemplate</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> layout)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Modifies the layout template for the screen.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setLocale(java.util.Locale)" class="member-name-link">setLocale</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the locale.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setMessage(java.lang.String)" class="member-name-link">setMessage</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> msg)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the message for the request as a string.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setMessages(org.apache.turbine.util.FormMessages)" class="member-name-link">setMessages</a><wbr>(<a href="FormMessages.html" title="class in org.apache.turbine.util">FormMessages</a> msgs)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the FormMessages object for the request.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setRedirectURI(java.lang.String)" class="member-name-link">setRedirectURI</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> ruri)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the redirect uri.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setScreen(java.lang.String)" class="member-name-link">setScreen</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> screen)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the screen for the request.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setScreenTemplate(java.lang.String)" class="member-name-link">setScreenTemplate</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> screen)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the screen template for the request.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setStackTrace(java.lang.String,java.lang.Throwable)" class="member-name-link">setStackTrace</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> trace, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> exp)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the stack trace.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setStatusCode(int)" class="member-name-link">setStatusCode</a><wbr>(int sc)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the HTTP status code to return.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setSystemError(org.apache.turbine.util.SystemError)" class="member-name-link">setSystemError</a><wbr>(<a href="SystemError.html" title="class in org.apache.turbine.util">SystemError</a> err)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Adds a critical system error.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setTemplateEncoding(java.lang.String)" class="member-name-link">setTemplateEncoding</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> encoding)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the character encoding to use for reading template files.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setTitle(java.lang.String)" class="member-name-link">setTitle</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> title)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the title of the page.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><T extends <a href="../om/security/User.html" title="interface in org.apache.turbine.om.security">User</a>><br>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setUser(T)" class="member-name-link">setUser</a><wbr>(T user)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the user.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#unsetMessage()" class="member-name-link">unsetMessage</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Unsets the message for the request.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#userExists()" class="member-name-link">userExists</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Checks if a user exists in this session.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.AutoCloseable">Methods inherited from interface java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html#close()" title="class or interface in java.lang" class="external-link">close</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.turbine.pipeline.PipelineData">Methods inherited from interface org.apache.turbine.pipeline.<a href="../pipeline/PipelineData.html" title="interface in org.apache.turbine.pipeline">PipelineData</a></h3> |
| <code><a href="../pipeline/PipelineData.html#get(java.lang.Class)">get</a>, <a href="../pipeline/PipelineData.html#get(java.lang.Class,java.lang.Class)">get</a>, <a href="../pipeline/PipelineData.html#getRunData()">getRunData</a>, <a href="../pipeline/PipelineData.html#put(java.lang.Class,java.util.Map)">put</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getParameters()"> |
| <h3>getParameters</h3> |
| <div class="member-signature"><span class="return-type">org.apache.fulcrum.parser.ParameterParser</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-65">getParameters</a></span>()</div> |
| <div class="block">Gets the parameters.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a parameter parser.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCookies()"> |
| <h3>getCookies</h3> |
| <div class="member-signature"><span class="return-type">org.apache.fulcrum.parser.CookieParser</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-72">getCookies</a></span>()</div> |
| <div class="block">Gets the cookies.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a cookie parser.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRequest()"> |
| <h3>getRequest</h3> |
| <div class="member-signature"><span class="return-type">jakarta.servlet.http.HttpServletRequest</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-79">getRequest</a></span>()</div> |
| <div class="block">Gets the servlet request.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the request.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getResponse()"> |
| <h3>getResponse</h3> |
| <div class="member-signature"><span class="return-type">jakarta.servlet.http.HttpServletResponse</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-86">getResponse</a></span>()</div> |
| <div class="block">Gets the servlet response.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the resposne.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSession()"> |
| <h3>getSession</h3> |
| <div class="member-signature"><span class="return-type">jakarta.servlet.http.HttpSession</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-93">getSession</a></span>()</div> |
| <div class="block">Gets the servlet session information.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the session.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getServletConfig()"> |
| <h3>getServletConfig</h3> |
| <div class="member-signature"><span class="return-type">jakarta.servlet.ServletConfig</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-100">getServletConfig</a></span>()</div> |
| <div class="block">Gets the servlet configuration used during servlet init.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the configuration.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getServletContext()"> |
| <h3>getServletContext</h3> |
| <div class="member-signature"><span class="return-type">jakarta.servlet.ServletContext</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-107">getServletContext</a></span>()</div> |
| <div class="block">Gets the servlet context used during servlet init.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the context.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getACL()"> |
| <h3>getACL</h3> |
| <div class="member-signature"><span class="type-parameters-long"><A extends org.apache.fulcrum.security.acl.AccessControlList></span> |
| <span class="return-type">A</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-116">getACL</a></span>()</div> |
| <div class="block">Gets the access control list.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>A</code> - a type extending <code>AccessControlList</code></dd> |
| <dt>Returns:</dt> |
| <dd>the access control list.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setACL(A)"> |
| <h3 id="setACL(org.apache.fulcrum.security.acl.AccessControlList)">setACL</h3> |
| <div class="member-signature"><span class="type-parameters-long"><A extends org.apache.fulcrum.security.acl.AccessControlList></span> |
| <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-124">setACL</a></span><wbr><span class="parameters">(A acl)</span></div> |
| <div class="block">Sets the access control list.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>A</code> - ACL type</dd> |
| <dt>Parameters:</dt> |
| <dd><code>acl</code> - an access control list.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hasAction()"> |
| <h3>hasAction</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-131">hasAction</a></span>()</div> |
| <div class="block">Whether or not an action has been defined.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if an action has been defined.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAction()"> |
| <h3>getAction</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-140">getAction</a></span>()</div> |
| <div class="block">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.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a string, "" if null.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setAction(java.lang.String)"> |
| <h3>setAction</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-147">setAction</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> action)</span></div> |
| <div class="block">Sets the action for the request.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>action</code> - a string.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLayout()"> |
| <h3>getLayout</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-161">getLayout</a></span>()</div> |
| <div class="block">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 dynamically change the layout for the entire |
| site.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a string.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setLayout(java.lang.String)"> |
| <h3>setLayout</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-168">setLayout</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> layout)</span></div> |
| <div class="block">Set the layout for the request.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>layout</code> - a string.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLayoutTemplate()"> |
| <h3>getLayoutTemplate</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-176">getLayoutTemplate</a></span>()</div> |
| <div class="block">Convenience method for a template info that |
| returns the layout template being used.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a string.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setLayoutTemplate(java.lang.String)"> |
| <h3>setLayoutTemplate</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-187">setLayoutTemplate</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> layout)</span></div> |
| <div class="block">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")</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>layout</code> - a layout template.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hasScreen()"> |
| <h3>hasScreen</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-194">hasScreen</a></span>()</div> |
| <div class="block">Whether or not a screen has been defined.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if a screen has been defined.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getScreen()"> |
| <h3>getScreen</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-201">getScreen</a></span>()</div> |
| <div class="block">Gets the screen to execute.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a string.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setScreen(java.lang.String)"> |
| <h3>setScreen</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-208">setScreen</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> screen)</span></div> |
| <div class="block">Sets the screen for the request.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>screen</code> - a string.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getScreenTemplate()"> |
| <h3>getScreenTemplate</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-216">getScreenTemplate</a></span>()</div> |
| <div class="block">Convenience method for a template info that |
| returns the name of the template being used.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a string.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setScreenTemplate(java.lang.String)"> |
| <h3>setScreenTemplate</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-226">setScreenTemplate</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> screen)</span></div> |
| <div class="block">Sets the screen template for the request. For |
| example; |
| |
| $data.setScreenTemplate("NewScreen.vm")</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>screen</code> - a screen template.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTemplateEncoding()"> |
| <h3>getTemplateEncoding</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-233">getTemplateEncoding</a></span>()</div> |
| <div class="block">Gets the character encoding to use for reading template files.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the template encoding or null if not specified.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setTemplateEncoding(java.lang.String)"> |
| <h3>setTemplateEncoding</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-240">setTemplateEncoding</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> encoding)</span></div> |
| <div class="block">Sets the character encoding to use for reading template files.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>encoding</code> - the template encoding.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTemplateInfo()"> |
| <h3>getTemplateInfo</h3> |
| <div class="member-signature"><span class="return-type"><a href="template/TemplateInfo.html" title="class in org.apache.turbine.util.template">TemplateInfo</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-247">getTemplateInfo</a></span>()</div> |
| <div class="block">Gets the template info. Creates a new one if needed.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a template info.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hasMessage()"> |
| <h3>hasMessage</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-254">hasMessage</a></span>()</div> |
| <div class="block">Whether or not a message has been defined.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if a message has been defined.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMessage()"> |
| <h3>getMessage</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-262">getMessage</a></span>()</div> |
| <div class="block">Gets the results of an action or another message |
| to be displayed as a string.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a string.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setMessage(java.lang.String)"> |
| <h3>setMessage</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-269">setMessage</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> msg)</span></div> |
| <div class="block">Sets the message for the request as a string.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>msg</code> - a string.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addMessage(java.lang.String)"> |
| <h3>addMessage</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-277">addMessage</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> msg)</span></div> |
| <div class="block">Adds the string to message. If message has prior messages from |
| other actions or screens, this method can be used to chain them.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>msg</code> - a string.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMessageAsHTML()"> |
| <h3>getMessageAsHTML</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-285">getMessageAsHTML</a></span>()</div> |
| <div class="block">Gets the results of an action or another message |
| to be displayed as a string.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a string.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="unsetMessage()"> |
| <h3>unsetMessage</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-290">unsetMessage</a></span>()</div> |
| <div class="block">Unsets the message for the request.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMessages()"> |
| <h3>getMessages</h3> |
| <div class="member-signature"><span class="return-type"><a href="FormMessages.html" title="class in org.apache.turbine.util">FormMessages</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-298">getMessages</a></span>()</div> |
| <div class="block">Gets a FormMessages object where all the messages to the |
| user should be stored.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a FormMessages.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setMessages(org.apache.turbine.util.FormMessages)"> |
| <h3>setMessages</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-305">setMessages</a></span><wbr><span class="parameters">(<a href="FormMessages.html" title="class in org.apache.turbine.util">FormMessages</a> msgs)</span></div> |
| <div class="block">Sets the FormMessages object for the request.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>msgs</code> - A FormMessages.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTitle()"> |
| <h3>getTitle</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-312">getTitle</a></span>()</div> |
| <div class="block">Gets the title of the page.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a string.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setTitle(java.lang.String)"> |
| <h3>setTitle</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-319">setTitle</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> title)</span></div> |
| <div class="block">Sets the title of the page.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>title</code> - a string.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="userExists()"> |
| <h3>userExists</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-326">userExists</a></span>()</div> |
| <div class="block">Checks if a user exists in this session.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if a user exists in this session.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getUser()"> |
| <h3>getUser</h3> |
| <div class="member-signature"><span class="type-parameters"><T extends <a href="../om/security/User.html" title="interface in org.apache.turbine.om.security">User</a>></span> <span class="return-type">T</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-335">getUser</a></span>()</div> |
| <div class="block">Gets the user.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - a type extending <a href="../om/security/User.html" title="interface in org.apache.turbine.om.security"><code>User</code></a></dd> |
| <dt>Returns:</dt> |
| <dd>a user.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setUser(T)"> |
| <h3 id="setUser(org.apache.turbine.om.security.User)">setUser</h3> |
| <div class="member-signature"><span class="type-parameters"><T extends <a href="../om/security/User.html" title="interface in org.apache.turbine.om.security">User</a>></span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-344">setUser</a></span><wbr><span class="parameters">(T user)</span></div> |
| <div class="block">Sets the user.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - a type extending <a href="../om/security/User.html" title="interface in org.apache.turbine.om.security"><code>User</code></a></dd> |
| <dt>Parameters:</dt> |
| <dd><code>user</code> - a user.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getUserFromSession()"> |
| <h3>getUserFromSession</h3> |
| <div class="member-signature"><span class="type-parameters"><T extends <a href="../om/security/User.html" title="interface in org.apache.turbine.om.security">User</a>></span> <span class="return-type">T</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-354">getUserFromSession</a></span>()</div> |
| <div class="block">Attempts to get the user from the session. If it does |
| not exist, it returns null.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - a type extending <a href="../om/security/User.html" title="interface in org.apache.turbine.om.security"><code>User</code></a></dd> |
| <dt>Returns:</dt> |
| <dd>a user.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="removeUserFromSession()"> |
| <h3>removeUserFromSession</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-361">removeUserFromSession</a></span>()</div> |
| <div class="block">Allows one to invalidate the user in the default session.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if user was invalidated.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isOutSet()"> |
| <h3>isOutSet</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="return-type">boolean</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-369">isOutSet</a></span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">no replacement planned, response writer will not be cached</div> |
| </div> |
| <div class="block">Checks to see if out is set.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if out is set.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOut()"> |
| <h3>getOut</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintWriter.html" title="class or interface in java.io" class="external-link">PrintWriter</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-379">getOut</a></span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Gets the print writer. First time calling this |
| will set the print writer via the response.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a print writer.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - on failure getting the PrintWriter</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="declareDirectResponse()"> |
| <h3>declareDirectResponse</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-388">declareDirectResponse</a></span>()</div> |
| <div class="block">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.)</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLocale()"> |
| <h3>getLocale</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-399">getLocale</a></span>()</div> |
| <div class="block">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.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the locale.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setLocale(java.util.Locale)"> |
| <h3>setLocale</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-406">setLocale</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</span></div> |
| <div class="block">Sets the locale.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>locale</code> - the new locale.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCharSet()"> |
| <h3>getCharSet</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-417">getCharSet</a></span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block">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.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the name of the charset or null.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setCharSet(java.lang.String)"> |
| <h3>setCharSet</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-425">setCharSet</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> charset)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block">Sets the charset.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>charset</code> - the name of the new charset.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCharset()"> |
| <h3>getCharset</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-437">getCharset</a></span>()</div> |
| <div class="block">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.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the charset or null.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setCharset(java.nio.charset.Charset)"> |
| <h3>setCharset</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-444">setCharset</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a> charset)</span></div> |
| <div class="block">Sets the charset.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>charset</code> - the new charset.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getContentType()"> |
| <h3>getContentType</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-457">getContentType</a></span>()</div> |
| <div class="block">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.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the content type or an empty string.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setContentType(java.lang.String)"> |
| <h3>setContentType</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-464">setContentType</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> ct)</span></div> |
| <div class="block">Sets the HTTP content type to return.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>ct</code> - the new content type.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRedirectURI()"> |
| <h3>getRedirectURI</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-472">getRedirectURI</a></span>()</div> |
| <div class="block">Gets the redirect URI. If this is set, also make sure to set |
| the status code to 302.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a string, "" if null.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setRedirectURI(java.lang.String)"> |
| <h3>setRedirectURI</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-480">setRedirectURI</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> ruri)</span></div> |
| <div class="block">Sets the redirect uri. If this is set, also make sure to set |
| the status code to 302.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>ruri</code> - a string.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStatusCode()"> |
| <h3>getStatusCode</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-487">getStatusCode</a></span>()</div> |
| <div class="block">Gets the HTTP status code to return.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the status.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setStatusCode(int)"> |
| <h3>setStatusCode</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-494">setStatusCode</a></span><wbr><span class="parameters">(int sc)</span></div> |
| <div class="block">Sets the HTTP status code to return.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sc</code> - the status.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSystemErrors()"> |
| <h3>getSystemErrors</h3> |
| <div class="member-signature"><span class="return-type"><a href="SystemError.html" title="class in org.apache.turbine.util">SystemError</a>[]</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-501">getSystemErrors</a></span>()</div> |
| <div class="block">Gets an array of system errors.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a SystemError[].</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSystemError(org.apache.turbine.util.SystemError)"> |
| <h3>setSystemError</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-508">setSystemError</a></span><wbr><span class="parameters">(<a href="SystemError.html" title="class in org.apache.turbine.util">SystemError</a> err)</span></div> |
| <div class="block">Adds a critical system error.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>err</code> - a system error.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getJNDIContexts()"> |
| <h3>getJNDIContexts</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.naming/javax/naming/Context.html" title="class or interface in javax.naming" class="external-link">Context</a>></span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-515">getJNDIContexts</a></span>()</div> |
| <div class="block">Gets JNDI Contexts.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a hashtable.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setJNDIContexts(java.util.Map)"> |
| <h3>setJNDIContexts</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-522">setJNDIContexts</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.naming/javax/naming/Context.html" title="class or interface in javax.naming" class="external-link">Context</a>> contexts)</span></div> |
| <div class="block">Sets JNDI Contexts.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>contexts</code> - a hashtable.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getServerScheme()"> |
| <h3>getServerScheme</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-529">getServerScheme</a></span>()</div> |
| <div class="block">Gets the cached server scheme.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a string.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getServerName()"> |
| <h3>getServerName</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-536">getServerName</a></span>()</div> |
| <div class="block">Gets the cached server name.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a string.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getServerPort()"> |
| <h3>getServerPort</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-543">getServerPort</a></span>()</div> |
| <div class="block">Gets the cached server port.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>an int.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getContextPath()"> |
| <h3>getContextPath</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-550">getContextPath</a></span>()</div> |
| <div class="block">Gets the cached context path.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a string.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getScriptName()"> |
| <h3>getScriptName</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-557">getScriptName</a></span>()</div> |
| <div class="block">Gets the cached script name.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a string.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getServerData()"> |
| <h3>getServerData</h3> |
| <div class="member-signature"><span class="return-type"><a href="ServerData.html" title="class in org.apache.turbine.util">ServerData</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-564">getServerData</a></span>()</div> |
| <div class="block">Gets the server data used by the request.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>server data.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRemoteAddr()"> |
| <h3>getRemoteAddr</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-571">getRemoteAddr</a></span>()</div> |
| <div class="block">Gets the IP address of the client that sent the request.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a string.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRemoteHost()"> |
| <h3>getRemoteHost</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-578">getRemoteHost</a></span>()</div> |
| <div class="block">Gets the qualified name of the client that sent the request.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a string.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getUserAgent()"> |
| <h3>getUserAgent</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-585">getUserAgent</a></span>()</div> |
| <div class="block">Get the user agent for the request.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a string.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="populate()"> |
| <h3>populate</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-591">populate</a></span>()</div> |
| <div class="block">Pulls a user object from the session and increments the access |
| counter and sets the last access date for the object.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="save()"> |
| <h3>save</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-596">save</a></span>()</div> |
| <div class="block">Saves a user object into the session.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStackTrace()"> |
| <h3>getStackTrace</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-603">getStackTrace</a></span>()</div> |
| <div class="block">Gets the stack trace if set.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the stack trace.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStackTraceException()"> |
| <h3>getStackTraceException</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-610">getStackTraceException</a></span>()</div> |
| <div class="block">Gets the stack trace exception if set.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the stack exception.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setStackTrace(java.lang.String,java.lang.Throwable)"> |
| <h3>setStackTrace</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-618">setStackTrace</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> trace, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> exp)</span></div> |
| <div class="block">Sets the stack trace.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>trace</code> - the stack trace.</dd> |
| <dd><code>exp</code> - the exception.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setDebugVariable(java.lang.String,java.lang.Object)"> |
| <h3>setDebugVariable</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-629">setDebugVariable</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> value)</span></div> |
| <div class="block">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.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - name of the variable</dd> |
| <dd><code>value</code> - value of the variable.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDebugVariables()"> |
| <h3>getDebugVariables</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/util/RunData.html#line-636">getDebugVariables</a></span>()</div> |
| <div class="block">Gets a Map of debug variables.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a Map of debug variables.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2000–2025 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |