io.higgs.http.client

Class Request<T extends Request<T>>

java.lang.Object

io.higgs.http.client.Request<T>

Direct Known Subclasses:

HTTPStreamingRequest, JSONRequest, POST

public class Request<T extends Request<T>>
extends Object

Author:

Courtney Robinson

Field Summary

Fields

Modifier and Type	Field and Description
protected T	_this
protected io.netty.channel.Channel	channel
protected Function1<io.netty.bootstrap.Bootstrap>	conf
protected io.netty.channel.ChannelFuture	connectFuture
protected io.netty.buffer.ByteBuf	contents
protected List<io.netty.handler.codec.http.Cookie>	cookies
protected FutureResponse	future
protected io.netty.channel.EventLoopGroup	group
protected io.netty.handler.codec.http.HttpMethod	method
protected URI	originalUri
protected RetryPolicy	policy
protected String	proxyHost
protected String	proxyPass
protected int	proxyPort
protected io.netty.handler.codec.http.DefaultFullHttpRequest	proxyRequest
protected String	proxyUser
protected Map<String,Object>	queryParams
protected Set<Integer>	redirectStatusCodes
protected io.netty.handler.codec.http.HttpRequest	request
protected Response	response
protected String[]	sslProtocols
protected boolean	tunneling
protected URI	uri
protected String	userAgent
protected boolean	useSSL
static Charset	UTF8
protected io.netty.handler.codec.http.HttpVersion	version

Constructor Summary

Constructors

Constructor and Description
Request(HttpRequestBuilder builder, io.netty.channel.EventLoopGroup group, URI uri, io.netty.handler.codec.http.HttpMethod method, io.netty.handler.codec.http.HttpVersion version, Reader responseReader)

Method Summary

Methods

Modifier and Type	Method and Description
void	baseDirectory(String baseDir)
protected void	configure()
protected void	configureProxy(boolean ssl)
protected io.netty.channel.ChannelFuture	connect(String host, int port, io.netty.bootstrap.Bootstrap bootstrap)
T	cookie(io.netty.handler.codec.http.Cookie cookie) Adds a cookie to this request
T	cookie(String name, Object value) Adds a cookie with the given name and value
List<io.netty.handler.codec.http.Cookie>	cookies()
void	deleteTempFileOnExit(boolean delete)
FutureResponse	execute()
FutureResponse	execute(Function1<io.netty.bootstrap.Bootstrap> conf) Makes the request to the server
io.netty.channel.Channel	getChannel()
protected String	getHost()
protected int	getPort(String scheme)
protected String	getProxyPath()
protected String	getScheme()
T	header(String name, Iterable<?> value) Set a header on this request
T	header(String name, Object value) Set a header on this request
T	header(String name, String value) Set a header on this request
io.netty.handler.codec.http.HttpHeaders	headers()
boolean	isProxyEnabled() Uses the proxy host to determine if proxy is enabled for this request.
protected boolean	isSSLScheme(String scheme)
protected io.netty.channel.ChannelFuture	makeTheRequest()
io.netty.handler.codec.http.HttpRequest	nettyRequest()
protected io.netty.channel.SimpleChannelInboundHandler<Object>	newHandler()
protected io.netty.channel.ChannelHandler	newInitializer()
protected void	newNettyRequest(URI uri, io.netty.handler.codec.http.HttpMethod method, io.netty.handler.codec.http.HttpVersion version)
URI	originalUri()
T	policy(RetryPolicy policy) Set the retry policy that will be used to retry a request if it fails.
T	proxy(String host, int port)
T	proxy(String host, int port, String username, String password) Sets proxy information what will be used to make the request These proxy settings apply only to this request, not any other made after
T	query(String name, Object value) Adds a query string parameter to the request
Set<Integer>	redirectOn()
T	redirectOn(int... codes) Automatically follow redirect responses for the given status codes
Response	response()
void	retry()
Set<Integer>	retryOn()
T	retryOn(int... statusCodes) Automatically retry the connection using the configured retry policy
protected void	retryOrFail(Throwable cause, boolean connectFailure)
void	shutdown()
URI	url()
T	url(String url)
T	userAgent(String agent)
T	withSSLProtocols(String[] protocols)

Methods inherited from class java.lang.Object

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

Field Detail

UTF8

public static final Charset UTF8

response

protected final Response response

queryParams

protected final Map<String,Object> queryParams

future

protected final FutureResponse future

group

protected final io.netty.channel.EventLoopGroup group

method

protected final io.netty.handler.codec.http.HttpMethod method

request

protected io.netty.handler.codec.http.HttpRequest request

uri

protected URI uri

channel

protected io.netty.channel.Channel channel

userAgent

protected String userAgent

cookies

protected List<io.netty.handler.codec.http.Cookie> cookies

proxyHost

protected String proxyHost

proxyUser

protected String proxyUser

proxyPass

protected String proxyPass

proxyPort

protected int proxyPort

version

protected io.netty.handler.codec.http.HttpVersion version

