Package org.azd.abstractions.internals

Class ClientRequestAdapter

java.lang.Object

org.azd.http.ClientRequest

org.azd.abstractions.internals.ClientRequestAdapter

public final class ClientRequestAdapter
extends ClientRequest

Implementation of the ClientRequest that executes or sends the request to Azure DevOps API.

Nested Class Summary

Nested classes/interfaces inherited from class org.azd.http.ClientRequest

ClientRequest.Builder

Constructor Summary

Constructors

Constructor	Description
ClientRequestAdapter(ClientRequestBuilder builder)	Default.

Method Summary

Modifier and Type	Method	Description
AccessTokenCredential	accessTokenCredential()	Returns the access token credential object.
<T extends SerializableEntity> T	execute(Class<T> model)	Executes the request and returns the deserialized response.
<T extends SerializableEntity> CompletableFuture<T>	executeAsync(Class<T> model)	Executes the request and returns the deserialized response.
Void	executePrimitive()	Executes the request and doesn't return any response.
CompletableFuture<Void>	executePrimitiveAsync()	Executes the request and doesn't return any response.
InputStream	executeStream()	Executes the request and returns the stream response from API.
CompletableFuture<InputStream>	executeStreamAsync()	Executes the request and returns the stream response from API.
String	executeString()	Executes the raw request without serialization.
CompletableFuture<String>	executeStringAsync()	Executes the raw request without serialization.
RequestInformation	request()	Return the request information object.

Methods inherited from class org.azd.http.ClientRequest

builder, builder

Methods inherited from class java.lang.Object

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

Constructor Details

ClientRequestAdapter

public ClientRequestAdapter(ClientRequestBuilder builder)

Default.

Parameters:

builder - Client request builder object.

Method Details

executeStringAsync

public CompletableFuture<String> executeStringAsync()
                                             throws AzDException

Executes the raw request without serialization.

Specified by:

executeStringAsync in class ClientRequest

Returns:

String response from API.

Throws:

AzDException - Default API exception handler.

executeAsync

public <T extends SerializableEntity>
CompletableFuture<T> executeAsync(Class<T> model)
                           throws AzDException

Executes the request and returns the deserialized response.

Specified by:

executeAsync in class ClientRequest

Type Parameters:

T - Represents model.

Parameters:

model - Represents the entity or model for which the response should be deserialized to.

Returns:

Deserialized response from API.

Throws:

AzDException - Default API exception handler.

executeStreamAsync

public CompletableFuture<InputStream> executeStreamAsync()
                                                  throws AzDException

Executes the request and returns the stream response from API.

Specified by:

executeStreamAsync in class ClientRequest

Returns:

Stream response. InputStream

Throws:

AzDException - Default API exception handler.

executePrimitiveAsync

public CompletableFuture<Void> executePrimitiveAsync()
                                              throws AzDException

Executes the request and doesn't return any response. Useful for DELETE operations.

Specified by:

executePrimitiveAsync in class ClientRequest

Returns:

Void.

Throws:

AzDException - Default API exception handler.

execute

public <T extends SerializableEntity> T execute(Class<T> model)
                                         throws AzDException

Executes the request and returns the deserialized response.

Specified by:

execute in class ClientRequest

Type Parameters:

T - Represents model.

Parameters:

model - Represents the entity or model for which the response should be deserialized to.

Returns:

Deserialized response from API.

Throws:

AzDException - Default API exception handler.

executeString

public String executeString()
                     throws AzDException

Executes the raw request without serialization.

Specified by:

executeString in class ClientRequest

Returns:

String response from API.

Throws:

AzDException - Default API exception handler.

executeStream

public InputStream executeStream()
                          throws AzDException

Executes the request and returns the stream response from API.

Specified by:

executeStream in class ClientRequest

Returns:

Stream response. InputStream

Throws:

AzDException - Default API exception handler.

executePrimitive

public Void executePrimitive()
                      throws AzDException

Executes the request and doesn't return any response. Useful for DELETE operations.

Specified by:

executePrimitive in class ClientRequest

Returns:

Void.

Throws:

AzDException - Default API exception handler.

request

public RequestInformation request()

Return the request information object.

Specified by:

request in class ClientRequest

Returns:

RequestInformation RequestInformation

accessTokenCredential

public AccessTokenCredential accessTokenCredential()

Returns the access token credential object.

Specified by:

accessTokenCredential in class ClientRequest

Returns:

AccessTokenCredential AccessTokenCredential