com.twitter.heron.spi.utils

Class NetworkUtils

java.lang.Object

com.twitter.heron.spi.utils.NetworkUtils

public final class NetworkUtils
extends java.lang.Object

Utilities related to network.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NetworkUtils.HeronSystem
static class	NetworkUtils.TunnelConfig
static class	NetworkUtils.TunnelType

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	JSON_TYPE
static java.lang.String	URL_ENCODE_TYPE

Method Summary

Modifier and Type	Method and Description
static boolean	checkHttpResponseCode(java.net.HttpURLConnection connection, int expectedCode)
static Pair<java.net.InetSocketAddress,java.lang.Process>	establishSSHTunnelIfNeeded(java.net.InetSocketAddress endpoint, NetworkUtils.TunnelConfig tunnelConfig, NetworkUtils.TunnelType tunnelType)
static java.lang.String	getHostName()
static java.net.HttpURLConnection	getHttpConnection(java.lang.String endpoint)
static java.net.InetSocketAddress	getInetSocketAddress(java.lang.String endpoint) Convert an endpoint from String (host:port) to InetSocketAddress
static java.net.HttpURLConnection	getProxiedHttpConnectionIfNeeded(java.net.URL endpoint, NetworkUtils.TunnelConfig tunnelConfig)
static boolean	isLocationReachable(java.net.InetSocketAddress endpoint, int timeoutMs, int retryCount, int retryIntervalMs) Tests if a network location is reachable.
static byte[]	readHttpRequestBody(com.sun.net.httpserver.HttpExchange exchange) Read the request body of HTTP request from a given HttpExchange
static byte[]	readHttpResponse(java.net.HttpURLConnection connection) Read http response from a given http connection
static boolean	sendHttpDeleteRequest(java.net.HttpURLConnection connection)
static boolean	sendHttpGetRequest(java.net.HttpURLConnection connection)
static boolean	sendHttpPostRequest(java.net.HttpURLConnection connection, java.lang.String contentType, byte[] data) Send Http POST Request to a connection with given data in request body
static boolean	sendHttpResponse(boolean isSuccess, com.sun.net.httpserver.HttpExchange exchange, byte[] response) Send a http response with HTTP_OK return code and response body
static boolean	sendHttpResponse(com.sun.net.httpserver.HttpExchange exchange, byte[] response)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

JSON_TYPE

public static final java.lang.String JSON_TYPE

See Also:

Constant Field Values

URL_ENCODE_TYPE

public static final java.lang.String URL_ENCODE_TYPE

See Also:

Constant Field Values

Method Detail

readHttpRequestBody

public static byte[] readHttpRequestBody(com.sun.net.httpserver.HttpExchange exchange)

Read the request body of HTTP request from a given HttpExchange

Parameters:

exchange - the HttpExchange to read from

Returns:

the byte[] in request body, or new byte[0] if failed to read

sendHttpResponse

public static boolean sendHttpResponse(boolean isSuccess,
                                       com.sun.net.httpserver.HttpExchange exchange,
                                       byte[] response)

Send a http response with HTTP_OK return code and response body

Parameters:

isSuccess - send back HTTP_OK if it is true, otherwise send back HTTP_UNAVAILABLE

exchange - the HttpExchange to send response

response - the response the sent back in response body

Returns:

true if we send the response successfully

sendHttpResponse

public static boolean sendHttpResponse(com.sun.net.httpserver.HttpExchange exchange,
                                       byte[] response)

sendHttpPostRequest

public static boolean sendHttpPostRequest(java.net.HttpURLConnection connection,
                                          java.lang.String contentType,
                                          byte[] data)

Send Http POST Request to a connection with given data in request body

Parameters:

connection - the connection to send post request to

contentType - the type of the content to be sent

data - the data to send in post request body

Returns:

true if success

sendHttpGetRequest

public static boolean sendHttpGetRequest(java.net.HttpURLConnection connection)

sendHttpDeleteRequest

public static boolean sendHttpDeleteRequest(java.net.HttpURLConnection connection)

readHttpResponse

public static byte[] readHttpResponse(java.net.HttpURLConnection connection)

Read http response from a given http connection

Parameters:

connection - the connection to read response

Returns:

the byte[] in response body, or new byte[0] if failed to read

getHttpConnection

public static java.net.HttpURLConnection getHttpConnection(java.lang.String endpoint)

getProxiedHttpConnectionIfNeeded

public static java.net.HttpURLConnection getProxiedHttpConnectionIfNeeded(java.net.URL endpoint,
                                                                          NetworkUtils.TunnelConfig tunnelConfig)

checkHttpResponseCode

public static boolean checkHttpResponseCode(java.net.HttpURLConnection connection,
                                            int expectedCode)

getHostName

public static java.lang.String getHostName()

isLocationReachable

public static boolean isLocationReachable(java.net.InetSocketAddress endpoint,
                                          int timeoutMs,
                                          int retryCount,
                                          int retryIntervalMs)

Tests if a network location is reachable. This is best effort and may give false not reachable.

Parameters:

endpoint - the endpoint to connect to

timeoutMs - Open connection will wait for this timeoutMs in ms.

retryCount - In case of connection timeoutMs try retryCount times.

retryIntervalMs - the interval in ms to retryCount

Returns:

true if the network location is reachable

establishSSHTunnelIfNeeded

public static Pair<java.net.InetSocketAddress,java.lang.Process> establishSSHTunnelIfNeeded(java.net.InetSocketAddress endpoint,
                                                                                            NetworkUtils.TunnelConfig tunnelConfig,
                                                                                            NetworkUtils.TunnelType tunnelType)

getInetSocketAddress

public static java.net.InetSocketAddress getInetSocketAddress(java.lang.String endpoint)

Convert an endpoint from String (host:port) to InetSocketAddress

Parameters:

endpoint - a String in (host:port) format

Returns:

an InetSocketAddress representing the endpoint