Package com.vonage.client

Class DynamicEndpoint<T,R>

java.lang.Object

com.vonage.client.AbstractMethod<T,R>

com.vonage.client.DynamicEndpoint<T,R>

Type Parameters:

T - The request body type.

R - The response body type.

All Implemented Interfaces:

RestEndpoint<T,R>

public class DynamicEndpoint<T,R>
extends AbstractMethod<T,R>

Enables convenient declaration of endpoints without directly implementing AbstractMethod. This decouples the endpoint's implementation from the underlying HTTP library.

Since:

7.7.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DynamicEndpoint.Builder<T,R>

Field Summary

Fields

Modifier and Type	Field	Description
protected String	accept
protected Set<Class<? extends AuthMethod>>	authMethods
protected T	cachedRequestBody
protected String	contentType
protected BiFunction<DynamicEndpoint<T,R>,? super T,String>	pathGetter
protected HttpMethod	requestMethod
protected Class<? extends RuntimeException>	responseExceptionType
protected Class<R>	responseType

Fields inherited from class com.vonage.client.AbstractMethod

httpWrapper

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DynamicEndpoint(DynamicEndpoint.Builder<T,R> builder)

Method Summary

Modifier and Type	Method	Description
static <T, R> DynamicEndpoint.Builder<T,R>	builder(Class<R> responseType)
static <T, R> DynamicEndpoint.Builder<T,R>	builder(R[] responseType)	This trick enables initialisation of the builder whilst inferring the response type <R> without directly providing the class by using varargs as a parameter.
static URI	buildUri(String base, Map<String,?> requestParams)
protected final Set<Class<? extends AuthMethod>>	getAcceptableAuthMethods()
protected final org.apache.http.client.methods.RequestBuilder	makeRequest(T requestBody)	Construct and return a RequestBuilder instance from the provided request.
protected final R	parseResponse(org.apache.http.HttpResponse response)	Construct a ResultT representing the contents of the HTTP response returned from the Vonage Voice API.
protected R	parseResponseFromString(String response)

Methods inherited from class com.vonage.client.AbstractMethod

execute, getAuthMethod, getHttpWrapper, postProcessParsedResponse

Methods inherited from class java.lang.Object

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

Field Details

authMethods

protected Set<Class<? extends AuthMethod>> authMethods

contentType

protected String contentType

accept

protected String accept

requestMethod

protected HttpMethod requestMethod

pathGetter

protected BiFunction<DynamicEndpoint<T,R>,? super T,String> pathGetter

responseExceptionType

protected Class<? extends RuntimeException> responseExceptionType

responseType

protected Class<R> responseType

cachedRequestBody

protected T cachedRequestBody

Constructor Details

DynamicEndpoint

protected DynamicEndpoint(DynamicEndpoint.Builder<T,R> builder)

Method Details

builder

public static <T,
R> DynamicEndpoint.Builder<T,R> builder(R[] responseType)

This trick enables initialisation of the builder whilst inferring the response type <R> without directly providing the class by using varargs as a parameter. See usages for examples.

Type Parameters:

T - The request type.

R - The response type.

Parameters:

responseType - The response type array, not provided directly but via a varargs parameter.

Returns:

A new Builder.

Since:

7.9.0

builder

public static <T,
R> DynamicEndpoint.Builder<T,R> builder(Class<R> responseType)

getAcceptableAuthMethods

protected final Set<Class<? extends AuthMethod>> getAcceptableAuthMethods()

Specified by:

getAcceptableAuthMethods in class AbstractMethod<T,R>

buildUri

public static URI buildUri(String base,
 Map<String,?> requestParams)

makeRequest

protected final org.apache.http.client.methods.RequestBuilder makeRequest(T requestBody)

Description copied from class: AbstractMethod

Construct and return a RequestBuilder instance from the provided request.

Specified by:

makeRequest in class AbstractMethod<T,R>

Parameters:

requestBody - A RequestT representing input to the REST call to be made

Returns:

A ResultT representing the response from the executed REST call

parseResponse

protected final R parseResponse(org.apache.http.HttpResponse response)
                         throws IOException

Description copied from class: AbstractMethod

Construct a ResultT representing the contents of the HTTP response returned from the Vonage Voice API.

Specified by:

parseResponse in class AbstractMethod<T,R>

Parameters:

response - An HttpResponse returned from the Vonage Voice API

Returns:

A ResultT type representing the result of the REST call

Throws:

IOException - if a problem occurs parsing the response

parseResponseFromString

protected R parseResponseFromString(String response)