io.higgs.http.client

Class HttpRequestBuilder

java.lang.Object

io.higgs.http.client.HttpRequestBuilder

public class HttpRequestBuilder
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected String	acceptedEncodings
protected String	acceptedLanguages
protected String	acceptedMimeTypes
protected String	charSet
protected String	connectionHeader
protected static String	proxyHost
protected static String	proxyPassword
protected static int	proxyPort
protected static String	proxyUsername
protected Set<Integer>	redirectStatusCodes
protected String	userAgent

Constructor Summary

Constructors

Constructor and Description
HttpRequestBuilder()
HttpRequestBuilder(HttpRequestBuilder that)

Method Summary

Methods

Modifier and Type	Method and Description
HttpRequestBuilder	acceptedLanguages(String acceptedLanguages)
HttpRequestBuilder	acceptedMimeTypes(String acceptedMimeTypes)
HttpRequestBuilder	charSet(String charSet)
Request	CONNECT(URI uri, io.netty.handler.codec.http.HttpVersion version, Reader reader)
Request	CONNECT(URI uri, Reader reader) See Reader for handling incoming data and the default implementations PageReader which reads an entire page LineReader which reads a response line by line or FileReader which reads a response and saves it to a file
HttpRequestBuilder	connection(String connectionHeader)
HttpRequestBuilder	copy() Create a new instance of HttpRequestBuilder copying all the settings from this instance to the new one
Request	DELETE(URI uri, io.netty.handler.codec.http.HttpVersion version, Reader reader)
Request	DELETE(URI uri, Reader reader) See Reader for handling incoming data and the default implementations PageReader which reads an entire page LineReader which reads a response line by line or FileReader which reads a response and saves it to a file
Request	GET(URI uri, io.netty.handler.codec.http.HttpVersion version, Reader reader)
Request	GET(URI uri, Reader reader) See Reader for handling incoming data and the default implementations PageReader which reads an entire page LineReader which reads a response line by line or FileReader which reads a response and saves it to a file
static String[]	getSupportedSSLProtocols() Gets the list of SSL protocols supported by the current JVM
static io.netty.channel.EventLoopGroup	group()
Request	HEAD(URI uri, io.netty.handler.codec.http.HttpVersion version, Reader reader)
Request	HEAD(URI uri, Reader reader) See Reader for handling incoming data and the default implementations PageReader which reads an entire page LineReader which reads a response line by line or FileReader which reads a response and saves it to a file
static HttpRequestBuilder	instance()
static boolean	isSupportedSSLProtocol(String protocol) Checks if the given SSL protocol is supported by the current JVM
Request	OPTIONS(URI uri, io.netty.handler.codec.http.HttpVersion version, Reader reader)
Request	OPTIONS(URI uri, Reader reader) See Reader for handling incoming data and the default implementations PageReader which reads an entire page LineReader which reads a response line by line or FileReader which reads a response and saves it to a file
Request	PATCH(URI uri, io.netty.handler.codec.http.HttpVersion version, Reader reader)
Request	PATCH(URI uri, Reader reader) See Reader for handling incoming data and the default implementations PageReader which reads an entire page LineReader which reads a response line by line or FileReader which reads a response and saves it to a file
POST	POST(URI uri, io.netty.handler.codec.http.HttpVersion version, Reader reader)
POST	POST(URI uri, Reader reader) See Reader for handling incoming data and the default implementations PageReader which reads an entire page LineReader which reads a response line by line or FileReader which reads a response and saves it to a file
JSONRequest	postJSON(URI uri, io.netty.handler.codec.http.HttpVersion version, Reader reader)
JSONRequest	postJSON(URI uri, Reader reader) See Reader for handling incoming data and the default implementations PageReader which reads an entire page LineReader which reads a response line by line or FileReader which reads a response and saves it to a file
HttpRequestBuilder	proxy(String host, int port)
HttpRequestBuilder	proxy(String host, int port, String username, String password) Sets proxy information what will be used to make all requests made using the client i.e.
JSONRequest	putJSON(URI uri, io.netty.handler.codec.http.HttpVersion version, Reader reader)
JSONRequest	putJSON(URI uri, Reader reader)
Set<Integer>	redirectOn()
HttpRequestBuilder	redirectOn(int... codes) Automatically follow redirect responses for the given status codes
static void	restart()
static void	shutdown()
HTTPStreamingRequest	streamJSON(URI uri, Reader reader)
Request	TRACE(URI uri, io.netty.handler.codec.http.HttpVersion version, Reader reader)
Request	TRACE(URI uri, Reader reader) See Reader for handling incoming data and the default implementations PageReader which reads an entire page LineReader which reads a response line by line or FileReader which reads a response and saves it to a file
HttpRequestBuilder	userAgent(String userAgent)

