blob: 5b9fbb3e0d1e6fb24fad3267388f3e57d3bd516c [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>ProxyServlet.ProxyInputStreamContentProvider (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="ProxyServlet.ProxyInputStreamContentProvider (Jetty :: Project 9.3.24.v20180605 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/ProxyServlet.ProxyInputStreamContentProvider.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/ProxyServlet.html" title="class in org.eclipse.jetty.proxy"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/eclipse/jetty/proxy/ProxyServlet.ProxyResponseListener.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/ProxyServlet.ProxyInputStreamContentProvider.html" target="_top">Frames</a></li>
<li><a href="ProxyServlet.ProxyInputStreamContentProvider.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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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="Class ProxyServlet.ProxyInputStreamContentProvider" class="title">Class ProxyServlet.ProxyInputStreamContentProvider</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/eclipse/jetty/client/util/InputStreamContentProvider.html" title="class in org.eclipse.jetty.client.util">org.eclipse.jetty.client.util.InputStreamContentProvider</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.proxy.ProxyServlet.ProxyInputStreamContentProvider</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Closeable, java.lang.AutoCloseable, java.lang.Iterable&lt;java.nio.ByteBuffer&gt;, <a href="../../../../org/eclipse/jetty/client/api/ContentProvider.html" title="interface in org.eclipse.jetty.client.api">ContentProvider</a>, <a href="../../../../org/eclipse/jetty/util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../org/eclipse/jetty/proxy/ProxyServlet.html" title="class in org.eclipse.jetty.proxy">ProxyServlet</a></dd>
</dl>
<hr>
<br>
<pre>protected class <span class="typeNameLabel">ProxyServlet.ProxyInputStreamContentProvider</span>
extends <a href="../../../../org/eclipse/jetty/client/util/InputStreamContentProvider.html" title="class in org.eclipse.jetty.client.util">InputStreamContentProvider</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.eclipse.jetty.client.api.ContentProvider">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.client.api.<a href="../../../../org/eclipse/jetty/client/api/ContentProvider.html" title="interface in org.eclipse.jetty.client.api">ContentProvider</a></h3>
<code><a href="../../../../org/eclipse/jetty/client/api/ContentProvider.Typed.html" title="interface in org.eclipse.jetty.client.api">ContentProvider.Typed</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.eclipse.jetty.util.Callback">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.util.<a href="../../../../org/eclipse/jetty/util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a></h3>
<code><a href="../../../../org/eclipse/jetty/util/Callback.Adapter.html" title="class in org.eclipse.jetty.util">Callback.Adapter</a>, <a href="../../../../org/eclipse/jetty/util/Callback.Nested.html" title="class in org.eclipse.jetty.util">Callback.Nested</a>, <a href="../../../../org/eclipse/jetty/util/Callback.NonBlocking.html" title="interface in org.eclipse.jetty.util">Callback.NonBlocking</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.eclipse.jetty.util.Callback">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.eclipse.jetty.util.<a href="../../../../org/eclipse/jetty/util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a></h3>
<code><a href="../../../../org/eclipse/jetty/util/Callback.html#NOOP">NOOP</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/proxy/ProxyServlet.ProxyInputStreamContentProvider.html#ProxyInputStreamContentProvider-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-org.eclipse.jetty.client.api.Request-java.io.InputStream-">ProxyInputStreamContentProvider</a></span>(javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response,
<a href="../../../../org/eclipse/jetty/client/api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;proxyRequest,
java.io.InputStream&nbsp;input)</code>&nbsp;</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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/proxy/ProxyServlet.ProxyInputStreamContentProvider.html#getLength--">getLength</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected java.nio.ByteBuffer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/proxy/ProxyServlet.ProxyInputStreamContentProvider.html#onRead-byte:A-int-int-">onRead</a></span>(byte[]&nbsp;buffer,
int&nbsp;offset,
int&nbsp;length)</code>
<div class="block">Callback method invoked just after having read from the stream,
but before returning the iteration element (a <code>ByteBuffer</code>
to the caller.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/proxy/ProxyServlet.ProxyInputStreamContentProvider.html#onReadFailure-java.lang.Throwable-">onReadFailure</a></span>(java.lang.Throwable&nbsp;failure)</code>
<div class="block">Callback method invoked when an exception is thrown while reading
from the stream.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected java.nio.ByteBuffer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/proxy/ProxyServlet.ProxyInputStreamContentProvider.html#onRequestContent-javax.servlet.http.HttpServletRequest-org.eclipse.jetty.client.api.Request-byte:A-int-int-">onRequestContent</a></span>(javax.servlet.http.HttpServletRequest&nbsp;request,
<a href="../../../../org/eclipse/jetty/client/api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;proxyRequest,
byte[]&nbsp;buffer,
int&nbsp;offset,
int&nbsp;length)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.jetty.client.util.InputStreamContentProvider">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.jetty.client.util.<a href="../../../../org/eclipse/jetty/client/util/InputStreamContentProvider.html" title="class in org.eclipse.jetty.client.util">InputStreamContentProvider</a></h3>
<code><a href="../../../../org/eclipse/jetty/client/util/InputStreamContentProvider.html#close--">close</a>, <a href="../../../../org/eclipse/jetty/client/util/InputStreamContentProvider.html#failed-java.lang.Throwable-">failed</a>, <a href="../../../../org/eclipse/jetty/client/util/InputStreamContentProvider.html#iterator--">iterator</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Iterable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.lang.Iterable</h3>
<code>forEach, spliterator</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.jetty.util.Callback">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.jetty.util.<a href="../../../../org/eclipse/jetty/util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a></h3>
<code><a href="../../../../org/eclipse/jetty/util/Callback.html#isNonBlocking--">isNonBlocking</a>, <a href="../../../../org/eclipse/jetty/util/Callback.html#succeeded--">succeeded</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ProxyInputStreamContentProvider-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-org.eclipse.jetty.client.api.Request-java.io.InputStream-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ProxyInputStreamContentProvider</h4>
<pre>protected&nbsp;ProxyInputStreamContentProvider(javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response,
<a href="../../../../org/eclipse/jetty/client/api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;proxyRequest,
java.io.InputStream&nbsp;input)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getLength--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLength</h4>
<pre>public&nbsp;long&nbsp;getLength()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/eclipse/jetty/client/api/ContentProvider.html#getLength--">getLength</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/eclipse/jetty/client/api/ContentProvider.html" title="interface in org.eclipse.jetty.client.api">ContentProvider</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/jetty/client/util/InputStreamContentProvider.html#getLength--">getLength</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/jetty/client/util/InputStreamContentProvider.html" title="class in org.eclipse.jetty.client.util">InputStreamContentProvider</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the content length, if known, or -1 if the content length is unknown</dd>
</dl>
</li>
</ul>
<a name="onRead-byte:A-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onRead</h4>
<pre>protected&nbsp;java.nio.ByteBuffer&nbsp;onRead(byte[]&nbsp;buffer,
int&nbsp;offset,
int&nbsp;length)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../org/eclipse/jetty/client/util/InputStreamContentProvider.html#onRead-byte:A-int-int-">InputStreamContentProvider</a></code></span></div>
<div class="block">Callback method invoked just after having read from the stream,
but before returning the iteration element (a <code>ByteBuffer</code>
to the caller.
<p>
Subclasses may override this method to copy the content read from
the stream to another location (a file, or in memory if the content
is known to fit).</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/jetty/client/util/InputStreamContentProvider.html#onRead-byte:A-int-int-">onRead</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/jetty/client/util/InputStreamContentProvider.html" title="class in org.eclipse.jetty.client.util">InputStreamContentProvider</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>buffer</code> - the byte array containing the bytes read</dd>
<dd><code>offset</code> - the offset from where bytes should be read</dd>
<dd><code>length</code> - the length of the bytes read</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>ByteBuffer</code> wrapping the byte array</dd>
</dl>
</li>
</ul>
<a name="onRequestContent-javax.servlet.http.HttpServletRequest-org.eclipse.jetty.client.api.Request-byte:A-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onRequestContent</h4>
<pre>protected&nbsp;java.nio.ByteBuffer&nbsp;onRequestContent(javax.servlet.http.HttpServletRequest&nbsp;request,
<a href="../../../../org/eclipse/jetty/client/api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;proxyRequest,
byte[]&nbsp;buffer,
int&nbsp;offset,
int&nbsp;length)</pre>
</li>
</ul>
<a name="onReadFailure-java.lang.Throwable-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>onReadFailure</h4>
<pre>protected&nbsp;void&nbsp;onReadFailure(java.lang.Throwable&nbsp;failure)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../org/eclipse/jetty/client/util/InputStreamContentProvider.html#onReadFailure-java.lang.Throwable-">InputStreamContentProvider</a></code></span></div>
<div class="block">Callback method invoked when an exception is thrown while reading
from the stream.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/jetty/client/util/InputStreamContentProvider.html#onReadFailure-java.lang.Throwable-">onReadFailure</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/jetty/client/util/InputStreamContentProvider.html" title="class in org.eclipse.jetty.client.util">InputStreamContentProvider</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>failure</code> - the exception thrown while reading from the stream.</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/ProxyServlet.ProxyInputStreamContentProvider.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/ProxyServlet.html" title="class in org.eclipse.jetty.proxy"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/eclipse/jetty/proxy/ProxyServlet.ProxyResponseListener.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/ProxyServlet.ProxyInputStreamContentProvider.html" target="_top">Frames</a></li>
<li><a href="ProxyServlet.ProxyInputStreamContentProvider.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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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>