| <!DOCTYPE HTML> |
| <html lang> |
| <head> |
| <!-- Generated by javadoc (21) --> |
| <title>Valve (Apache Turbine 7.0 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.pipeline, interface: Valve"> |
| <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/Valve.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.pipeline</a></div> |
| <h1 title="Interface Valve" class="title">Interface Valve</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="CleanUpValve.html" title="class in org.apache.turbine.pipeline">CleanUpValve</a></code>, <code><a href="DefaultACLCreationValve.html" title="class in org.apache.turbine.pipeline">DefaultACLCreationValve</a></code>, <code><a href="DefaultLoginValve.html" title="class in org.apache.turbine.pipeline">DefaultLoginValve</a></code>, <code><a href="DefaultSessionTimeoutValve.html" title="class in org.apache.turbine.pipeline">DefaultSessionTimeoutValve</a></code>, <code><a href="DefaultSessionValidationValve.html" title="class in org.apache.turbine.pipeline">DefaultSessionValidationValve</a></code>, <code><a href="DefaultSetEncodingValve.html" title="class in org.apache.turbine.pipeline">DefaultSetEncodingValve</a></code>, <code><a href="DetermineActionValve.html" title="class in org.apache.turbine.pipeline">DetermineActionValve</a></code>, <code><a href="DetermineRedirectRequestedValve.html" title="class in org.apache.turbine.pipeline">DetermineRedirectRequestedValve</a></code>, <code><a href="DetermineTargetValve.html" title="class in org.apache.turbine.pipeline">DetermineTargetValve</a></code>, <code><a href="ExecutePageValve.html" title="class in org.apache.turbine.pipeline">ExecutePageValve</a></code>, <code><a href="../services/urlmapper/URLMapperValve.html" title="class in org.apache.turbine.services.urlmapper">URLMapperValve</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Functional Interface:</dt> |
| <dd>This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.</dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/FunctionalInterface.html" title="class or interface in java.lang" class="external-link">@FunctionalInterface</a> |
| </span><span class="modifiers">public interface </span><span class="element-name"><a href="../../../../src-html/org/apache/turbine/pipeline/Valve.html#line-45">Valve</a></span></div> |
| <div class="block"><p>A <b>Valve</b> is a request processing component. A series of |
| Valves are generally associated with each other into a Pipeline. |
| The detailed contract for a Valve is included in the description of |
| the <code>invoke()</code> method below.</p> |
| |
| <b>HISTORICAL NOTE</b>: The "Valve" name was assigned to this concept |
| because a valve is what you use in a real world pipeline to control and/or |
| modify flows through it.</div> |
| <dl class="notes"> |
| <dt>Author:</dt> |
| <dd>Craig R. McClanahan, Gunnar Rjnning, Peter Donald, <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a></dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="#invoke(org.apache.turbine.pipeline.PipelineData,org.apache.turbine.pipeline.ValveContext)"><code>invoke(PipelineData, ValveContext)</code></a></li> |
| </ul> |
| </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-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default 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-tab5"><code>default void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#initialize()" class="member-name-link">initialize</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Initialize the valve before using in a pipeline.</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="#invoke(org.apache.turbine.pipeline.PipelineData,org.apache.turbine.pipeline.ValveContext)" class="member-name-link">invoke</a><wbr>(<a href="PipelineData.html" title="interface in org.apache.turbine.pipeline">PipelineData</a> pipelineData, |
| <a href="ValveContext.html" title="interface in org.apache.turbine.pipeline">ValveContext</a> context)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Perform request processing as required by this Valve.</div> |
| </div> |
| </div> |
| </div> |
| </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="invoke(org.apache.turbine.pipeline.PipelineData,org.apache.turbine.pipeline.ValveContext)"> |
| <h3>invoke</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/pipeline/Valve.html#line-93">invoke</a></span><wbr><span class="parameters">(<a href="PipelineData.html" title="interface in org.apache.turbine.pipeline">PipelineData</a> pipelineData, |
| <a href="ValveContext.html" title="interface in org.apache.turbine.pipeline">ValveContext</a> context)</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>, |
| <a href="../util/TurbineException.html" title="class in org.apache.turbine.util">TurbineException</a></span></div> |
| <div class="block"><p>Perform request processing as required by this Valve.</p> |
| |
| <p>An individual Valve <b>MAY</b> perform the following actions, in |
| the specified order:</p> |
| <ul> |
| <li>Examine and/or modify the properties of the specified Request and |
| Response. |
| <li>Examine the properties of the specified Request, completely generate |
| the corresponding Response, and return control to the caller. |
| <li>Examine the properties of the specified Request and Response, wrap |
| either or both of these objects to supplement their functionality, |
| and pass them on. |
| <li>If the corresponding Response was not generated (and control was not |
| returned, call the next Valve in the pipeline (if there is one) by |
| executing <code>context.invokeNext()</code>. |
| <li>Examine, but not modify, the properties of the resulting Response |
| (which was created by a subsequently invoked Valve via a |
| call to <code>context.invokeNext()</code>). |
| </ul> |
| |
| <p>A Valve <b>MUST NOT</b> do any of the following things:</p> |
| <ul> |
| <li>Change request properties that have already been used to direct |
| the flow of processing control for this request. |
| <li>Create a completed Response <strong>AND</strong> pass this |
| Request and Response on to the next Valve in the pipeline. |
| <li>Consume bytes from the input stream associated with the Request, |
| unless it is completely generating the response, or wrapping the |
| request before passing it on. |
| <li>Modify the HTTP headers included with the Response after the |
| <code>invokeNext()</code> method has returned. |
| <li>Perform any actions on the output stream associated with the |
| specified Response after the <code>invokeNext()</code> method has |
| returned. |
| </ul></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>pipelineData</code> - The run-time information, including the servlet |
| request and response we are processing.</dd> |
| <dd><code>context</code> - The valve context used to invoke the next valve |
| in the current processing pipeline</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> - Thrown by a subsequent Valve.</dd> |
| <dd><code><a href="../util/TurbineException.html" title="class in org.apache.turbine.util">TurbineException</a></code> - Thrown by a subsequent Valve.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="initialize()"> |
| <h3>initialize</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/turbine/pipeline/Valve.html#line-100">initialize</a></span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></span></div> |
| <div class="block">Initialize the valve before using in a pipeline.</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></code> - if initialization fails</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> |
