| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>NetworkUtils (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="NetworkUtils (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </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"> </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> <a href="package-summary.html">org.apache.heron.spi.utils</a></div> |
| <h2 title="Class NetworkUtils" class="title">Class NetworkUtils</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.heron.spi.utils.NetworkUtils</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre>public final class <span class="typeNameLabel">NetworkUtils</span> |
| extends java.lang.Object</pre> |
| <div class="block">Utilities related to network.</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"> </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 </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="NetworkUtils.HeronSystem.html" title="enum in org.apache.heron.spi.utils">NetworkUtils.HeronSystem</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="NetworkUtils.TunnelConfig.html" title="class in org.apache.heron.spi.utils">NetworkUtils.TunnelConfig</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="NetworkUtils.TunnelType.html" title="enum in org.apache.heron.spi.utils">NetworkUtils.TunnelType</a></span></code></th> |
| <td class="colLast"> </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"> </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.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#JSON_TYPE">JSON_TYPE</a></span></code></th> |
| <td class="colLast"> </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="#URL_ENCODE_TYPE">URL_ENCODE_TYPE</a></span></code></th> |
| <td class="colLast"> </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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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 boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkHttpResponseCode(java.net.HttpURLConnection,int)">checkHttpResponseCode</a></span>​(java.net.HttpURLConnection connection, |
| int expectedCode)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../common/basics/Pair.html" title="class in org.apache.heron.common.basics">Pair</a><java.net.InetSocketAddress,​java.lang.Process></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#establishSSHTunnelIfNeeded(java.net.InetSocketAddress,org.apache.heron.spi.utils.NetworkUtils.TunnelConfig,org.apache.heron.spi.utils.NetworkUtils.TunnelType)">establishSSHTunnelIfNeeded</a></span>​(java.net.InetSocketAddress endpoint, |
| <a href="NetworkUtils.TunnelConfig.html" title="class in org.apache.heron.spi.utils">NetworkUtils.TunnelConfig</a> tunnelConfig, |
| <a href="NetworkUtils.TunnelType.html" title="enum in org.apache.heron.spi.utils">NetworkUtils.TunnelType</a> tunnelType)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHostName()">getHostName</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static java.net.HttpURLConnection</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHttpConnection(java.lang.String)">getHttpConnection</a></span>​(java.lang.String endpoint)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static java.net.InetSocketAddress</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInetSocketAddress(java.lang.String)">getInetSocketAddress</a></span>​(java.lang.String endpoint)</code></th> |
| <td class="colLast"> |
| <div class="block">Convert an endpoint from String (host:port) to InetSocketAddress</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static java.net.HttpURLConnection</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProxiedHttpConnectionIfNeeded(java.net.URL,org.apache.heron.spi.utils.NetworkUtils.TunnelConfig)">getProxiedHttpConnectionIfNeeded</a></span>​(java.net.URL endpoint, |
| <a href="NetworkUtils.TunnelConfig.html" title="class in org.apache.heron.spi.utils">NetworkUtils.TunnelConfig</a> tunnelConfig)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isLocationReachable(java.net.InetSocketAddress,java.time.Duration,int,java.time.Duration)">isLocationReachable</a></span>​(java.net.InetSocketAddress endpoint, |
| java.time.Duration timeout, |
| int retryCount, |
| java.time.Duration retryInterval)</code></th> |
| <td class="colLast"> |
| <div class="block">Tests if a network location is reachable.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static byte[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readHttpRequestBody(com.sun.net.httpserver.HttpExchange)">readHttpRequestBody</a></span>​(com.sun.net.httpserver.HttpExchange exchange)</code></th> |
| <td class="colLast"> |
| <div class="block">Read the request body of HTTP request from a given HttpExchange</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static byte[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readHttpResponse(java.net.HttpURLConnection)">readHttpResponse</a></span>​(java.net.HttpURLConnection connection)</code></th> |
| <td class="colLast"> |
| <div class="block">Read http response from a given http connection</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendHttpDeleteRequest(java.net.HttpURLConnection)">sendHttpDeleteRequest</a></span>​(java.net.HttpURLConnection connection)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendHttpGetRequest(java.net.HttpURLConnection)">sendHttpGetRequest</a></span>​(java.net.HttpURLConnection connection)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendHttpPostRequest(java.net.HttpURLConnection,java.lang.String,byte%5B%5D)">sendHttpPostRequest</a></span>​(java.net.HttpURLConnection connection, |
| java.lang.String contentType, |
| byte[] data)</code></th> |
| <td class="colLast"> |
| <div class="block">Send Http POST Request to a connection with given data in request body</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendHttpResponse(boolean,com.sun.net.httpserver.HttpExchange,byte%5B%5D)">sendHttpResponse</a></span>​(boolean isSuccess, |
| com.sun.net.httpserver.HttpExchange exchange, |
| byte[] response)</code></th> |
| <td class="colLast"> |
| <div class="block">Send a http response with HTTP_OK return code and response body</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendHttpResponse(com.sun.net.httpserver.HttpExchange,byte%5B%5D)">sendHttpResponse</a></span>​(com.sun.net.httpserver.HttpExchange exchange, |
| byte[] response)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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="JSON_TYPE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>JSON_TYPE</h4> |
| <pre>public static final java.lang.String JSON_TYPE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.heron.spi.utils.NetworkUtils.JSON_TYPE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="URL_ENCODE_TYPE"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>URL_ENCODE_TYPE</h4> |
| <pre>public static final java.lang.String URL_ENCODE_TYPE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.heron.spi.utils.NetworkUtils.URL_ENCODE_TYPE">Constant Field Values</a></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="readHttpRequestBody(com.sun.net.httpserver.HttpExchange)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readHttpRequestBody</h4> |
| <pre class="methodSignature">public static byte[] readHttpRequestBody​(com.sun.net.httpserver.HttpExchange exchange)</pre> |
| <div class="block">Read the request body of HTTP request from a given HttpExchange</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>exchange</code> - the HttpExchange to read from</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the byte[] in request body, or new byte[0] if failed to read</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="sendHttpResponse(boolean,com.sun.net.httpserver.HttpExchange,byte[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendHttpResponse</h4> |
| <pre class="methodSignature">public static boolean sendHttpResponse​(boolean isSuccess, |
| com.sun.net.httpserver.HttpExchange exchange, |
| byte[] response)</pre> |
| <div class="block">Send a http response with HTTP_OK return code and response body</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>isSuccess</code> - send back HTTP_OK if it is true, otherwise send back HTTP_UNAVAILABLE</dd> |
| <dd><code>exchange</code> - the HttpExchange to send response</dd> |
| <dd><code>response</code> - the response the sent back in response body</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if we send the response successfully</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="sendHttpResponse(com.sun.net.httpserver.HttpExchange,byte[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendHttpResponse</h4> |
| <pre class="methodSignature">public static boolean sendHttpResponse​(com.sun.net.httpserver.HttpExchange exchange, |
| byte[] response)</pre> |
| </li> |
| </ul> |
| <a id="sendHttpPostRequest(java.net.HttpURLConnection,java.lang.String,byte[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendHttpPostRequest</h4> |
| <pre class="methodSignature">public static boolean sendHttpPostRequest​(java.net.HttpURLConnection connection, |
| java.lang.String contentType, |
| byte[] data)</pre> |
| <div class="block">Send Http POST Request to a connection with given data in request body</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>connection</code> - the connection to send post request to</dd> |
| <dd><code>contentType</code> - the type of the content to be sent</dd> |
| <dd><code>data</code> - the data to send in post request body</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if success</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="sendHttpGetRequest(java.net.HttpURLConnection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendHttpGetRequest</h4> |
| <pre class="methodSignature">public static boolean sendHttpGetRequest​(java.net.HttpURLConnection connection)</pre> |
| </li> |
| </ul> |
| <a id="sendHttpDeleteRequest(java.net.HttpURLConnection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendHttpDeleteRequest</h4> |
| <pre class="methodSignature">public static boolean sendHttpDeleteRequest​(java.net.HttpURLConnection connection)</pre> |
| </li> |
| </ul> |
| <a id="readHttpResponse(java.net.HttpURLConnection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readHttpResponse</h4> |
| <pre class="methodSignature">public static byte[] readHttpResponse​(java.net.HttpURLConnection connection)</pre> |
| <div class="block">Read http response from a given http connection</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>connection</code> - the connection to read response</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the byte[] in response body, or new byte[0] if failed to read</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getHttpConnection(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHttpConnection</h4> |
| <pre class="methodSignature">public static java.net.HttpURLConnection getHttpConnection​(java.lang.String endpoint)</pre> |
| </li> |
| </ul> |
| <a id="getProxiedHttpConnectionIfNeeded(java.net.URL,org.apache.heron.spi.utils.NetworkUtils.TunnelConfig)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProxiedHttpConnectionIfNeeded</h4> |
| <pre class="methodSignature">public static java.net.HttpURLConnection getProxiedHttpConnectionIfNeeded​(java.net.URL endpoint, |
| <a href="NetworkUtils.TunnelConfig.html" title="class in org.apache.heron.spi.utils">NetworkUtils.TunnelConfig</a> tunnelConfig)</pre> |
| </li> |
| </ul> |
| <a id="checkHttpResponseCode(java.net.HttpURLConnection,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkHttpResponseCode</h4> |
| <pre class="methodSignature">public static boolean checkHttpResponseCode​(java.net.HttpURLConnection connection, |
| int expectedCode)</pre> |
| </li> |
| </ul> |
| <a id="getHostName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHostName</h4> |
| <pre class="methodSignature">public static java.lang.String getHostName()</pre> |
| </li> |
| </ul> |
| <a id="isLocationReachable(java.net.InetSocketAddress,java.time.Duration,int,java.time.Duration)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isLocationReachable</h4> |
| <pre class="methodSignature">public static boolean isLocationReachable​(java.net.InetSocketAddress endpoint, |
| java.time.Duration timeout, |
| int retryCount, |
| java.time.Duration retryInterval)</pre> |
| <div class="block">Tests if a network location is reachable. This is best effort and may give false |
| not reachable.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>endpoint</code> - the endpoint to connect to</dd> |
| <dd><code>timeout</code> - Open connection will wait for this timeout.</dd> |
| <dd><code>retryCount</code> - In case of connection timeout try retryCount times.</dd> |
| <dd><code>retryInterval</code> - the interval to retryCount</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the network location is reachable</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="establishSSHTunnelIfNeeded(java.net.InetSocketAddress,org.apache.heron.spi.utils.NetworkUtils.TunnelConfig,org.apache.heron.spi.utils.NetworkUtils.TunnelType)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>establishSSHTunnelIfNeeded</h4> |
| <pre class="methodSignature">public static <a href="../../common/basics/Pair.html" title="class in org.apache.heron.common.basics">Pair</a><java.net.InetSocketAddress,​java.lang.Process> establishSSHTunnelIfNeeded​(java.net.InetSocketAddress endpoint, |
| <a href="NetworkUtils.TunnelConfig.html" title="class in org.apache.heron.spi.utils">NetworkUtils.TunnelConfig</a> tunnelConfig, |
| <a href="NetworkUtils.TunnelType.html" title="enum in org.apache.heron.spi.utils">NetworkUtils.TunnelType</a> tunnelType)</pre> |
| </li> |
| </ul> |
| <a id="getInetSocketAddress(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getInetSocketAddress</h4> |
| <pre class="methodSignature">public static java.net.InetSocketAddress getInetSocketAddress​(java.lang.String endpoint)</pre> |
| <div class="block">Convert an endpoint from String (host:port) to InetSocketAddress</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>endpoint</code> - a String in (host:port) format</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an InetSocketAddress representing the endpoint</dd> |
| </dl> |
| </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 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </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> |
