serguei.http

Class HttpClientConnection

java.lang.Object

serguei.http.HttpClientConnection

All Implemented Interfaces:

Closeable, AutoCloseable

public class HttpClientConnection
extends Object
implements Closeable

HTTP client connection - a simple HTTP client

Author:

Serguei Poliakov

Constructor Summary

Constructors

Constructor and Description
HttpClientConnection(InetSocketAddress address) Create an instance of HttpClientConnection.
HttpClientConnection(String host, int port) Create an instance of HttpClientConnection.

Method Summary

Modifier and Type	Method and Description
void	close() Close the connection to the server
void	connect() Connects to the server.
String	getNegotiatedCipher()
TlsVersion	getNegotiatedTlsProtocol()
int	getSocketSourcePort()
X509Certificate[]	getTlsCertificates()
byte[]	getTlsSessionId()
void	reset() Reset the connection to the server
HttpResponse	send(byte[] data) This sends data to the server and waits for a response.
HttpResponse	send(HttpRequestHeaders requestHeaders) This sends a request without body and waits for a response.
HttpResponse	send(HttpRequestHeaders requestHeaders, byte[] body) This sends a request with a body and waits for a response.
HttpResponse	send(HttpRequestHeaders requestHeaders, byte[] body, BodyCompression compression) This sends a request with a body and waits for a response.
HttpResponse	send(HttpRequestHeaders requestHeaders, InputStream body) This sends a request with a body and waits for a response.
HttpResponse	send(HttpRequestHeaders requestHeaders, InputStream body, BodyCompression compression) This sends a request with a body and waits for a response.
HttpResponse	send(HttpRequestHeaders requestHeaders, String body) This sends a request with a body and waits for a response.
HttpResponse	send(HttpRequestHeaders requestHeaders, String body, BodyCompression compression) This sends a request with a body and waits for a response.
void	sendConnectRequest(String host) This will send a CONNECT request and wait for a response, expecting to receive 200 OK.
HttpResponse	sendRequest(String requestLine, String... headers) This sends a request without body and waits for response.
void	setCipherSuites(String... enabledCipherSuites)
void	setTcpNoDelay(boolean tcpNoDelay) Switch TCP_NODELAY When it is TCP_NODELAY is on, Nagle's algorithm is switched off
void	setTimeoutMillis(int timeout) Sets timeout for IO operations on socket
void	setTlsProtocol(TlsVersion... enabledTlsProtocols)
void	startHandshake() Start TLS connection without validating certificates received from the server.
void	startHandshake(String hostName) Start TLS connection without validating certificates received from the server sending specified host name as part of ClientHello.
void	startHandshakeAndValidate() Start TLS connection validating certificates received from the server using default trust manager.
void	startHandshakeAndValidate(String hostName) Start TLS connection validating certificates received from the server using default trust manager.
void	startHandshakeWithClientAuth(String hostName, String keyStorePath, String keyStorePassword, String certificatePassword) Start TLS connection without validating certificates received from the server sending specified host name as part of ClientHello and a certificate for client validation.
void	startHandshakeWithClientAuthAndValidate(String hostName, String keyStorePath, String keyStorePassword, String certificatePassword) Start TLS connection validating certificates received from the server sending specified host name as part of ClientHello and a certificate for client validation.
void	useJdkDefaultCipherSuites()
void	useJdkDefaultTlsProtocols()

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpClientConnection

public HttpClientConnection(String host,
                            int port)

Create an instance of HttpClientConnection. We don't connect to the server yet at this point.

Parameters:

host - - host name (could be a string contains an IP address), if we are connecting via a proxy, this should be proxy hostname/IP

port - - port (e.g. 80 for HTTP or 443 for HTTPS)

HttpClientConnection

public HttpClientConnection(InetSocketAddress address)

Create an instance of HttpClientConnection. We don't connect to the server yet at this point.

Parameters:

address - - IP socket address to the server we will be connecting. If we connecting via a proxy, this should be an address of the proxy.

Method Detail

sendRequest

public HttpResponse sendRequest(String requestLine,
                                String... headers)
                         throws IOException

This sends a request without body and waits for response. It will create a connection if necessary.

Parameters:

requestLine - - request line of the request (e.g. "GET /path HTTP/1.1")

headers - - headers (e.g. "Accept-Encoding: gzip")

