com.microsoft.rest

Class ServiceResponseBuilder<T,E extends RestException>

java.lang.Object

com.microsoft.rest.ServiceResponseBuilder<T,E>

Type Parameters:

T - The return type the caller expects from the REST response.

E - the exception to throw in case of error.

public class ServiceResponseBuilder<T,E extends RestException>
extends Object

The builder for building a ServiceResponse.

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<? extends RestException>	exceptionType The exception type to thrown in case of error.
protected JacksonMapperAdapter	mapperAdapter The mapperAdapter used for deserializing the response.
protected Map<Integer,Type>	responseTypes A mapping of HTTP status codes and their corresponding return types.

Constructor Summary

Constructors

Constructor and Description
ServiceResponseBuilder(JacksonMapperAdapter mapperAdapter) Create a ServiceResponseBuilder instance.
ServiceResponseBuilder(JacksonMapperAdapter mapperAdapter, Map<Integer,Type> responseTypes) Create a ServiceResponseBuilder instance.

Method Summary

Modifier and Type	Method and Description
ServiceResponse<T>	build(retrofit2.Response<okhttp3.ResponseBody> response) Build a ServiceResponse instance from a REST call response and a possible error.
protected Object	buildBody(int statusCode, okhttp3.ResponseBody responseBody) Builds the body object from the HTTP status code and returned response body undeserialized and wrapped in ResponseBody.
ServiceResponse<T>	buildEmpty(retrofit2.Response<Void> response) Build a ServiceResponse instance from a REST call response and a possible error, which does not have a response body.
<THeader> ServiceResponseWithHeaders<T,THeader>	buildEmptyWithHeaders(retrofit2.Response<Void> response, Class<THeader> headerType) Build a ServiceResponseWithHeaders instance from a REST call response, a header in JSON format, and a possible error, which does not have a response body.
<THeader> ServiceResponseWithHeaders<T,THeader>	buildWithHeaders(retrofit2.Response<okhttp3.ResponseBody> response, Class<THeader> headerType) Build a ServiceResponseWithHeaders instance from a REST call response, a header in JSON format, and a possible error.
ServiceResponseBuilder<T,E>	register(int statusCode, Type type) Register a mapping from a response status code to a response destination type.
ServiceResponseBuilder<T,E>	registerAll(Map<Integer,Type> responseTypes) Register all the mappings from a response status code to a response destination type stored in a Map.
ServiceResponseBuilder<T,E>	registerError(Class<? extends RestException> type) Register a destination type for errors with models.

Methods inherited from class java.lang.Object

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

Field Detail

responseTypes

protected Map<Integer,Type> responseTypes

A mapping of HTTP status codes and their corresponding return types.

exceptionType

protected Class<? extends RestException> exceptionType

The exception type to thrown in case of error.

mapperAdapter

protected JacksonMapperAdapter mapperAdapter

The mapperAdapter used for deserializing the response.

Constructor Detail

ServiceResponseBuilder

public ServiceResponseBuilder(JacksonMapperAdapter mapperAdapter)

Create a ServiceResponseBuilder instance.

Parameters:

mapperAdapter - the serialization utils to use for deserialization operations

ServiceResponseBuilder

public ServiceResponseBuilder(JacksonMapperAdapter mapperAdapter,
                              Map<Integer,Type> responseTypes)

Create a ServiceResponseBuilder instance.

Parameters:

mapperAdapter - the serialization utils to use for deserialization operations

responseTypes - a mapping of response status codes and response destination types

Method Detail

register

public ServiceResponseBuilder<T,E> register(int statusCode,
                                            Type type)

Register a mapping from a response status code to a response destination type.

Parameters:

statusCode - the status code.

type - the type to deserialize.

Returns:

the same builder instance.

registerError

public ServiceResponseBuilder<T,E> registerError(Class<? extends RestException> type)

Register a destination type for errors with models.

Parameters:

type - the type to deserialize.

Returns:

the same builder instance.

registerAll

public ServiceResponseBuilder<T,E> registerAll(Map<Integer,Type> responseTypes)

Register all the mappings from a response status code to a response destination type stored in a Map.

Parameters:

responseTypes - the mapping from response status codes to response types.

Returns:

the same builder instance.

build

public ServiceResponse<T> build(retrofit2.Response<okhttp3.ResponseBody> response)
                         throws E extends RestException,
                                IOException

Build a ServiceResponse instance from a REST call response and a possible error.

If the status code in the response is registered, the response will be considered valid and deserialized into the specified destination type. If the status code is not registered, the response will be considered invalid and deserialized into the specified error type if there is one. An AutoRestException is also thrown.

Parameters:

response - the Response instance from REST call

Returns:

a ServiceResponse instance of generic type T

Throws:

E - exceptions from the REST call

IOException - exceptions from deserialization

E extends RestException

buildEmpty

public ServiceResponse<T> buildEmpty(retrofit2.Response<Void> response)
                              throws E extends RestException,
                                     IOException

Build a ServiceResponse instance from a REST call response and a possible error, which does not have a response body.

If the status code in the response is registered, the response will be considered valid. If the status code is not registered, the response will be considered invalid. An AutoRestException is also thrown.

Parameters:

response - the Response instance from REST call

Returns:

a ServiceResponse instance of generic type T

Throws:

E - exceptions from the REST call

IOException - exceptions from deserialization

E extends RestException

buildWithHeaders

public <THeader> ServiceResponseWithHeaders<T,THeader> buildWithHeaders(retrofit2.Response<okhttp3.ResponseBody> response,
                                                                        Class<THeader> headerType)
                                                                 throws E extends RestException,
                                                                        IOException

Build a ServiceResponseWithHeaders instance from a REST call response, a header in JSON format, and a possible error.

If the status code in the response is registered, the response will be considered valid and deserialized into the specified destination type. If the status code is not registered, the response will be considered invalid and deserialized into the specified error type if there is one. An AutoRestException is also thrown.

Type Parameters:

THeader - the type of the header

Parameters:

response - the Response instance from REST call

headerType - the type of the header

Returns:

a ServiceResponseWithHeaders instance of generic type T

Throws:

E - exceptions from the REST call

IOException - exceptions from deserialization

E extends RestException

buildEmptyWithHeaders

public <THeader> ServiceResponseWithHeaders<T,THeader> buildEmptyWithHeaders(retrofit2.Response<Void> response,
                                                                             Class<THeader> headerType)
                                                                      throws E extends RestException,
                                                                             IOException

Build a ServiceResponseWithHeaders instance from a REST call response, a header in JSON format, and a possible error, which does not have a response body.

If the status code in the response is registered, the response will be considered valid. If the status code is not registered, the response will be considered invalid. An AutoRestException is also thrown.

Type Parameters:

THeader - the type of the header

Parameters:

response - the Response instance from REST call

headerType - the type of the header

Returns:

a ServiceResponseWithHeaders instance of generic type T

Throws:

E - exceptions from the REST call

IOException - exceptions from deserialization

E extends RestException

buildBody

protected Object buildBody(int statusCode,
                           okhttp3.ResponseBody responseBody)
                    throws IOException

Builds the body object from the HTTP status code and returned response body undeserialized and wrapped in ResponseBody.

Parameters:

statusCode - the HTTP status code

responseBody - the response body

Returns:

the response body, deserialized

Throws:

IOException - thrown for any deserialization errors