| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) on Thu Sep 15 14:12:07 CDT 2022 --> |
| <title>ContentProvider (Eclipse Jetty API Doc - v10.0.12)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-09-15"> |
| <meta name="description" content="declaration: package: org.eclipse.jetty.client.api, interface: ContentProvider"> |
| <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"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.5.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 evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| 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"> |
| <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/ContentProvider.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> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </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"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </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.eclipse.jetty.client.api</a></div> |
| <h1 title="Interface ContentProvider" class="title">Interface ContentProvider</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/11/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a>></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="../AsyncContentProvider.html" title="interface in org.eclipse.jetty.client">AsyncContentProvider</a></code>, <code><a href="ContentProvider.Typed.html" title="interface in org.eclipse.jetty.client.api">ContentProvider.Typed</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../util/AbstractTypedContentProvider.html" title="class in org.eclipse.jetty.client.util">AbstractTypedContentProvider</a></code>, <code><a href="../util/ByteBufferContentProvider.html" title="class in org.eclipse.jetty.client.util">ByteBufferContentProvider</a></code>, <code><a href="../util/BytesContentProvider.html" title="class in org.eclipse.jetty.client.util">BytesContentProvider</a></code>, <code><a href="../util/DeferredContentProvider.html" title="class in org.eclipse.jetty.client.util">DeferredContentProvider</a></code>, <code><a href="../util/FormContentProvider.html" title="class in org.eclipse.jetty.client.util">FormContentProvider</a></code>, <code><a href="../util/InputStreamContentProvider.html" title="class in org.eclipse.jetty.client.util">InputStreamContentProvider</a></code>, <code><a href="../util/MultiPartContentProvider.html" title="class in org.eclipse.jetty.client.util">MultiPartContentProvider</a></code>, <code><a href="../util/OutputStreamContentProvider.html" title="class in org.eclipse.jetty.client.util">OutputStreamContentProvider</a></code>, <code><a href="../util/PathContentProvider.html" title="class in org.eclipse.jetty.client.util">PathContentProvider</a></code>, <code><a href="../util/StringContentProvider.html" title="class in org.eclipse.jetty.client.util">StringContentProvider</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public interface </span><span class="element-name type-name-label">ContentProvider</span><span class="extends-implements"> |
| extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a>></span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use <a href="Request.Content.html" title="interface in org.eclipse.jetty.client.api"><code>Request.Content</code></a> instead, or <a href="#toRequestContent(org.eclipse.jetty.client.api.ContentProvider)"><code>toRequestContent(ContentProvider)</code></a> |
| to convert ContentProvider to <a href="Request.Content.html" title="interface in org.eclipse.jetty.client.api"><code>Request.Content</code></a>.</div> |
| </div> |
| <div class="block"><p><a href="ContentProvider.html" title="interface in org.eclipse.jetty.client.api"><code>ContentProvider</code></a> provides a source of request content.</p> |
| <p>Implementations should return an <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link"><code>Iterator</code></a> over the request content. |
| If the request content comes from a source that needs to be closed (for |
| example, an <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link"><code>InputStream</code></a>), then the iterator implementation class |
| must implement <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Closeable.html" title="class or interface in java.io" class="external-link"><code>Closeable</code></a> and will be closed when the request is |
| completed (either successfully or failed).</p> |
| <p>Applications should rely on utility classes such as <a href="../util/ByteBufferContentProvider.html" title="class in org.eclipse.jetty.client.util"><code>ByteBufferContentProvider</code></a> |
| or <a href="../util/PathContentProvider.html" title="class in org.eclipse.jetty.client.util"><code>PathContentProvider</code></a>.</p> |
| <p><a href="ContentProvider.html" title="interface in org.eclipse.jetty.client.api"><code>ContentProvider</code></a> provides a <a href="#getLength()"><code>length</code></a> of the content |
| it represents. |
| If the length is positive, it typically overrides any <code>Content-Length</code> |
| header set by applications; if the length is negative, it typically removes |
| any <code>Content-Length</code> header set by applications, resulting in chunked |
| content (i.e. <code>Transfer-Encoding: chunked</code>) being sent to the server.</p></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Interface</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static interface </code></div> |
| <div class="col-second even-row-color"><code><a href="ContentProvider.Typed.html" class="type-name-link" title="interface in org.eclipse.jetty.client.api">ContentProvider.Typed</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use <a href="Request.Content.html" title="interface in org.eclipse.jetty.client.api"><code>Request.Content</code></a> instead</div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== 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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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><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"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <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 method-summary-table-tab6"><code>long</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="#getLength()" class="member-name-link">getLength</a>()</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-tab5 method-summary-table-tab6"><code>default boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5 method-summary-table-tab6"><code><a href="#isReproducible()" class="member-name-link">isReproducible</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block">Whether this ContentProvider can produce exactly the same content more |
| than once.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab6"><code>static <a href="Request.Content.html" title="interface in org.eclipse.jetty.client.api">Request.Content</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab6"><code><a href="#toRequestContent(org.eclipse.jetty.client.api.ContentProvider)" class="member-name-link">toRequestContent</a><wbr>(<a href="ContentProvider.html" title="interface in org.eclipse.jetty.client.api">ContentProvider</a> provider)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block">Converts a ContentProvider to a <a href="Request.Content.html" title="interface in org.eclipse.jetty.client.api"><code>Request.Content</code></a>.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Iterable">Methods inherited from interface java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Iterable.html#forEach(java.util.function.Consumer)" title="class or interface in java.lang" class="external-link">forEach</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Iterable.html#iterator()" title="class or interface in java.lang" class="external-link">iterator</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Iterable.html#spliterator()" title="class or interface in java.lang" class="external-link">spliterator</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="toRequestContent(org.eclipse.jetty.client.api.ContentProvider)"> |
| <h3>toRequestContent</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type"><a href="Request.Content.html" title="interface in org.eclipse.jetty.client.api">Request.Content</a></span> <span class="element-name">toRequestContent</span><wbr><span class="parameters">(<a href="ContentProvider.html" title="interface in org.eclipse.jetty.client.api">ContentProvider</a> provider)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block"><p>Converts a ContentProvider to a <a href="Request.Content.html" title="interface in org.eclipse.jetty.client.api"><code>Request.Content</code></a>.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>provider</code> - the ContentProvider to convert</dd> |
| <dt>Returns:</dt> |
| <dd>a <a href="Request.Content.html" title="interface in org.eclipse.jetty.client.api"><code>Request.Content</code></a> that wraps the ContentProvider</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLength()"> |
| <h3>getLength</h3> |
| <div class="member-signature"><span class="return-type">long</span> <span class="element-name">getLength</span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the content length, if known, or -1 if the content length is unknown</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isReproducible()"> |
| <h3>isReproducible</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">boolean</span> <span class="element-name">isReproducible</span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block"><p>Whether this ContentProvider can produce exactly the same content more |
| than once.</p> |
| <p>Implementations should return <code>true</code> only if the content can be |
| produced more than once, which means that invocations to <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Iterable.html#iterator()" title="class or interface in java.lang" class="external-link"><code>Iterable.iterator()</code></a> |
| must return a new, independent, iterator instance over the content.</p> |
| <p>The <a href="../HttpClient.html" title="class in org.eclipse.jetty.client"><code>HttpClient</code></a> implementation may use this method in particular |
| cases where it detects that it is safe to retry a request that failed.</p></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>whether the content can be produced more than once</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 1995–2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