Returns:

a response the server sends after receiving the request

Throws:

IOException

send

public HttpResponse send(HttpRequestHeaders requestHeaders)
                  throws IOException

This sends a request without body and waits for a response. It will create a connection if necessary.

Parameters:

requestHeaders - - request headers that will be sent to the server

Returns:

a response the server sends after receiving the request

Throws:

IOException

send

public HttpResponse send(HttpRequestHeaders requestHeaders,
                         String body)
                  throws IOException

This sends a request with a body and waits for a response. It will create a connection if necessary. This adds a "Content-Length" header based on the length of the body (different from body.length()) to requestHeaders before sending them.

Parameters:

requestHeaders - - request headers that will be sent to the server

body - - a body of the request

Returns:

a response the server sends after receiving the request

Throws:

IOException

send

public HttpResponse send(HttpRequestHeaders requestHeaders,
                         String body,
                         BodyCompression compression)
                  throws IOException

This sends a request with a body and waits for a response. It will create a connection if necessary. This adds "Content-Length" header based on the length of the body (different from body.length()) and "Content-Encoding" if compression is specified to requestHeaders before sending request.

Parameters:

requestHeaders - - request headers that will be sent to the server

body - - a body of the request

compression - - specifies if body needs to be compressed

Returns:

a response the server sends after receiving the request

Throws:

IOException

send

public HttpResponse send(HttpRequestHeaders requestHeaders,
                         byte[] body)
                  throws IOException

This sends a request with a body and waits for a response. It will create a connection if necessary. This adds a "Content-Length" header based on the length of the body to requestHeaders before sending headers.

Parameters:

requestHeaders - - request headers that will be sent to the server

body - - a body of the request

Returns:

a response the server sends after receiving the request

Throws:

IOException

send

public HttpResponse send(HttpRequestHeaders requestHeaders,
                         byte[] body,
                         BodyCompression compression)
                  throws IOException

This sends a request with a body and waits for a response. It will create a connection if necessary. This adds "Content-Length" header based on the length of the body (it might different from body.length if body is compressed) and "Content-Encoding" if compression is specified to requestHeaders before sending request.

Parameters:

requestHeaders - - request headers that will be sent to the server

body - - a body of the request

compression - - specifies if body needs to be compressed

Returns:

a response the server sends after receiving the request

Throws:

IOException

send

public HttpResponse send(HttpRequestHeaders requestHeaders,
                         InputStream body)
                  throws IOException

This sends a request with a body and waits for a response. It will create a connection if necessary. This will send body using chunked transfer encoding. This adds "Transfer-Encoding: chunked" header to requestHeaders before sending the request.

Parameters:

requestHeaders - - request headers that will be sent to the server

body - - an input stream from where to read data for the request body (the data is read until end of stream encountered)

Returns:

a response the server sends after receiving the request

Throws:

IOException

send

public HttpResponse send(HttpRequestHeaders requestHeaders,
                         InputStream body,
                         BodyCompression compression)
                  throws IOException

This sends a request with a body and waits for a response. It will create a connection if necessary. This will send body using chunked transfer encoding. This adds "Transfer-Encoding: chunked" header and, if compression is specified, "Content-Encoding" header to requestHeaders before sending the request.

Parameters:

requestHeaders - - request headers that will be sent to the server

body - - an input stream from where to read data for the request body (the data is read until end of stream encountered)

compression - - specifies if body needs to be compressed

Returns:

a response the server sends after receiving the request

Throws:

IOException

send

public HttpResponse send(byte[] data)
                  throws IOException

This sends data to the server and waits for a response. It will create a connection if necessary.

Parameters:

data - - data to be sent to the server as-is

Returns:

a response the server sends after receiving the request

Throws:

IOException

sendConnectRequest

public void sendConnectRequest(String host)
                        throws IOException

This will send a CONNECT request and wait for a response, expecting to receive 200 OK. A connection will be created if required. This is usually used to make a TLS connection via HTTP proxy.

Parameters:

host - - host name to be used in the request

Throws:

IOException - - when IO failed or the proxy returned a result different from 200.

startHandshake

public void startHandshake()
                    throws IOException

Start TLS connection without validating certificates received from the server. A connection will be created if required. If we specified unresolved host name when instantiating this instance, it will send it as SNI in ClientHello.

Throws:

IOException