redirectStatusCodes

protected Set<Integer> redirectStatusCodes

originalUri

protected URI originalUri

proxyRequest

protected io.netty.handler.codec.http.DefaultFullHttpRequest proxyRequest

connectFuture

protected io.netty.channel.ChannelFuture connectFuture

useSSL

protected boolean useSSL

tunneling

protected boolean tunneling

sslProtocols

protected String[] sslProtocols

contents

protected final io.netty.buffer.ByteBuf contents

_this

protected T extends Request<T> _this

conf

protected Function1<io.netty.bootstrap.Bootstrap> conf

policy

protected RetryPolicy policy

Constructor Detail

Request

public Request(HttpRequestBuilder builder,
       io.netty.channel.EventLoopGroup group,
       URI uri,
       io.netty.handler.codec.http.HttpMethod method,
       io.netty.handler.codec.http.HttpVersion version,
       Reader responseReader)

Method Detail

deleteTempFileOnExit

public void deleteTempFileOnExit(boolean delete)

Parameters:

delete - should delete temp file on exit (on normal exit) if true

baseDirectory

public void baseDirectory(String baseDir)

Parameters:

baseDir - system temp directory by default

newNettyRequest

protected void newNettyRequest(URI uri,
                   io.netty.handler.codec.http.HttpMethod method,
                   io.netty.handler.codec.http.HttpVersion version)

redirectOn

public T redirectOn(int... codes)

Automatically follow redirect responses for the given status codes

Parameters:

codes - the status codes to treat as redirects

Returns:

_this

headers

public io.netty.handler.codec.http.HttpHeaders headers()

redirectOn

public Set<Integer> redirectOn()

Returns:

the set of status codes this request's responses should be redirected on

execute

public FutureResponse execute()

execute

public FutureResponse execute(Function1<io.netty.bootstrap.Bootstrap> conf)

Makes the request to the server

Returns:

A Future which is notified when the response is acknowledged by the server. It doesn't mean the entire contents of the response has been received, just that it's started.

retry

public void retry()

retryOrFail

protected void retryOrFail(Throwable cause,
               boolean connectFailure)

policy

public T policy(RetryPolicy policy)

Set the retry policy that will be used to retry a request if it fails. No retries are done by default.

retryOn

public Set<Integer> retryOn()

retryOn

public T retryOn(int... statusCodes)

Automatically retry the connection using the configured retry policy

getScheme

protected String getScheme()

getHost

protected String getHost()

getPort

protected int getPort(String scheme)

isSSLScheme

protected boolean isSSLScheme(String scheme)

configure

protected void configure()
                  throws Exception

Throws:

Exception

isProxyEnabled

public boolean isProxyEnabled()

Uses the proxy host to determine if proxy is enabled for this request.

Returns:

true if proxyHost is not null and is not empty

configureProxy

protected void configureProxy(boolean ssl)

newInitializer

protected io.netty.channel.ChannelHandler newInitializer()

connect

protected io.netty.channel.ChannelFuture connect(String host,
                                     int port,
                                     io.netty.bootstrap.Bootstrap bootstrap)

makeTheRequest

protected io.netty.channel.ChannelFuture makeTheRequest()

getProxyPath

protected String getProxyPath()

newHandler

protected io.netty.channel.SimpleChannelInboundHandler<Object> newHandler()

getChannel

public io.netty.channel.Channel getChannel()

proxy

public T proxy(String host,
      int port)

proxy

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

Sets proxy information what will be used to make the request These proxy settings apply only to this request, not any other made after

Parameters:

host - the proxy host

port - the proxy port

username - username for the proxy

password - password for the proxy

Returns:

_this

userAgent

public T userAgent(String agent)

header

public T header(String name,
       Object value)

Set a header on this request

Returns:

_this

header

public T header(String name,
       Iterable<?> value)

Set a header on this request

Returns:

_this

header

public T header(String name,
       String value)

Set a header on this request

Returns:

_this

query

public T query(String name,
      Object value)

Adds a query string parameter to the request

Parameters:

name - the name of the query string

value - the value

Returns:

_this

cookie

public T cookie(io.netty.handler.codec.http.Cookie cookie)

Adds a cookie to this request

Parameters:

cookie - the cookie to add

Returns:

_this

cookie

public T cookie(String name,
       Object value)

Adds a cookie with the given name and value

Parameters:

name - the name

value - the value

Returns:

_this

cookies

public List<io.netty.handler.codec.http.Cookie> cookies()

Returns:

List of Cookies set in this request

shutdown

public void shutdown()

response

public Response response()

Returns:

The resposne generated for this request

originalUri

public URI originalUri()

Returns:

The URI this request was first made to or NULL if the response did not result in a redirect

url

public URI url()

url

public T url(String url)
                         throws URISyntaxException

Throws:

URISyntaxException

nettyRequest

public io.netty.handler.codec.http.HttpRequest nettyRequest()

withSSLProtocols

public T withSSLProtocols(String[] protocols)