blob: dbeb86fca4c3b8ddec31bd72a7078103bb253a72 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Thu Sep 15 14:12:07 CDT 2022 -->
<title>AbstractRequestContent (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.util, class: AbstractRequestContent">
<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/AbstractRequestContent.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:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&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="sub-nav-list">
<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>
<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>&nbsp;<a href="package-summary.html">org.eclipse.jetty.client.util</a></div>
<h1 title="Class AbstractRequestContent" class="title">Class AbstractRequestContent</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">org.eclipse.jetty.client.util.AbstractRequestContent</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../api/Request.Content.html" title="interface in org.eclipse.jetty.client.api">Request.Content</a></code></dd>
</dl>
<dl class="notes">
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="ByteBufferRequestContent.html" title="class in org.eclipse.jetty.client.util">ByteBufferRequestContent</a></code>, <code><a href="BytesRequestContent.html" title="class in org.eclipse.jetty.client.util">BytesRequestContent</a></code>, <code><a href="InputStreamRequestContent.html" title="class in org.eclipse.jetty.client.util">InputStreamRequestContent</a></code>, <code><a href="MultiPartRequestContent.html" title="class in org.eclipse.jetty.client.util">MultiPartRequestContent</a></code>, <code><a href="PathRequestContent.html" title="class in org.eclipse.jetty.client.util">PathRequestContent</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">AbstractRequestContent</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
implements <a href="../api/Request.Content.html" title="interface in org.eclipse.jetty.client.api">Request.Content</a></span></div>
<div class="block"><p>Partial implementation of <a href="../api/Request.Content.html" title="interface in org.eclipse.jetty.client.api"><code>Request.Content</code></a>.</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">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="AbstractRequestContent.AbstractSubscription.html" class="type-name-link" title="class in org.eclipse.jetty.client.util">AbstractRequestContent.AbstractSubscription</a></code></div>
<div class="col-last even-row-color">
<div class="block">Partial implementation of <code>Subscription</code>.</div>
</div>
<div class="col-first odd-row-color"><code>static interface&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="AbstractRequestContent.Producer.html" class="type-name-link" title="interface in org.eclipse.jetty.client.util">AbstractRequestContent.Producer</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
<div class="inherited-list">
<h2 id="nested-classes-inherited-from-class-org.eclipse.jetty.client.api.Request.Content">Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.client.api.<a href="../api/Request.Content.html" title="interface in org.eclipse.jetty.client.api">Request.Content</a></h2>
<code><a href="../api/Request.Content.Consumer.html" title="interface in org.eclipse.jetty.client.api">Request.Content.Consumer</a>, <a href="../api/Request.Content.Subscription.html" title="interface in org.eclipse.jetty.client.api">Request.Content.Subscription</a></code></div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier</div>
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>protected </code></div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String)" class="member-name-link">AbstractRequestContent</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;contentType)</code></div>
<div class="col-last even-row-color">&nbsp;</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-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-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete 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-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/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-tab4"><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-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>protected abstract <a href="../api/Request.Content.Subscription.html" title="interface in org.eclipse.jetty.client.api">Request.Content.Subscription</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newSubscription(org.eclipse.jetty.client.api.Request.Content.Consumer,boolean)" class="member-name-link">newSubscription</a><wbr>(<a href="../api/Request.Content.Consumer.html" title="interface in org.eclipse.jetty.client.api">Request.Content.Consumer</a>&nbsp;consumer,
boolean&nbsp;emitInitialContent)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../api/Request.Content.Subscription.html" title="interface in org.eclipse.jetty.client.api">Request.Content.Subscription</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#subscribe(org.eclipse.jetty.client.api.Request.Content.Consumer,boolean)" class="member-name-link">subscribe</a><wbr>(<a href="../api/Request.Content.Consumer.html" title="interface in org.eclipse.jetty.client.api">Request.Content.Consumer</a>&nbsp;consumer,
boolean&nbsp;emitInitialContent)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Initializes this content producer with the content consumer, and with
the indication of whether initial content, if present, must be emitted
upon the initial demand of content (to support delaying the send of the
request content in case of <code>Expect: 100-Continue</code> when
<code>emitInitialContent</code> is <code>false</code>).</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.eclipse.jetty.client.api.Request.Content">Methods inherited from interface&nbsp;org.eclipse.jetty.client.api.<a href="../api/Request.Content.html" title="interface in org.eclipse.jetty.client.api">Request.Content</a></h3>
<code><a href="../api/Request.Content.html#fail(java.lang.Throwable)">fail</a>, <a href="../api/Request.Content.html#getLength()">getLength</a>, <a href="../api/Request.Content.html#isReproducible()">isReproducible</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(java.lang.String)">
<h3>AbstractRequestContent</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="element-name">AbstractRequestContent</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;contentType)</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getContentType()">
<h3>getContentType</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getContentType</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../api/Request.Content.html#getContentType()">getContentType</a></code>&nbsp;in interface&nbsp;<code><a href="../api/Request.Content.html" title="interface in org.eclipse.jetty.client.api">Request.Content</a></code></dd>
<dt>Returns:</dt>
<dd>the content type string such as "application/octet-stream" or
"application/json;charset=UTF8", or null if no content type must be set</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="subscribe(org.eclipse.jetty.client.api.Request.Content.Consumer,boolean)">
<h3>subscribe</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../api/Request.Content.Subscription.html" title="interface in org.eclipse.jetty.client.api">Request.Content.Subscription</a></span>&nbsp;<span class="element-name">subscribe</span><wbr><span class="parameters">(<a href="../api/Request.Content.Consumer.html" title="interface in org.eclipse.jetty.client.api">Request.Content.Consumer</a>&nbsp;consumer,
boolean&nbsp;emitInitialContent)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../api/Request.Content.html#subscribe(org.eclipse.jetty.client.api.Request.Content.Consumer,boolean)">Request.Content</a></code></span></div>
<div class="block"><p>Initializes this content producer with the content consumer, and with
the indication of whether initial content, if present, must be emitted
upon the initial demand of content (to support delaying the send of the
request content in case of <code>Expect: 100-Continue</code> when
<code>emitInitialContent</code> is <code>false</code>).</p></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../api/Request.Content.html#subscribe(org.eclipse.jetty.client.api.Request.Content.Consumer,boolean)">subscribe</a></code>&nbsp;in interface&nbsp;<code><a href="../api/Request.Content.html" title="interface in org.eclipse.jetty.client.api">Request.Content</a></code></dd>
<dt>Parameters:</dt>
<dd><code>consumer</code> - the content consumer to invoke when there is demand for content</dd>
<dd><code>emitInitialContent</code> - whether to emit initial content, if present</dd>
<dt>Returns:</dt>
<dd>the Subscription that links this producer to the consumer</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="newSubscription(org.eclipse.jetty.client.api.Request.Content.Consumer,boolean)">
<h3>newSubscription</h3>
<div class="member-signature"><span class="modifiers">protected abstract</span>&nbsp;<span class="return-type"><a href="../api/Request.Content.Subscription.html" title="interface in org.eclipse.jetty.client.api">Request.Content.Subscription</a></span>&nbsp;<span class="element-name">newSubscription</span><wbr><span class="parameters">(<a href="../api/Request.Content.Consumer.html" title="interface in org.eclipse.jetty.client.api">Request.Content.Consumer</a>&nbsp;consumer,
boolean&nbsp;emitInitialContent)</span></div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 1995&#x2013;2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>