Methods inherited from class java.lang.Object

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

Field Detail

proxyHost

protected static String proxyHost

proxyUsername

protected static String proxyUsername

proxyPassword

protected static String proxyPassword

proxyPort

protected static int proxyPort

userAgent

protected String userAgent

charSet

protected String charSet

acceptedLanguages

protected String acceptedLanguages

acceptedMimeTypes

protected String acceptedMimeTypes

redirectStatusCodes

protected Set<Integer> redirectStatusCodes

acceptedEncodings

protected String acceptedEncodings

connectionHeader

protected String connectionHeader

Constructor Detail

HttpRequestBuilder

public HttpRequestBuilder(HttpRequestBuilder that)

HttpRequestBuilder

public HttpRequestBuilder()

Method Detail

instance

public static HttpRequestBuilder instance()

Returns:

use a static instance of the request builder

group

public static io.netty.channel.EventLoopGroup group()

restart

public static void restart()

shutdown

public static void shutdown()

isSupportedSSLProtocol

public static boolean isSupportedSSLProtocol(String protocol)

Checks if the given SSL protocol is supported by the current JVM

Parameters:

protocol - e.g. SSLv2Hello, SSLv3, TLSv1, TLSv1.1, TLSv1.2

Returns:

true if supported, false otherwise

Throws:

IllegalArgumentException - if the given protocol is null or empty

getSupportedSSLProtocols

public static String[] getSupportedSSLProtocols()

Gets the list of SSL protocols supported by the current JVM

Returns:

e.g. [SSLv2Hello, SSLv3, TLSv1, TLSv1.1, TLSv1.2]

proxy

public HttpRequestBuilder proxy(String host,
                       int port)

proxy

public HttpRequestBuilder proxy(String host,
                       int port,
                       String username,
                       String password)

Sets proxy information what will be used to make all requests made using the client i.e. this only needs to be set once and it will apply to all requests made after

Parameters:

host - the proxy host

port - the proxy port

username - username for the proxy

password - password for the proxy

Returns:

this

redirectOn

public HttpRequestBuilder redirectOn(int... codes)

Automatically follow redirect responses for the given status codes

Parameters:

codes - the status codes to treat as redirects

Returns:

this

redirectOn

public Set<Integer> redirectOn()

GET

public Request GET(URI uri,
          Reader reader)

See Reader for handling incoming data and the default implementations PageReader which reads an entire page LineReader which reads a response line by line or FileReader which reads a response and saves it to a file

Parameters:

uri - the URI to make the request to

reader - the reader to use to process the response

Returns:

the request

GET

public Request GET(URI uri,
          io.netty.handler.codec.http.HttpVersion version,
          Reader reader)

POST

public POST POST(URI uri,
        Reader reader)

See Reader for handling incoming data and the default implementations PageReader which reads an entire page LineReader which reads a response line by line or FileReader which reads a response and saves it to a file

Parameters:

uri - the URI to make the request to

reader - the reader to use to process the response

Returns:

the request

POST

public POST POST(URI uri,
        io.netty.handler.codec.http.HttpVersion version,
        Reader reader)

streamJSON

public HTTPStreamingRequest streamJSON(URI uri,
                              Reader reader)

postJSON

