ball.http

Class ProtocolClient<P>

java.lang.Object

ball.http.ProtocolClient<P>

Type Parameters:

P - The protocol type erasure.

This class provides:

1. HttpClient (client())
2. HttpContext (context())
3. A Proxy which implements the annotated protocol interface
4. this implements HttpRequestInterceptor and HttpResponseInterceptor which are configured into HttpClientBuilder; subclasses can override process(HttpRequest,HttpContext) and process(HttpResponse,HttpContext)

See the ProtocolRequestBuilder for the supported protocol interface Annotations and method parameter types.

See ProtocolRequestBuilder and ProtocolInvocationHandler for a description of how HttpRequests are generated and executed.

All Implemented Interfaces:

HttpRequestInterceptor, HttpResponseInterceptor

Direct Known Subclasses:

HDHRPrimeClient, SDClient

public abstract class ProtocolClient<P>
extends Object
implements HttpRequestInterceptor, HttpResponseInterceptor

Abstract ProtocolClient base class.

Version:

$Revision: 6118 $

Author:

Allen D. Ball

Field Summary

Fields

Modifier and Type	Field and Description
protected Charset	charset Field exposed for subclass initialization; see getCharset().
protected JAXBContext	jaxb Field exposed for subclass initialization; see getJAXBContext().
protected ObjectMapper	mapper Field exposed for subclass initialization; see getObjectMapper().

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProtocolClient(Class<? extends P> protocol) Constructor that creates HttpClientBuilder and HttpCoreContext.
protected	ProtocolClient(HttpClientBuilder builder, HttpCoreContext context, Class<? extends P> protocol) Constructor that allows the subclass to provide a configured HttpClientBuilder and/or HttpCoreContext.

Method Summary

Modifier and Type	Method and Description
CloseableHttpClient	client()
HttpCoreContext	context()
Charset	getCharset()
JAXBContext	getJAXBContext()
Marshaller	getMarshaller()
ObjectMapper	getObjectMapper()
Unmarshaller	getUnmarshaller()
ProtocolInvocationHandler	handler()
void	process(HttpRequest request, HttpContext context)
void	process(HttpResponse response, HttpContext context)
Class<? extends P>	protocol()
P	proxy()

Methods inherited from class java.lang.Object

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

Field Detail

charset

protected transient Charset charset

Field exposed for subclass initialization; see getCharset().

jaxb

protected transient JAXBContext jaxb

Field exposed for subclass initialization; see getJAXBContext().

mapper

protected transient ObjectMapper mapper

Field exposed for subclass initialization; see getObjectMapper().

Constructor Detail

ProtocolClient

protected ProtocolClient(Class<? extends P> protocol)

Constructor that creates HttpClientBuilder and HttpCoreContext.

Parameters:

protocol - The protocol Class.

ProtocolClient

protected ProtocolClient(HttpClientBuilder builder,
                         HttpCoreContext context,
                         Class<? extends P> protocol)

Constructor that allows the subclass to provide a configured HttpClientBuilder and/or HttpCoreContext.

Parameters:

builder - A configured HttpClientBuilder.

context - A HttpCoreContext (may be null).

protocol - The protocol Class.

Method Detail

client

public CloseableHttpClient client()

Returns:

ProtocolClient CloseableHttpClient

context

public HttpCoreContext context()

Returns:

ProtocolClient HttpCoreContext

protocol

public Class<? extends P> protocol()

Returns:

protocol() Class

proxy

public P proxy()

Returns:

protocol() Proxy

handler

public ProtocolInvocationHandler handler()

Returns:

Proxy ProtocolInvocationHandler

getCharset

public Charset getCharset()

Returns:

protocol() configured Charset

getJAXBContext

public JAXBContext getJAXBContext()

Returns:

protocol() configured JAXBContext

getMarshaller

public Marshaller getMarshaller()

Returns:

protocol() configured Marshaller

getUnmarshaller

public Unmarshaller getUnmarshaller()

Returns:

protocol() configured Unmarshaller

getObjectMapper

public ObjectMapper getObjectMapper()

Returns:

protocol() configured ObjectMapper.

process

public void process(HttpRequest request,
                    HttpContext context)
             throws IOException

Specified by:

process in interface HttpRequestInterceptor

Throws:

IOException

process

public void process(HttpResponse response,
                    HttpContext context)
             throws IOException

Specified by:

process in interface HttpResponseInterceptor

Throws:

IOException