338 lines
15 KiB
HTML
338 lines
15 KiB
HTML
<!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_181-google-v7) on Thu Apr 25 10:43:39 PDT 2019 -->
|
|
<title>TextFormat (openconsensus-api 0.1.0-SNAPSHOT API)</title>
|
|
<meta name="date" content="2019-04-25">
|
|
<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="TextFormat (openconsensus-api 0.1.0-SNAPSHOT API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var methods = {"i0":6,"i1":6,"i2":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="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="../../../openconsensus/context/propagation/BinaryFormat.html" title="interface in openconsensus.context.propagation"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../../openconsensus/context/propagation/TextFormat.Getter.html" title="interface in openconsensus.context.propagation"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../index.html?openconsensus/context/propagation/TextFormat.html" target="_top">Frames</a></li>
|
|
<li><a href="TextFormat.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../../allclasses-noframe.html">All 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: </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="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </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">openconsensus.context.propagation</div>
|
|
<h2 title="Interface TextFormat" class="title">Interface TextFormat<V></h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<br>
|
|
<pre>public interface <span class="typeNameLabel">TextFormat<V></span></pre>
|
|
<div class="block">Injects and extracts a value as text into carriers that travel in-band across process boundaries.
|
|
Values are often encoded as RPC/HTTP request headers.
|
|
|
|
<p>When using http, the carrier of propagated data on both the client (injector) and server
|
|
(extractor) side is usually an http request. Propagation is usually implemented via library-
|
|
specific request interceptors, where the client-side injects values and the server-side extracts
|
|
them.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>0.1.0</dd>
|
|
</dl>
|
|
</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>
|
|
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
|
|
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colLast" scope="col">Interface and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static interface </code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../openconsensus/context/propagation/TextFormat.Getter.html" title="interface in openconsensus.context.propagation">TextFormat.Getter</a><<a href="../../../openconsensus/context/propagation/TextFormat.Getter.html" title="type parameter in TextFormat.Getter">C</a>></span></code>
|
|
<div class="block">Interface that allows a <code>TextFormat</code> to read propagated fields from a carrier.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static interface </code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../openconsensus/context/propagation/TextFormat.Setter.html" title="interface in openconsensus.context.propagation">TextFormat.Setter</a><<a href="../../../openconsensus/context/propagation/TextFormat.Setter.html" title="type parameter in TextFormat.Setter">C</a>></span></code>
|
|
<div class="block">Class that allows a <code>TextFormat</code> to set propagated fields into a carrier.</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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><C> <a href="../../../openconsensus/context/propagation/TextFormat.html" title="type parameter in TextFormat">V</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../openconsensus/context/propagation/TextFormat.html#extract-C-openconsensus.context.propagation.TextFormat.Getter-">extract</a></span>(C carrier,
|
|
<a href="../../../openconsensus/context/propagation/TextFormat.Getter.html" title="interface in openconsensus.context.propagation">TextFormat.Getter</a><C> getter)</code>
|
|
<div class="block">Extracts the value from upstream.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../openconsensus/context/propagation/TextFormat.html#fields--">fields</a></span>()</code>
|
|
<div class="block">The propagation fields defined.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code><C> void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../openconsensus/context/propagation/TextFormat.html#inject-V-C-openconsensus.context.propagation.TextFormat.Setter-">inject</a></span>(<a href="../../../openconsensus/context/propagation/TextFormat.html" title="type parameter in TextFormat">V</a> value,
|
|
C carrier,
|
|
<a href="../../../openconsensus/context/propagation/TextFormat.Setter.html" title="interface in openconsensus.context.propagation">TextFormat.Setter</a><C> setter)</code>
|
|
<div class="block">Injects the value downstream.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="fields--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>fields</h4>
|
|
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> fields()</pre>
|
|
<div class="block">The propagation fields defined. If your carrier is reused, you should delete the fields here
|
|
before calling <a href="../../../openconsensus/context/propagation/TextFormat.html#inject-V-C-openconsensus.context.propagation.TextFormat.Setter-"><code>inject(Object, Object, Setter)</code></a> )}.
|
|
|
|
<p>For example, if the carrier is a single-use or immutable request object, you don't need to
|
|
clear fields as they couldn't have been set before. If it is a mutable, retryable object,
|
|
successive calls should clear these fields first.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>list of fields that will be used by this formatter.</dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>0.1.0</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="inject-java.lang.Object-java.lang.Object-openconsensus.context.propagation.TextFormat.Setter-">
|
|
<!-- -->
|
|
</a><a name="inject-V-C-openconsensus.context.propagation.TextFormat.Setter-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>inject</h4>
|
|
<pre><C> void inject(<a href="../../../openconsensus/context/propagation/TextFormat.html" title="type parameter in TextFormat">V</a> value,
|
|
C carrier,
|
|
<a href="../../../openconsensus/context/propagation/TextFormat.Setter.html" title="interface in openconsensus.context.propagation">TextFormat.Setter</a><C> setter)</pre>
|
|
<div class="block">Injects the value downstream. For example, as http headers.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Type Parameters:</span></dt>
|
|
<dd><code>C</code> - carrier of propagation fields, such as an http request</dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - the value to be injected.</dd>
|
|
<dd><code>carrier</code> - holds propagation fields. For example, an outgoing message or http request.</dd>
|
|
<dd><code>setter</code> - invoked for each propagation key to add or remove.</dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>0.1.0</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="extract-java.lang.Object-openconsensus.context.propagation.TextFormat.Getter-">
|
|
<!-- -->
|
|
</a><a name="extract-C-openconsensus.context.propagation.TextFormat.Getter-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>extract</h4>
|
|
<pre><C> <a href="../../../openconsensus/context/propagation/TextFormat.html" title="type parameter in TextFormat">V</a> extract(C carrier,
|
|
<a href="../../../openconsensus/context/propagation/TextFormat.Getter.html" title="interface in openconsensus.context.propagation">TextFormat.Getter</a><C> getter)</pre>
|
|
<div class="block">Extracts the value from upstream. For example, as http headers.
|
|
|
|
<p>If the value could not be parsed, the underlying implementation will decide to return ether
|
|
an empty value, an invalid value, or a valid value.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Type Parameters:</span></dt>
|
|
<dd><code>C</code> - carrier of propagation fields, such as an http request.</dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>carrier</code> - holds propagation fields. For example, an outgoing message or http request.</dd>
|
|
<dd><code>getter</code> - invoked for each propagation key to get.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the extracted value.</dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>0.1.0</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="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="../../../openconsensus/context/propagation/BinaryFormat.html" title="interface in openconsensus.context.propagation"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../../openconsensus/context/propagation/TextFormat.Getter.html" title="interface in openconsensus.context.propagation"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../index.html?openconsensus/context/propagation/TextFormat.html" target="_top">Frames</a></li>
|
|
<li><a href="TextFormat.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../allclasses-noframe.html">All 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: </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="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</body>
|
|
</html>
|