startHandshake

public void startHandshake(String hostName)
                    throws IOException

Start TLS connection without validating certificates received from the server sending specified host name as part of ClientHello. A connection will be created if required.

Parameters:

hostName - - host name to be sent in SNI in ClientHello. This is needed for the server to choose a correct certificate, if null - do not set SNI

Throws:

IOException

startHandshakeWithClientAuth

public void startHandshakeWithClientAuth(String hostName,
                                         String keyStorePath,
                                         String keyStorePassword,
                                         String certificatePassword)
                                  throws IOException

Start TLS connection without validating certificates received from the server sending specified host name as part of ClientHello and a certificate for client validation. A connection will be created if required.

Parameters:

hostName - - host name to be sent in SNI in ClientHello. This is needed for the server to choose a correct certificate, if null - do not set SNI

keyStorePath - - path to Java keystore file (JKS file)

keyStorePassword - - password for Java keystore file

certificatePassword - - password for certificates in Java keystore

Throws:

IOException

startHandshakeAndValidate

public void startHandshakeAndValidate()
                               throws IOException

Start TLS connection validating certificates received from the server using default trust manager. A connection will be created if required. If we specified unresolved host name when instantiating this instance, it will send it as SNI in ClientHello.

Throws:

IOException

startHandshakeAndValidate

public void startHandshakeAndValidate(String hostName)
                               throws IOException

Start TLS connection validating certificates received from the server using default trust manager. A connection will be created if required.

Parameters:

hostName - - host name to be sent in SNI in ClientHello. This is needed for the server to choose a correct certificate.

Throws:

IOException

startHandshakeWithClientAuthAndValidate

public void startHandshakeWithClientAuthAndValidate(String hostName,
                                                    String keyStorePath,
                                                    String keyStorePassword,
                                                    String certificatePassword)
                                             throws IOException

Start TLS connection validating certificates received from the server sending specified host name as part of ClientHello and a certificate for client validation. A connection will be created if required.

Parameters:

hostName - - host name to be sent in SNI in ClientHello. This is needed for the server to choose a correct certificate, if null - do not set SNI

keyStorePath - - path to Java keystore file (JKS file)

keyStorePassword - - password for Java keystore file

certificatePassword - - password for certificates in Java keystore

Throws:

IOException

close

public void close()

Close the connection to the server

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

reset

public void reset()

Reset the connection to the server

getTlsCertificates

public X509Certificate[] getTlsCertificates()

Returns:

Certificates received from the server during TLS handshake or null if no TLS connection was established.

getNegotiatedTlsProtocol

public TlsVersion getNegotiatedTlsProtocol()

Returns:

A TLS protocol negotiated during TLS handshake or null if TLS handshake did not happen

getNegotiatedCipher

public String getNegotiatedCipher()

Returns:

A TLS cipher negotiated during TLS handshake or null if TLS handshake did not happen

getTlsSessionId

public byte[] getTlsSessionId()

Returns:

A TLS session id if the server supports session resumption (null if not TLS connection)

setTlsProtocol

public void setTlsProtocol(TlsVersion... enabledTlsProtocols)

Parameters:

enabledTlsProtocols - - list of allowed TLS protocols

useJdkDefaultTlsProtocols

public void useJdkDefaultTlsProtocols()

setCipherSuites

public void setCipherSuites(String... enabledCipherSuites)

Parameters:

enabledCipherSuites - - list of allowed Cipher Suites

useJdkDefaultCipherSuites

public void useJdkDefaultCipherSuites()

getSocketSourcePort

public int getSocketSourcePort()

Returns:

the local port number or -1 if connection was not established

connect

public void connect()
             throws IOException

Connects to the server. Usually one does not need to call it as it will be called automatically when required.

Throws:

IOException

setTimeoutMillis

public void setTimeoutMillis(int timeout)
                      throws SocketException

Sets timeout for IO operations on socket

Parameters:

timeout - - timeout in milliseconds

Throws:

SocketException - - when there is an error in TCP protocol

setTcpNoDelay

public void setTcpNoDelay(boolean tcpNoDelay)
                   throws SocketException

Switch TCP_NODELAY When it is TCP_NODELAY is on, Nagle's algorithm is switched off

Parameters:

tcpNoDelay - - when true then Nagle's algorithm is off (default)

Throws:

SocketException