com.microsoft.rest.v2

Class RestProxy

java.lang.Object

com.microsoft.rest.v2.RestProxy

All Implemented Interfaces:

InvocationHandler

public class RestProxy
extends Object
implements InvocationHandler

This class can be used to create a proxy implementation for a provided Swagger generated interface. RestProxy can create proxy implementations for interfaces with methods that return deserialized Java objects as well as asynchronous Single objects that resolve to a deserialized Java object.

Constructor Summary

Constructors

Constructor and Description
RestProxy(HttpPipeline httpPipeline, SerializerAdapter<?> serializer, SwaggerInterfaceParser interfaceParser) Create a new instance of RestProxy.

Method Summary

Modifier and Type	Method and Description
static <A> A	create(Class<A> swaggerInterface) Create a proxy implementation of the provided Swagger interface.
static <A> A	create(Class<A> swaggerInterface, HttpPipeline httpPipeline) Create a proxy implementation of the provided Swagger interface.
static <A> A	create(Class<A> swaggerInterface, HttpPipeline httpPipeline, SerializerAdapter<?> serializer) Create a proxy implementation of the provided Swagger interface.
static <A> A	create(Class<A> swaggerInterface, ServiceClient serviceClient) Create a proxy implementation of the provided Swagger interface.
static HttpPipeline	createDefaultPipeline() Create the default HttpPipeline.
static HttpPipeline	createDefaultPipeline(RequestPolicyFactory credentialsPolicy) Create the default HttpPipeline.
static HttpPipeline	createDefaultPipeline(ServiceClientCredentials credentials) Create the default HttpPipeline.
static SerializerAdapter<?>	createDefaultSerializer() Create an instance of the default serializer.
io.reactivex.Single<HttpResponse>	ensureExpectedStatus(HttpResponse response, SwaggerMethodParser methodParser, int[] additionalAllowedStatusCodes) Ensure that the provided HttpResponse has a status code that is defined in the provided SwaggerMethodParser or is in the int[] of additional allowed status codes.
Constructor<? extends RestResponse<?,?>>	getRestResponseConstructor(Type entityType)
protected Object	handleAsyncHttpResponse(HttpRequest httpRequest, io.reactivex.Single<HttpResponse> asyncHttpResponse, SwaggerMethodParser methodParser, Type returnType)
protected io.reactivex.Maybe<?>	handleBodyReturnTypeAsync(HttpResponse response, SwaggerMethodParser methodParser, Type entityType)
Object	handleRestReturnType(HttpRequest httpRequest, io.reactivex.Single<HttpResponse> asyncHttpResponse, SwaggerMethodParser methodParser, Type returnType) Handle the provided asynchronous HTTP response and return the deserialized value.
protected Object	handleResumeOperation(HttpRequest httpRequest, OperationDescription operationDescription, SwaggerMethodParser methodParser, Type returnType)
Object	invoke(Object proxy, Method method, Object[] args)
io.reactivex.Single<HttpResponse>	sendHttpRequestAsync(HttpRequest request) Send the provided request asynchronously, applying any request policies provided to the HttpClient instance.
SerializerAdapter<?>	serializer() Get the SerializerAdapter used by this RestProxy.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestProxy

public RestProxy(HttpPipeline httpPipeline,
                 SerializerAdapter<?> serializer,
                 SwaggerInterfaceParser interfaceParser)

Create a new instance of RestProxy.

Parameters:

httpPipeline - The RequestPolicy and HttpClient httpPipeline that will be used to send HTTP requests.

serializer - The serializer that will be used to convert response bodies to POJOs.

interfaceParser - The parser that contains information about the swagger interface that this RestProxy "implements".

Method Detail

serializer

public SerializerAdapter<?> serializer()

Get the SerializerAdapter used by this RestProxy.

Returns:

The SerializerAdapter used by this RestProxy.

sendHttpRequestAsync

public io.reactivex.Single<HttpResponse> sendHttpRequestAsync(HttpRequest request)

Send the provided request asynchronously, applying any request policies provided to the HttpClient instance.

Parameters:

request - The HTTP request to send.

Returns:

A Single representing the HTTP response that will arrive asynchronously.

invoke

public Object invoke(Object proxy,
                     Method method,
                     Object[] args)

Specified by:

invoke in interface InvocationHandler

ensureExpectedStatus

public io.reactivex.Single<HttpResponse> ensureExpectedStatus(HttpResponse response,
                                                              SwaggerMethodParser methodParser,
                                                              int[] additionalAllowedStatusCodes)

