org.resthub.web

Class Client

java.lang.Object

org.resthub.web.Client

All Implemented Interfaces:

Closeable, AutoCloseable

public class Client
extends Object
implements Closeable

RESThub AsyncHttpClient wrapper inspired from Play! Framework 2

Sample usage:

 Client httpClient = new Client();
 User user = httpClient.url("http://localhost:8080/api/user").jsonPost(user).resource(User.class);

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Client.Request Provides the bridge between the wrapper and the underlying ning request
class	Client.RequestHolder provides the User facing API for building WS request.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<BodyReader>	bodyReaders
protected List<BodyWriter>	bodyWriters
protected com.ning.http.client.AsyncHttpClientConfig.Builder	builder
protected com.ning.http.client.AsyncHttpClient	client
protected OAuth2Config	oAuth2Config
protected OAuth2Config.Builder	oAuth2ConfigBuilder

Constructor Summary

Constructors

Constructor and Description
Client() Create an HTTP client with default configuration
Client(com.ning.http.client.AsyncHttpClientConfig.Builder builder) Create an HTTP client with a pre-configured Builder

Method Summary

Methods

Modifier and Type	Method and Description
Client	addBodyReader(BodyReader br) Add a candidate BodyReader to read an HTTP response body to an object
Client	addBodyWriter(BodyWriter bw) Add a candidate BodyWriter to serialize an object to an HTTP response body
void	close()
com.ning.http.client.AsyncHttpClient	getNativeClient() Return the AsyncHttpClient native client for advanced features
Client	setAuth(String username, String password, com.ning.http.client.Realm.AuthScheme scheme) Sets the authentication header for the current client.
Client	setOAuth2(String username, String password, String accessTokenEndpoint, String clientId, String clientSecret) Sets the OAuth2 authentication header for the current client.
Client	setOAuth2Builder(OAuth2Config.Builder builder) Set the given OAuth2Config builder for this client.
Client	setProxy(String host, int port) Set HTTP proxy configuration
Client.RequestHolder	url(String url) Prepare a new request.

Methods inherited from class java.lang.Object

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

Field Detail

client

protected com.ning.http.client.AsyncHttpClient client

builder

protected com.ning.http.client.AsyncHttpClientConfig.Builder builder

oAuth2ConfigBuilder

protected OAuth2Config.Builder oAuth2ConfigBuilder

oAuth2Config

protected OAuth2Config oAuth2Config

bodyReaders

protected List<BodyReader> bodyReaders

bodyWriters

protected List<BodyWriter> bodyWriters

Constructor Detail

Client

public Client()

Create an HTTP client with default configuration

Client

public Client(com.ning.http.client.AsyncHttpClientConfig.Builder builder)

Create an HTTP client with a pre-configured Builder

See Also:

AsyncHttpClientConfig.Builder

Method Detail

getNativeClient

public com.ning.http.client.AsyncHttpClient getNativeClient()

Return the AsyncHttpClient native client for advanced features

setProxy

public Client setProxy(String host,
              int port)

Set HTTP proxy configuration

addBodyReader

public Client addBodyReader(BodyReader br)

Add a candidate BodyReader to read an HTTP response body to an object

Parameters:

br - a bodyreader

See Also:

BodyReader

addBodyWriter

public Client addBodyWriter(BodyWriter bw)

Add a candidate BodyWriter to serialize an object to an HTTP response body

Parameters:

bw - a bodywriter

See Also:

BodyWriter

setAuth

public Client setAuth(String username,
             String password,
             com.ning.http.client.Realm.AuthScheme scheme)

Sets the authentication header for the current client.

Parameters:

username - username identifier

password - user password

scheme - authentication scheme

setOAuth2Builder

public Client setOAuth2Builder(OAuth2Config.Builder builder)

Set the given OAuth2Config builder for this client. This builder will create the actual OAuth2Config used for all OAuth2 related features. This HTTP Client wrapper already has methods (like setOAuth2()) that set the OAuth2 configuration on the client.

Parameters:

builder - builder to set

setOAuth2

public Client setOAuth2(String username,
               String password,
               String accessTokenEndpoint,
               String clientId,
               String clientSecret)

Sets the OAuth2 authentication header for the current client.

Parameters:

username - The user's login

password - The user's password

accessTokenEndpoint - URL of the OAuth2.0 access token endpoint service

clientId - id of the current application registered with the remote OAuth2.0 provider

clientSecret - secret of the current application registered with the remote OAuth2.0 provider

url

public Client.RequestHolder url(String url)

Prepare a new request. You can then construct it by chaining calls.

Parameters:

url - the URL to request

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable