ball.http

Class ProtocolRequestBuilder

java.lang.Object

ball.http.ProtocolRequestBuilder

public class ProtocolRequestBuilder
extends Object

HttpRequest builder for ProtocolClient.protocol(). See the type(Annotation,Class), method(Annotation,Method), parameter(Annotation,Parameter,...), and parameter(Parameter,...) methods for the supported protocol interface, method, and method parameter Annotations and types.

Protocol API authors should consider designing protocol methods to throw HttpResponseException, ClientProtocolException, and IOException.

Supported type (interface) annotations:

Element
Produces
ApplicationPath
Consumes
ConstrainedTo
Path

Supported method annotations:

Element
FormParam
POST
PUT
GET
Produces
OPTIONS
PATCH
CookieParam
Consumes
DELETE
MatrixParam
HEAD
BeanParam
Path
HeaderParam
PathParam
QueryParam

Supported method parameter annotations:

Element
FormParam
PathParam
CookieParam
MatrixParam
BeanParam
QueryParam
HeaderParam

Supported method parameter types:

Element
URI
HttpEntity
Object
HttpMessage

Version:

$Revision: 6118 $

Author:

Allen D. Ball

Field Summary

Fields

Modifier and Type	Field and Description
static Set<Class<? extends Annotation>>	METHOD_ANNOTATIONS Supported method annotations.
static Set<Class<? extends Annotation>>	PARAMETER_ANNOTATIONS Supported method parameter annotations.
static Set<Class<?>>	PARAMETER_TYPES Supported method parameter types.
static Set<Class<? extends Annotation>>	TYPE_ANNOTATIONS Supported type (interface) annotations.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProtocolRequestBuilder(ProtocolClient<?> client) Sole constructor.

Method Summary

Modifier and Type	Method and Description
HttpMessage	build(Method method, Object[] argv) Build a HttpRequest (HttpMessage) from the protocol interface Method.
protected void	method(BeanParam annotation, Method method) BeanParam method Annotation
protected void	method(Consumes annotation, Method method) Consumes method Annotation
protected void	method(CookieParam annotation, Method method) CookieParam method Annotation
protected void	method(DELETE annotation, Method method) DELETE method Annotation
protected void	method(FormParam annotation, Method method) FormParam method Annotation
protected void	method(GET annotation, Method method) GET method Annotation
protected void	method(HeaderParam annotation, Method method) HeaderParam method Annotation
protected void	method(HEAD annotation, Method method) HEAD method Annotation
protected void	method(MatrixParam annotation, Method method) MatrixParam method Annotation
protected void	method(OPTIONS annotation, Method method) OPTIONS method Annotation
protected void	method(PATCH annotation, Method method) PATCH method Annotation
protected void	method(Path annotation, Method method) Path method Annotation
protected void	method(PathParam annotation, Method method) PathParam method Annotation
protected void	method(POST annotation, Method method) POST method Annotation
protected void	method(Produces annotation, Method method) Produces method Annotation
protected void	method(PUT annotation, Method method) PUT method Annotation
protected void	method(QueryParam annotation, Method method) QueryParam method Annotation
protected void	parameter(BeanParam annotation, Parameter parameter, Object argument) BeanParam method parameter Annotation
protected void	parameter(CookieParam annotation, Parameter parameter, Object argument) CookieParam method parameter Annotation
protected void	parameter(FormParam annotation, Parameter parameter, Object argument) FormParam method parameter Annotation
protected void	parameter(HeaderParam annotation, Parameter parameter, Object argument) HeaderParam method parameter Annotation
protected void	parameter(MatrixParam annotation, Parameter parameter, Object argument) MatrixParam method parameter Annotation
protected void	parameter(Parameter parameter, HttpEntity argument) HttpEntity method parameter
protected void	parameter(Parameter parameter, HttpMessage argument) HttpMessage method parameter
protected void	parameter(Parameter parameter, Object argument) Object method parameter
protected void	parameter(Parameter parameter, URI argument) URI method parameter
protected void	parameter(PathParam annotation, Parameter parameter, Object argument) PathParam method parameter Annotation
protected void	parameter(QueryParam annotation, Parameter parameter, Object argument) QueryParam method parameter Annotation
protected void	type(ApplicationPath annotation, Class<?> type) ApplicationPath type (interface) Annotation
protected void	type(ConstrainedTo annotation, Class<?> type) ConstrainedTo type (interface) Annotation
protected void	type(Consumes annotation, Class<?> type) Consumes type (interface) Annotation
protected void	type(Path annotation, Class<?> type) Path type (interface) Annotation
protected void	type(Produces annotation, Class<?> type) Produces type (interface) Annotation

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_ANNOTATIONS

public static final Set<Class<? extends Annotation>> TYPE_ANNOTATIONS

Supported type (interface) annotations.

METHOD_ANNOTATIONS

public static final Set<Class<? extends Annotation>> METHOD_ANNOTATIONS

Supported method annotations.

PARAMETER_ANNOTATIONS

public static final Set<Class<? extends Annotation>> PARAMETER_ANNOTATIONS

Supported method parameter annotations.

PARAMETER_TYPES

public static final Set<Class<?>> PARAMETER_TYPES

Supported method parameter types.

Constructor Detail

ProtocolRequestBuilder

protected ProtocolRequestBuilder(ProtocolClient<?> client)

Sole constructor.

Parameters:

client - The ProtocolClient.

Method Detail

build

public HttpMessage build(Method method,
                         Object[] argv)
                  throws Throwable

Build a HttpRequest (HttpMessage) from the protocol interface Method.

Parameters:

method - The interface Method.

argv - The caller's arguments.

Returns:

The HttpMessage.

Throws:

Throwable - If the call fails for any reason.

type

protected void type(ApplicationPath annotation,
                    Class<?> type)
             throws Throwable

ApplicationPath type (interface) Annotation

Parameters:

annotation - The ApplicationPath Annotation.

type - The annotated Class.

Throws:

Throwable - If the Annotation cannot be configured.

type

protected void type(ConstrainedTo annotation,
                    Class<?> type)
             throws Throwable

ConstrainedTo type (interface) Annotation

Parameters:

annotation - The ConstrainedTo Annotation.

type - The annotated Class.

Throws:

Throwable - If the Annotation cannot be configured.

type

protected void type(Consumes annotation,
                    Class<?> type)
             throws Throwable

Consumes type (interface) Annotation

Parameters:

annotation - The Consumes Annotation.

type - The annotated Class.

Throws:

Throwable - If the Annotation cannot be configured.

type

protected void type(Path annotation,
                    Class<?> type)
             throws Throwable

Path type (interface) Annotation

Parameters:

annotation - The Path Annotation.

type - The annotated Class.

Throws:

Throwable - If the Annotation cannot be configured.

type

protected void type(Produces annotation,
                    Class<?> type)
             throws Throwable

Produces type (interface) Annotation

Parameters:

annotation - The Produces Annotation.

type - The annotated Class.

Throws:

Throwable - If the Annotation cannot be configured.

method

protected void method(BeanParam annotation,
                      Method method)
               throws Throwable

BeanParam method Annotation

Parameters:

annotation - The BeanParam Annotation.

method - The annotated Method.

Throws:

Throwable - If the Annotation cannot be configured.

method

protected void method(Consumes annotation,
                      Method method)
               throws Throwable

Consumes method Annotation

Parameters:

annotation - The Consumes Annotation.

method - The annotated Method.

Throws:

Throwable - If the Annotation cannot be configured.

method

protected void method(CookieParam annotation,
                      Method method)
               throws Throwable

CookieParam method Annotation

Parameters:

annotation - The CookieParam Annotation.

method - The annotated Method.

Throws:

Throwable - If the Annotation cannot be configured.

method

protected void method(DELETE annotation,
                      Method method)
               throws Throwable

DELETE method Annotation

Parameters:

annotation - The DELETE Annotation.

method - The annotated Method.

Throws:

Throwable - If the Annotation cannot be configured.

method

protected void method(FormParam annotation,
                      Method method)
               throws Throwable

FormParam method Annotation

Parameters:

annotation - The FormParam Annotation.

method - The annotated Method.

Throws:

Throwable - If the Annotation cannot be configured.

method

protected void method(GET annotation,
                      Method method)
               throws Throwable

GET method Annotation

Parameters:

annotation - The GET Annotation.

method - The annotated Method.

Throws:

Throwable - If the Annotation cannot be configured.

method

protected void method(HEAD annotation,
                      Method method)
               throws Throwable

HEAD method Annotation

Parameters:

annotation - The HEAD Annotation.

method - The annotated Method.

Throws:

Throwable - If the Annotation cannot be configured.

method

protected void method(HeaderParam annotation,
                      Method method)
               throws Throwable

HeaderParam method Annotation

Parameters:

annotation - The HeaderParam Annotation.

method - The annotated Method.

Throws:

Throwable - If the Annotation cannot be configured.

method

protected void method(MatrixParam annotation,
                      Method method)
               throws Throwable

MatrixParam method Annotation

Parameters:

annotation - The MatrixParam Annotation.

method - The annotated Method.

Throws:

Throwable - If the Annotation cannot be configured.

method

protected void method(OPTIONS annotation,
                      Method method)
               throws Throwable

OPTIONS method Annotation

Parameters:

annotation - The OPTIONS Annotation.

method - The annotated Method.

Throws:

Throwable - If the Annotation cannot be configured.

method

protected void method(PATCH annotation,
                      Method method)
               throws Throwable

PATCH method Annotation

Parameters:

annotation - The PATCH Annotation.

method - The annotated Method.

Throws:

Throwable - If the Annotation cannot be configured.

method

protected void method(Path annotation,
                      Method method)
               throws Throwable

Path method Annotation

Parameters:

annotation - The Path Annotation.

method - The annotated Method.

Throws:

Throwable - If the Annotation cannot be configured.

method

protected void method(PathParam annotation,
                      Method method)
               throws Throwable

PathParam method Annotation

Parameters:

annotation - The PathParam Annotation.

method - The annotated Method.

Throws:

Throwable - If the Annotation cannot be configured.

method

protected void method(QueryParam annotation,
                      Method method)
               throws Throwable

QueryParam method Annotation

Parameters:

annotation - The QueryParam Annotation.

method - The annotated Method.

Throws:

Throwable - If the Annotation cannot be configured.

method

protected void method(POST annotation,
                      Method method)
               throws Throwable

POST method Annotation

Parameters:

annotation - The POST Annotation.

method - The annotated Method.

Throws:

Throwable - If the Annotation cannot be configured.

method

protected void method(Produces annotation,
                      Method method)
               throws Throwable

Produces method Annotation

Parameters:

annotation - The Produces Annotation.

method - The annotated Method.

Throws:

Throwable - If the Annotation cannot be configured.

method

protected void method(PUT annotation,
                      Method method)
               throws Throwable

PUT method Annotation

Parameters:

annotation - The PUT Annotation.

method - The annotated Method.

Throws:

Throwable - If the Annotation cannot be configured.

parameter

protected void parameter(BeanParam annotation,
                         Parameter parameter,
                         Object argument)
                  throws Throwable

BeanParam method parameter Annotation

Parameters:

annotation - The BeanParam Annotation.

parameter - The Method Parameter.

argument - The Object representing the cookie parameter value.

Throws:

Throwable - If the Annotation cannot be configured.

parameter

protected void parameter(CookieParam annotation,
                         Parameter parameter,
                         Object argument)
                  throws Throwable

CookieParam method parameter Annotation

Parameters:

annotation - The CookieParam Annotation.

parameter - The Method Parameter.

argument - The Object representing the cookie parameter value.

Throws:

Throwable - If the Annotation cannot be configured.

parameter

protected void parameter(FormParam annotation,
                         Parameter parameter,
                         Object argument)
                  throws Throwable

FormParam method parameter Annotation

Parameters:

annotation - The FormParam Annotation.

parameter - The Method Parameter.

argument - The Object representing the form parameter value.

Throws:

Throwable - If the Annotation cannot be configured.

parameter

protected void parameter(HeaderParam annotation,
                         Parameter parameter,
                         Object argument)
                  throws Throwable

HeaderParam method parameter Annotation

Parameters:

annotation - The HeaderParam Annotation.

parameter - The Method Parameter.

argument - The Object representing the header parameter value.

Throws:

Throwable - If the Annotation cannot be configured.

parameter

protected void parameter(MatrixParam annotation,
                         Parameter parameter,
                         Object argument)
                  throws Throwable

MatrixParam method parameter Annotation

Parameters:

annotation - The MatrixParam Annotation.

parameter - The Method Parameter.

argument - The Object representing the matrix parameter value.

Throws:

Throwable - If the Annotation cannot be configured.

parameter

protected void parameter(PathParam annotation,
                         Parameter parameter,
                         Object argument)
                  throws Throwable

PathParam method parameter Annotation

Parameters:

annotation - The PathParam Annotation.

parameter - The Method Parameter.

argument - The Object representing the path parameter value.

Throws:

Throwable - If the Annotation cannot be configured.

parameter

protected void parameter(QueryParam annotation,
                         Parameter parameter,
                         Object argument)
                  throws Throwable

QueryParam method parameter Annotation

Parameters:

annotation - The QueryParam Annotation.

parameter - The Method Parameter.

argument - The Object representing the query parameter value.

Throws:

Throwable - If the Annotation cannot be configured.

parameter

protected void parameter(Parameter parameter,
                         HttpMessage argument)
                  throws Throwable

HttpMessage method parameter

Parameters:

parameter - The Method Parameter.

argument - The HttpMessage.

Throws:

Throwable - If the argument cannot be configured.

parameter

protected void parameter(Parameter parameter,
                         HttpEntity argument)
                  throws Throwable

HttpEntity method parameter

Parameters:

parameter - The Method Parameter.

argument - The HttpEntity.

Throws:

Throwable - If the argument cannot be configured.

parameter

protected void parameter(Parameter parameter,
                         URI argument)
                  throws Throwable

URI method parameter

Parameters:

parameter - The Method Parameter.

argument - The URI.

Throws:

Throwable - If the argument cannot be configured.

parameter

protected void parameter(Parameter parameter,
                         Object argument)
                  throws Throwable

Object method parameter

Parameters:

parameter - The Method Parameter.

argument - The Object.

Throws:

Throwable - If the argument cannot be configured.