Google Git
Sign in
apache / arrow-site / refs/heads/asf-site / . / docs / dev / java / reference / org / apache / arrow / flight / client / ClientCookieMiddleware.html
blob: ac347ba06043c3670ebd295aad20e9d3cfea217d [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 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ClientCookieMiddleware (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)</title>
<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="ClientCookieMiddleware (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":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/ClientCookieMiddleware.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>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/arrow/flight/client/ClientCookieMiddleware.Factory.html" title="class in org.apache.arrow.flight.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/arrow/flight/client/ClientCookieMiddleware.html" target="_top">Frames</a></li>
<li><a href="ClientCookieMiddleware.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&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>Field&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.apache.arrow.flight.client</div>
<h2 title="Class ClientCookieMiddleware" class="title">Class ClientCookieMiddleware</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.arrow.flight.client.ClientCookieMiddleware</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/apache/arrow/flight/FlightClientMiddleware.html" title="interface in org.apache.arrow.flight">FlightClientMiddleware</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">ClientCookieMiddleware</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../../org/apache/arrow/flight/FlightClientMiddleware.html" title="interface in org.apache.arrow.flight">FlightClientMiddleware</a></pre>
<div class="block">A client middleware for receiving and sending cookie information.
Note that this class will not persist permanent cookies beyond the lifetime
of this session.
This middleware will automatically remove cookies that have expired.
<b>Note</b>: Negative max-age values currently do not get marked as expired due to
a JDK issue. Use max-age=0 to explicitly remove an existing cookie.</div>
</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">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/client/ClientCookieMiddleware.Factory.html" title="class in org.apache.arrow.flight.client">ClientCookieMiddleware.Factory</a></span></code>
<div class="block">Factory used within FlightClient.</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="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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/client/ClientCookieMiddleware.html#onBeforeSendingHeaders-org.apache.arrow.flight.CallHeaders-">onBeforeSendingHeaders</a></span>(<a href="../../../../../org/apache/arrow/flight/CallHeaders.html" title="interface in org.apache.arrow.flight">CallHeaders</a>&nbsp;outgoingHeaders)</code>
<div class="block">A callback used before request headers are sent.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/client/ClientCookieMiddleware.html#onCallCompleted-org.apache.arrow.flight.CallStatus-">onCallCompleted</a></span>(<a href="../../../../../org/apache/arrow/flight/CallStatus.html" title="class in org.apache.arrow.flight">CallStatus</a>&nbsp;status)</code>
<div class="block">A callback called after the call completes.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/client/ClientCookieMiddleware.html#onHeadersReceived-org.apache.arrow.flight.CallHeaders-">onHeadersReceived</a></span>(<a href="../../../../../org/apache/arrow/flight/CallHeaders.html" title="interface in org.apache.arrow.flight">CallHeaders</a>&nbsp;incomingHeaders)</code>
<div class="block">A callback called after response headers are received.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</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="onBeforeSendingHeaders-org.apache.arrow.flight.CallHeaders-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onBeforeSendingHeaders</h4>
<pre>public&nbsp;void&nbsp;onBeforeSendingHeaders(<a href="../../../../../org/apache/arrow/flight/CallHeaders.html" title="interface in org.apache.arrow.flight">CallHeaders</a>&nbsp;outgoingHeaders)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/arrow/flight/FlightClientMiddleware.html#onBeforeSendingHeaders-org.apache.arrow.flight.CallHeaders-">FlightClientMiddleware</a></code></span></div>
<div class="block">A callback used before request headers are sent. The headers may be manipulated.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/arrow/flight/FlightClientMiddleware.html#onBeforeSendingHeaders-org.apache.arrow.flight.CallHeaders-">onBeforeSendingHeaders</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/arrow/flight/FlightClientMiddleware.html" title="interface in org.apache.arrow.flight">FlightClientMiddleware</a></code></dd>
</dl>
</li>
</ul>
<a name="onHeadersReceived-org.apache.arrow.flight.CallHeaders-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onHeadersReceived</h4>
<pre>public&nbsp;void&nbsp;onHeadersReceived(<a href="../../../../../org/apache/arrow/flight/CallHeaders.html" title="interface in org.apache.arrow.flight">CallHeaders</a>&nbsp;incomingHeaders)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/arrow/flight/FlightClientMiddleware.html#onHeadersReceived-org.apache.arrow.flight.CallHeaders-">FlightClientMiddleware</a></code></span></div>
<div class="block">A callback called after response headers are received. The headers may be manipulated.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/arrow/flight/FlightClientMiddleware.html#onHeadersReceived-org.apache.arrow.flight.CallHeaders-">onHeadersReceived</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/arrow/flight/FlightClientMiddleware.html" title="interface in org.apache.arrow.flight">FlightClientMiddleware</a></code></dd>
</dl>
</li>
</ul>
<a name="onCallCompleted-org.apache.arrow.flight.CallStatus-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>onCallCompleted</h4>
<pre>public&nbsp;void&nbsp;onCallCompleted(<a href="../../../../../org/apache/arrow/flight/CallStatus.html" title="class in org.apache.arrow.flight">CallStatus</a>&nbsp;status)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/arrow/flight/FlightClientMiddleware.html#onCallCompleted-org.apache.arrow.flight.CallStatus-">FlightClientMiddleware</a></code></span></div>
<div class="block">A callback called after the call completes.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/arrow/flight/FlightClientMiddleware.html#onCallCompleted-org.apache.arrow.flight.CallStatus-">onCallCompleted</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/arrow/flight/FlightClientMiddleware.html" title="interface in org.apache.arrow.flight">FlightClientMiddleware</a></code></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/ClientCookieMiddleware.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>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/arrow/flight/client/ClientCookieMiddleware.Factory.html" title="class in org.apache.arrow.flight.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/arrow/flight/client/ClientCookieMiddleware.html" target="_top">Frames</a></li>
<li><a href="ClientCookieMiddleware.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&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>Field&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; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>