blob: 29301aff7bbac3c15eed7a248381b41bfdb9b2f1 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_92) on Thu Jun 07 14:26:31 EDT 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AsyncMiddleManServlet.ContentTransformer (Jetty :: Project 9.3.24.v20180605 API)</title>
<meta name="date" content="2018-06-07">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AsyncMiddleManServlet.ContentTransformer (Jetty :: Project 9.3.24.v20180605 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/AsyncMiddleManServlet.ContentTransformer.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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/eclipse/jetty/proxy/AsyncMiddleManServlet.html" title="class in org.eclipse.jetty.proxy"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/eclipse/jetty/proxy/AsyncMiddleManServlet.GZIPContentTransformer.html" title="class in org.eclipse.jetty.proxy"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/eclipse/jetty/proxy/AsyncMiddleManServlet.ContentTransformer.html" target="_top">Frames</a></li>
<li><a href="AsyncMiddleManServlet.ContentTransformer.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.eclipse.jetty.proxy</div>
<h2 title="Interface AsyncMiddleManServlet.ContentTransformer" class="title">Interface AsyncMiddleManServlet.ContentTransformer</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/eclipse/jetty/proxy/AfterContentTransformer.html" title="class in org.eclipse.jetty.proxy">AfterContentTransformer</a>, <a href="../../../../org/eclipse/jetty/proxy/AsyncMiddleManServlet.GZIPContentTransformer.html" title="class in org.eclipse.jetty.proxy">AsyncMiddleManServlet.GZIPContentTransformer</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../org/eclipse/jetty/proxy/AsyncMiddleManServlet.html" title="class in org.eclipse.jetty.proxy">AsyncMiddleManServlet</a></dd>
</dl>
<hr>
<br>
<pre>public static interface <span class="typeNameLabel">AsyncMiddleManServlet.ContentTransformer</span></pre>
<div class="block"><p>Allows applications to transform upstream and downstream content.</p>
<p>Typical use cases of transformations are URL rewriting of HTML anchors
(where the value of the <code>href</code> attribute of &lt;a&gt; elements
is modified by the proxy), field renaming of JSON documents, etc.</p>
<p>Applications should override <a href="../../../../org/eclipse/jetty/proxy/AsyncMiddleManServlet.html#newClientRequestContentTransformer-javax.servlet.http.HttpServletRequest-org.eclipse.jetty.client.api.Request-"><code>AsyncMiddleManServlet.newClientRequestContentTransformer(HttpServletRequest, Request)</code></a>
and/or <a href="../../../../org/eclipse/jetty/proxy/AsyncMiddleManServlet.html#newServerResponseContentTransformer-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-org.eclipse.jetty.client.api.Response-"><code>AsyncMiddleManServlet.newServerResponseContentTransformer(HttpServletRequest, HttpServletResponse, Response)</code></a>
to provide the transformer implementation.</p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/eclipse/jetty/proxy/AsyncMiddleManServlet.ContentTransformer.html" title="interface in org.eclipse.jetty.proxy">AsyncMiddleManServlet.ContentTransformer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/proxy/AsyncMiddleManServlet.ContentTransformer.html#IDENTITY">IDENTITY</a></span></code>
<div class="block">The identity transformer that does not perform any transformation.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/proxy/AsyncMiddleManServlet.ContentTransformer.html#transform-java.nio.ByteBuffer-boolean-java.util.List-">transform</a></span>(java.nio.ByteBuffer&nbsp;input,
boolean&nbsp;finished,
java.util.List&lt;java.nio.ByteBuffer&gt;&nbsp;output)</code>
<div class="block">Transforms the given input byte buffers into (possibly multiple) byte buffers.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="IDENTITY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>IDENTITY</h4>
<pre>static final&nbsp;<a href="../../../../org/eclipse/jetty/proxy/AsyncMiddleManServlet.ContentTransformer.html" title="interface in org.eclipse.jetty.proxy">AsyncMiddleManServlet.ContentTransformer</a> IDENTITY</pre>
<div class="block">The identity transformer that does not perform any transformation.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="transform-java.nio.ByteBuffer-boolean-java.util.List-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>transform</h4>
<pre>void&nbsp;transform(java.nio.ByteBuffer&nbsp;input,
boolean&nbsp;finished,
java.util.List&lt;java.nio.ByteBuffer&gt;&nbsp;output)
throws java.io.IOException</pre>
<div class="block"><p>Transforms the given input byte buffers into (possibly multiple) byte buffers.</p>
<p>The transformation must happen synchronously in the context of a call
to this method (it is not supported to perform the transformation in another
thread spawned during the call to this method).
The transformation may happen or not, depending on the transformer implementation.
For example, a buffering transformer may buffer the input aside, and only
perform the transformation when the whole input is provided (by looking at the
<code>finished</code> flag).</p>
<p>The input buffer will be cleared and reused after the call to this method.
Implementations that want to buffer aside the input (or part of it) must copy
the input bytes that they want to buffer.</p>
<p>Typical implementations:</p>
<pre>
// Identity transformation (no transformation, the input is copied to the output)
public void transform(ByteBuffer input, boolean finished, List&lt;ByteBuffer&gt; output)
{
output.add(input);
}
// Discard transformation (all input is discarded)
public void transform(ByteBuffer input, boolean finished, List&lt;ByteBuffer&gt; output)
{
// Empty
}
// Buffering identity transformation (all input is buffered aside until it is finished)
public void transform(ByteBuffer input, boolean finished, List&lt;ByteBuffer&gt; output)
{
ByteBuffer copy = ByteBuffer.allocate(input.remaining());
copy.put(input).flip();
store(copy);
if (finished)
{
List&lt;ByteBuffer&gt; copies = retrieve();
output.addAll(copies);
}
}
</pre></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>input</code> - the input content to transform (may be of length zero)</dd>
<dd><code>finished</code> - whether the input content is finished or more will come</dd>
<dd><code>output</code> - where to put the transformed output content</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - in case of transformation failures</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/AsyncMiddleManServlet.ContentTransformer.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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/eclipse/jetty/proxy/AsyncMiddleManServlet.html" title="class in org.eclipse.jetty.proxy"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/eclipse/jetty/proxy/AsyncMiddleManServlet.GZIPContentTransformer.html" title="class in org.eclipse.jetty.proxy"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/eclipse/jetty/proxy/AsyncMiddleManServlet.ContentTransformer.html" target="_top">Frames</a></li>
<li><a href="AsyncMiddleManServlet.ContentTransformer.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 1995&#x2013;2018 <a href="http://webtide.com">Webtide</a>. All rights reserved.</small></p>
</body>
</html>