public JSONRequest postJSON(URI uri,
                   Reader reader)

See Reader for handling incoming data and the default implementations PageReader which reads an entire page LineReader which reads a response line by line or FileReader which reads a response and saves it to a file

Parameters:

uri - the URI to make the request to

reader - the reader to use to process the response

Returns:

the request

postJSON

public JSONRequest postJSON(URI uri,
                   io.netty.handler.codec.http.HttpVersion version,
                   Reader reader)

putJSON

public JSONRequest putJSON(URI uri,
                  Reader reader)

putJSON

public JSONRequest putJSON(URI uri,
                  io.netty.handler.codec.http.HttpVersion version,
                  Reader reader)

DELETE

public Request DELETE(URI uri,
             Reader reader)

See Reader for handling incoming data and the default implementations PageReader which reads an entire page LineReader which reads a response line by line or FileReader which reads a response and saves it to a file

Parameters:

uri - the URI to make the request to

reader - the reader to use to process the response

Returns:

the request

DELETE

public Request DELETE(URI uri,
             io.netty.handler.codec.http.HttpVersion version,
             Reader reader)

OPTIONS

public Request OPTIONS(URI uri,
              Reader reader)

See Reader for handling incoming data and the default implementations PageReader which reads an entire page LineReader which reads a response line by line or FileReader which reads a response and saves it to a file

Parameters:

uri - the URI to make the request to

reader - the reader to use to process the response

Returns:

the request

OPTIONS

public Request OPTIONS(URI uri,
              io.netty.handler.codec.http.HttpVersion version,
              Reader reader)

HEAD

public Request HEAD(URI uri,
           Reader reader)

See Reader for handling incoming data and the default implementations PageReader which reads an entire page LineReader which reads a response line by line or FileReader which reads a response and saves it to a file

Parameters:

uri - the URI to make the request to

reader - the reader to use to process the response

Returns:

the request

HEAD

public Request HEAD(URI uri,
           io.netty.handler.codec.http.HttpVersion version,
           Reader reader)

TRACE

public Request TRACE(URI uri,
            Reader reader)

See Reader for handling incoming data and the default implementations PageReader which reads an entire page LineReader which reads a response line by line or FileReader which reads a response and saves it to a file

Parameters:

uri - the URI to make the request to

reader - the reader to use to process the response

Returns:

the request

TRACE

public Request TRACE(URI uri,
            io.netty.handler.codec.http.HttpVersion version,
            Reader reader)

PATCH

public Request PATCH(URI uri,
            Reader reader)

See Reader for handling incoming data and the default implementations PageReader which reads an entire page LineReader which reads a response line by line or FileReader which reads a response and saves it to a file

Parameters:

uri - the URI to make the request to

reader - the reader to use to process the response

Returns:

the request

PATCH

public Request PATCH(URI uri,
            io.netty.handler.codec.http.HttpVersion version,
            Reader reader)

CONNECT

public Request CONNECT(URI uri,
              Reader reader)

See Reader for handling incoming data and the default implementations PageReader which reads an entire page LineReader which reads a response line by line or FileReader which reads a response and saves it to a file

Parameters:

uri - the URI to make the request to

reader - the reader to use to process the response

Returns:

the request

CONNECT

public Request CONNECT(URI uri,
              io.netty.handler.codec.http.HttpVersion version,
              Reader reader)

acceptedLanguages

public HttpRequestBuilder acceptedLanguages(String acceptedLanguages)

acceptedMimeTypes

public HttpRequestBuilder acceptedMimeTypes(String acceptedMimeTypes)

charSet

public HttpRequestBuilder charSet(String charSet)

userAgent

public HttpRequestBuilder userAgent(String userAgent)

connection

public HttpRequestBuilder connection(String connectionHeader)

Parameters:

connectionHeader - the connection header to use on requests. by default = CLOSE

copy

public HttpRequestBuilder copy()

Create a new instance of HttpRequestBuilder copying all the settings from this instance to the new one

Returns:

a new instance with the settings copied