de.taimos.httputils

Class HTTPRequest

java.lang.Object

de.taimos.httputils.HTTPRequest

public final class HTTPRequest
extends Object

Author:

thoeger

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HTTPRequest.Method

Method Summary

Modifier and Type	Method and Description
HTTPRequest	accept(String type)
HTTPRequest	auth(String authString)
HTTPRequest	authBasic(String user, String password)
HTTPRequest	authBearer(String accessToken)
HTTPRequest	body(String bodyString)
HTTPRequest	contentType(String type)
HTTPResponse	delete()
void	deleteAsync(Executor executor, HTTPResponseCallback callback)
void	deleteAsync(HTTPResponseCallback callback)
HTTPRequest	followRedirect(boolean follow)
HTTPRequest	form(Map<String,String> form)
HTTPResponse	get()
void	getAsync(Executor executor, HTTPResponseCallback callback)
void	getAsync(HTTPResponseCallback callback)
HTTPResponse	head()
void	headAsync(Executor executor, HTTPResponseCallback callback)
void	headAsync(HTTPResponseCallback callback)
HTTPRequest	header(String name, String value)
HTTPResponse	options()
void	optionsAsync(Executor executor, HTTPResponseCallback callback)
void	optionsAsync(HTTPResponseCallback callback)
HTTPResponse	patch()
void	patchAsync(Executor executor, HTTPResponseCallback callback)
void	patchAsync(HTTPResponseCallback callback)
HTTPRequest	pathParam(String name, String value)
HTTPResponse	post()
void	postAsync(Executor executor, HTTPResponseCallback callback)
void	postAsync(HTTPResponseCallback callback)
HTTPResponse	put()
void	putAsync(Executor executor, HTTPResponseCallback callback)
void	putAsync(HTTPResponseCallback callback)
HTTPRequest	queryParam(String name, String value)
HTTPRequest	retry() Retry 5 times on Exception or 5XX status code with exponential backoff.
HTTPRequest	retry(int maxRetries, Retryable retryable, WaitStrategy waitStrategy) Retry.
HTTPRequest	timeout(int newTimeout)
HTTPRequest	userAgent(String agent)

Methods inherited from class java.lang.Object

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

Method Detail

header

public HTTPRequest header(String name,
                          String value)

Parameters:

name - the name of the header

value - the value of the header

Returns:

this

queryParam

public HTTPRequest queryParam(String name,
                              String value)

Parameters:

name - the name of the query parameter

value - the value of the query parameter

Returns:

this

pathParam

public HTTPRequest pathParam(String name,
                             String value)

Parameters:

name - the name of the path parameter

value - the value of the path parameter

Returns:

this

timeout

public HTTPRequest timeout(int newTimeout)

Parameters:

newTimeout - Timeout in ms

Returns:

this

followRedirect

public HTTPRequest followRedirect(boolean follow)

Parameters:

follow - true to automatically follow redirects; false otherwise

Returns:

this

retry

public HTTPRequest retry(int maxRetries,
                         Retryable retryable,
                         WaitStrategy waitStrategy)

Retry.

Parameters:

maxRetries - Maximum number of retries

retryable - Function to determine if call should be retried

waitStrategy - Function to calculate the time to wait between two retries

Returns:

this

retry

public HTTPRequest retry()

Retry 5 times on Exception or 5XX status code with exponential backoff.

Returns:

this

userAgent

public HTTPRequest userAgent(String agent)

Parameters:

agent - the user agent string to use

Returns:

this

contentType

public HTTPRequest contentType(String type)

Parameters:

type - the Content-Type

Returns:

this

auth

public HTTPRequest auth(String authString)

Parameters:

authString - the Authorization header

Returns:

this

authBasic

public HTTPRequest authBasic(String user,
                             String password)

Parameters:

user - the username

password - the password

Returns:

this

authBearer

public HTTPRequest authBearer(String accessToken)

Parameters:

accessToken - the OAuth2 Bearer access token

Returns:

this

accept

public HTTPRequest accept(String type)

Parameters:

type - the Accept type

Returns:

this

body

public HTTPRequest body(String bodyString)

Parameters:

bodyString - the body entity

Returns:

this

form

public HTTPRequest form(Map<String,String> form)

Parameters:

form - the form content

Returns:

this

get

public HTTPResponse get()

Returns:

the HTTPResponse

put

public HTTPResponse put()

Returns:

the HTTPResponse

patch

public HTTPResponse patch()

Returns:

the HTTPResponse

post

public HTTPResponse post()

Returns:

the HTTPResponse

delete

public HTTPResponse delete()

Returns:

the HTTPResponse

options

public HTTPResponse options()

Returns:

the HTTPResponse

head

public HTTPResponse head()

Returns:

the HTTPResponse

getAsync

public void getAsync(HTTPResponseCallback callback)

Parameters:

callback - HTTPResponseCallback

getAsync

public void getAsync(Executor executor,
                     HTTPResponseCallback callback)

Parameters:

executor - Thread pool

callback - HTTPResponseCallback

putAsync

public void putAsync(HTTPResponseCallback callback)

Parameters:

callback - HTTPResponseCallback

putAsync

public void putAsync(Executor executor,
                     HTTPResponseCallback callback)

Parameters:

executor - Thread pool

callback - HTTPResponseCallback

patchAsync

public void patchAsync(HTTPResponseCallback callback)

Parameters:

callback - HTTPResponseCallback

patchAsync

public void patchAsync(Executor executor,
                       HTTPResponseCallback callback)

Parameters:

executor - Thread pool

callback - HTTPResponseCallback

postAsync

public void postAsync(HTTPResponseCallback callback)

Parameters:

callback - HTTPResponseCallback

postAsync

public void postAsync(Executor executor,
                      HTTPResponseCallback callback)

Parameters:

executor - Thread pool

callback - HTTPResponseCallback

deleteAsync

public void deleteAsync(HTTPResponseCallback callback)

Parameters:

callback - HTTPResponseCallback

deleteAsync

public void deleteAsync(Executor executor,
                        HTTPResponseCallback callback)

Parameters:

executor - Thread pool

callback - HTTPResponseCallback

optionsAsync

public void optionsAsync(HTTPResponseCallback callback)

Parameters:

callback - HTTPResponseCallback

optionsAsync

public void optionsAsync(Executor executor,
                         HTTPResponseCallback callback)

Parameters:

executor - Thread pool

callback - HTTPResponseCallback

headAsync

public void headAsync(HTTPResponseCallback callback)

Parameters:

callback - HTTPResponseCallback

headAsync

public void headAsync(Executor executor,
                      HTTPResponseCallback callback)

Parameters:

executor - Thread pool

callback - HTTPResponseCallback