blob: ad8f5ce958b16e4e0f0128ad9fa6aecc2eedbb49 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 -->
<title>HeronServerTester (Heron Java API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2023-03-01">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/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="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="HeronServerTester (Heron Java API)";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":9,"i2":10,"i3":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.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" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.heron.common.testhelpers</a></div>
<h2 title="Class HeronServerTester" class="title">Class HeronServerTester</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.heron.common.testhelpers.HeronServerTester</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">HeronServerTester</span>
extends java.lang.Object</pre>
<div class="block">Class to help simplify testing HeronServer implementations by consolidating common test
functionality. A new instance of this class should be used for each test. After initializing the
class, tests should call start() which guarantees the following:
<ol>
<li>the server has started</li>
<li>the client has been launched</li>
</ol>
Upon test completion, the stop() method should be closed to properly release resources. This
method is safe to be called on an instance that was never properly started.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="HeronServerTester.AbstractTestClient.html" title="class in org.apache.heron.common.testhelpers">HeronServerTester.AbstractTestClient</a></span></code></th>
<td class="colLast">
<div class="block">Abstract class to simplify writing test clients by providing default method impls.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="HeronServerTester.SuccessResponseHandler.html" title="class in org.apache.heron.common.testhelpers">HeronServerTester.SuccessResponseHandler</a></span></code></th>
<td class="colLast">
<div class="block">Generic SuccessResponseHandler that asserts that the response status code is OK and that the
message is of the expected type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="HeronServerTester.TestRequestHandler.html" title="interface in org.apache.heron.common.testhelpers">HeronServerTester.TestRequestHandler</a></span></code></th>
<td class="colLast">
<div class="block">Interface to provide the Message to be sent upon onConnect and the expected Message.Builder
to be used for the response.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="HeronServerTester.TestResponseHandler.html" title="interface in org.apache.heron.common.testhelpers">HeronServerTester.TestResponseHandler</a></span></code></th>
<td class="colLast">
<div class="block">Interface to handle a response received by the server.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.time.Duration</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#RESPONSE_RECEIVED_TIMEOUT">RESPONSE_RECEIVED_TIMEOUT</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SERVER_HOST">SERVER_HOST</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../network/HeronSocketOptions.html" title="class in org.apache.heron.common.network">HeronSocketOptions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#TEST_SOCKET_OPTIONS">TEST_SOCKET_OPTIONS</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.heron.common.network.HeronServer,org.apache.heron.common.network.HeronClient)">HeronServerTester</a></span>&#8203;(<a href="../network/HeronServer.html" title="class in org.apache.heron.common.network">HeronServer</a>&nbsp;server,
<a href="../network/HeronClient.html" title="class in org.apache.heron.common.network">HeronClient</a>&nbsp;client)</code></th>
<td class="colLast">
<div class="block">Constructor where a custom client is to be used.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.heron.common.network.HeronServer,org.apache.heron.common.testhelpers.HeronServerTester.TestRequestHandler,org.apache.heron.common.testhelpers.HeronServerTester.TestResponseHandler,java.time.Duration)">HeronServerTester</a></span>&#8203;(<a href="../network/HeronServer.html" title="class in org.apache.heron.common.network">HeronServer</a>&nbsp;server,
<a href="HeronServerTester.TestRequestHandler.html" title="interface in org.apache.heron.common.testhelpers">HeronServerTester.TestRequestHandler</a>&nbsp;requestHandler,
<a href="HeronServerTester.TestResponseHandler.html" title="interface in org.apache.heron.common.testhelpers">HeronServerTester.TestResponseHandler</a>&nbsp;responseHandler,
java.time.Duration&nbsp;responseReceivedTimeout)</code></th>
<td class="colLast">
<div class="block">Constructor to use for the common use case of sending a single request and taking some action
upon a response.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#await(java.util.concurrent.CountDownLatch)">await</a></span>&#8203;(java.util.concurrent.CountDownLatch&nbsp;latch)</code></th>
<td class="colLast">
<div class="block">Convenience method to wait on a latch with a default timeout.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#await(java.util.concurrent.CountDownLatch,java.time.Duration)">await</a></span>&#8203;(java.util.concurrent.CountDownLatch&nbsp;latch,
java.time.Duration&nbsp;timeout)</code></th>
<td class="colLast">
<div class="block">Convenience method to wait on a latch with a default timeout.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#start()">start</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#stop()">stop</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="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>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="SERVER_HOST">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SERVER_HOST</h4>
<pre>public static final&nbsp;java.lang.String SERVER_HOST</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.heron.common.testhelpers.HeronServerTester.SERVER_HOST">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="TEST_SOCKET_OPTIONS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TEST_SOCKET_OPTIONS</h4>
<pre>public static final&nbsp;<a href="../network/HeronSocketOptions.html" title="class in org.apache.heron.common.network">HeronSocketOptions</a> TEST_SOCKET_OPTIONS</pre>
</li>
</ul>
<a id="RESPONSE_RECEIVED_TIMEOUT">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RESPONSE_RECEIVED_TIMEOUT</h4>
<pre>public static final&nbsp;java.time.Duration RESPONSE_RECEIVED_TIMEOUT</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(org.apache.heron.common.network.HeronServer,org.apache.heron.common.testhelpers.HeronServerTester.TestRequestHandler,org.apache.heron.common.testhelpers.HeronServerTester.TestResponseHandler,java.time.Duration)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HeronServerTester</h4>
<pre>public&nbsp;HeronServerTester&#8203;(<a href="../network/HeronServer.html" title="class in org.apache.heron.common.network">HeronServer</a>&nbsp;server,
<a href="HeronServerTester.TestRequestHandler.html" title="interface in org.apache.heron.common.testhelpers">HeronServerTester.TestRequestHandler</a>&nbsp;requestHandler,
<a href="HeronServerTester.TestResponseHandler.html" title="interface in org.apache.heron.common.testhelpers">HeronServerTester.TestResponseHandler</a>&nbsp;responseHandler,
java.time.Duration&nbsp;responseReceivedTimeout)
throws java.io.IOException</pre>
<div class="block">Constructor to use for the common use case of sending a single request and taking some action
upon a response. The start() method does the following:
<ol>
<li>Initializes the server and a default client</li>
<li>Calls sendMessage on the client using the message from TestRequestHandler</li>
<li>Waits up to responseReceivedTimeout for the client to receive a response</li>
<li>Invokes the TestResponseHandler.handleResponse method</li>
</ol></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>server</code> - the server to test</dd>
<dd><code>requestHandler</code> - the request handler to use to build the request and response builder</dd>
<dd><code>responseHandler</code> - the handler to handle the received response</dd>
<dd><code>responseReceivedTimeout</code> - how long to wait for the response</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(org.apache.heron.common.network.HeronServer,org.apache.heron.common.network.HeronClient)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>HeronServerTester</h4>
<pre>public&nbsp;HeronServerTester&#8203;(<a href="../network/HeronServer.html" title="class in org.apache.heron.common.network">HeronServer</a>&nbsp;server,
<a href="../network/HeronClient.html" title="class in org.apache.heron.common.network">HeronClient</a>&nbsp;client)</pre>
<div class="block">Constructor where a custom client is to be used. The start() method starts both the server and
the client.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>server</code> - server to test</dd>
<dd><code>client</code> - client to test</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="start()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;start()</pre>
</li>
</ul>
<a id="stop()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;stop()</pre>
</li>
</ul>
<a id="await(java.util.concurrent.CountDownLatch)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>await</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;await&#8203;(java.util.concurrent.CountDownLatch&nbsp;latch)</pre>
<div class="block">Convenience method to wait on a latch with a default timeout. If the timeout is reached, the
fail() method will be invoked.</div>
</li>
</ul>
<a id="await(java.util.concurrent.CountDownLatch,java.time.Duration)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>await</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;await&#8203;(java.util.concurrent.CountDownLatch&nbsp;latch,
java.time.Duration&nbsp;timeout)</pre>
<div class="block">Convenience method to wait on a latch with a default timeout. If the timeout is reached, the
fail() method will be invoked.</div>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.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" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>