Ensure that the provided HttpResponse has a status code that is defined in the provided SwaggerMethodParser or is in the int[] of additional allowed status codes. If the HttpResponse's status code is not allowed, then an exception will be thrown.

Parameters:

response - The HttpResponse to check.

methodParser - The method parser that contains information about the service interface method that initiated the HTTP request.

additionalAllowedStatusCodes - Additional allowed status codes that are permitted based on the context of the HTTP request.

Returns:

An async-version of the provided HttpResponse.

getRestResponseConstructor

public Constructor<? extends RestResponse<?,?>> getRestResponseConstructor(Type entityType)

Parameters:

entityType - the RestResponse subtype to get a constructor for.

Returns:

a Constructor which produces an instance of a RestResponse subtype.

handleBodyReturnTypeAsync

protected final io.reactivex.Maybe<?> handleBodyReturnTypeAsync(HttpResponse response,
                                                                SwaggerMethodParser methodParser,
                                                                Type entityType)

handleAsyncHttpResponse

protected Object handleAsyncHttpResponse(HttpRequest httpRequest,
                                         io.reactivex.Single<HttpResponse> asyncHttpResponse,
                                         SwaggerMethodParser methodParser,
                                         Type returnType)

handleResumeOperation

protected Object handleResumeOperation(HttpRequest httpRequest,
                                       OperationDescription operationDescription,
                                       SwaggerMethodParser methodParser,
                                       Type returnType)
                                throws Exception

Throws:

Exception

handleRestReturnType

public final Object handleRestReturnType(HttpRequest httpRequest,
                                         io.reactivex.Single<HttpResponse> asyncHttpResponse,
                                         SwaggerMethodParser methodParser,
                                         Type returnType)

Handle the provided asynchronous HTTP response and return the deserialized value.

Parameters:

httpRequest - The original HTTP request.

asyncHttpResponse - The asynchronous HTTP response to the original HTTP request.

methodParser - The SwaggerMethodParser that the request originates from.

returnType - The type of value that will be returned.

Returns:

The deserialized result.

createDefaultSerializer

public static SerializerAdapter<?> createDefaultSerializer()

Create an instance of the default serializer.

Returns:

the default serializer.

createDefaultPipeline

public static HttpPipeline createDefaultPipeline()

Create the default HttpPipeline.

Returns:

the default HttpPipeline.

createDefaultPipeline

public static HttpPipeline createDefaultPipeline(ServiceClientCredentials credentials)

Create the default HttpPipeline.

Parameters:

credentials - The credentials to use to apply authentication to the pipeline.

Returns:

the default HttpPipeline.

createDefaultPipeline

public static HttpPipeline createDefaultPipeline(RequestPolicyFactory credentialsPolicy)

Create the default HttpPipeline.

Parameters:

credentialsPolicy - The credentials policy factory to use to apply authentication to the pipeline.

Returns:

the default HttpPipeline.

create

public static <A> A create(Class<A> swaggerInterface)

Create a proxy implementation of the provided Swagger interface.

Type Parameters:

A - The type of the Swagger interface.

Parameters:

swaggerInterface - The Swagger interface to provide a proxy implementation for.

Returns:

A proxy implementation of the provided Swagger interface.

create

public static <A> A create(Class<A> swaggerInterface,
                           HttpPipeline httpPipeline)

Create a proxy implementation of the provided Swagger interface.

Type Parameters:

A - The type of the Swagger interface.

Parameters:

swaggerInterface - The Swagger interface to provide a proxy implementation for.

httpPipeline - The RequestPolicy and HttpClient pipline that will be used to send Http requests.

Returns:

A proxy implementation of the provided Swagger interface.

create

public static <A> A create(Class<A> swaggerInterface,
                           ServiceClient serviceClient)

Create a proxy implementation of the provided Swagger interface.

Type Parameters:

A - The type of the Swagger interface.

Parameters:

swaggerInterface - The Swagger interface to provide a proxy implementation for.

serviceClient - The ServiceClient that contains the details to use to create the RestProxy implementation of the swagger interface.

Returns:

A proxy implementation of the provided Swagger interface.

create

public static <A> A create(Class<A> swaggerInterface,
                           HttpPipeline httpPipeline,
                           SerializerAdapter<?> serializer)

Create a proxy implementation of the provided Swagger interface.

Type Parameters:

A - The type of the Swagger interface.

Parameters:

swaggerInterface - The Swagger interface to provide a proxy implementation for.

httpPipeline - The RequestPolicy and HttpClient pipline that will be used to send Http requests.

serializer - The serializer that will be used to convert POJOs to and from request and response bodies.

Returns:

A proxy implementation of the provided Swagger interface.