Class DefaultApiInvocation<T>

java.lang.Object

de.xima.fc.api.rest.pub.client.user_portal.DefaultApiInvocation<T>

Type Parameters:

T - Type of the response.

All Implemented Interfaces:

ApiInvocation<T>

@Generated("de.xima.openapi.codegen.java_jaxrs.XimaJavaJaxrsGenerator")
public final class DefaultApiInvocation<T>
extends Object
implements ApiInvocation<T>

Default implementation of a ApiInvocation which simply delegates to the ApiClient.

Constructor Summary

Constructors

Constructor	Description
DefaultApiInvocation(ApiClient apiClient, ApiCall<?> call)	Creates a new wrapper for an API call to provide multiple dispatch styles.

Method Summary

Modifier and Type	Method	Description
Future<ApiResponse<T>>	async()	Invokes the request asynchronously via the AsyncInvoker, without a callback.
Future<ApiResponse<T>>	async(javax.ws.rs.client.InvocationCallback<ApiResponse<T>> invocationCallback)	Invokes the request asynchronously via the AsyncInvoker, with a callback.
ApiResponse<T>	invoke()	Invokes the request synchronously via Invocation.invoke().
CompletionStage<ApiResponse<T>>	rx()	Invokes the request asynchronously via the CompletionStageRxInvoker.

Methods inherited from class Object

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

Constructor Details

DefaultApiInvocation

public DefaultApiInvocation(ApiClient apiClient,
 ApiCall<?> call)

Creates a new wrapper for an API call to provide multiple dispatch styles.

Parameters:

apiClient - API client to which to delegate the request's execution.

call - API call to execute.

Method Details

async

public Future<ApiResponse<T>> async()

Description copied from interface: ApiInvocation

Invokes the request asynchronously via the AsyncInvoker, without a callback.

Specified by:

async in interface ApiInvocation<T>

Returns:

A future for the result obtained from the response.

See Also:

• Invocation.submit()

async

public Future<ApiResponse<T>> async(javax.ws.rs.client.InvocationCallback<ApiResponse<T>> invocationCallback)

Description copied from interface: ApiInvocation

Invokes the request asynchronously via the AsyncInvoker, with a callback. Note: You can use the future to wait until the request finishes, but you should not access the response via the future -- use the callback to access the response.

Specified by:

async in interface ApiInvocation<T>

Parameters:

invocationCallback - Callback which is invoked with the result of the response.

Returns:

A future for the result obtained from the response.

See Also:

• Invocation.submit(InvocationCallback)

invoke

public ApiResponse<T> invoke()
                      throws ApiException

Description copied from interface: ApiInvocation

Invokes the request synchronously via Invocation.invoke().

Specified by:

invoke in interface ApiInvocation<T>

Returns:

The result obtained from the response.

Throws:

ApiException - When the request could not be executed, e.g. when the server could not be reached or the server sent an invalid response. No exception is thrown if the server simply sends a 4xx or 5xx status code and that status code was defined in the API specification.

See Also:

• Invocation.invoke()

rx

public CompletionStage<ApiResponse<T>> rx()

Description copied from interface: ApiInvocation

Invokes the request asynchronously via the CompletionStageRxInvoker.

Specified by:

rx in interface ApiInvocation<T>

Returns:

A pending stage for the result obtained from the response