javax.ws.rs.client
Interface AsyncInvoker


public interface AsyncInvoker

Uniform interface for asynchronous invocation of HTTP methods.

Since:
2.0
Author:
Marek Potociar

Method Summary
 java.util.concurrent.Future<Response> delete()
          Invoke HTTP DELETE method for the current request asynchronously.
<T> java.util.concurrent.Future<T>
delete(java.lang.Class<T> responseType)
          Invoke HTTP DELETE method for the current request asynchronously.
<T> java.util.concurrent.Future<T>
delete(GenericType<T> responseType)
          Invoke HTTP DELETE method for the current request asynchronously.
<T> java.util.concurrent.Future<T>
delete(InvocationCallback<T> callback)
          Invoke HTTP DELETE method for the current request asynchronously.
 java.util.concurrent.Future<Response> get()
          Invoke HTTP GET method for the current request asynchronously.
<T> java.util.concurrent.Future<T>
get(java.lang.Class<T> responseType)
          Invoke HTTP GET method for the current request asynchronously.
<T> java.util.concurrent.Future<T>
get(GenericType<T> responseType)
          Invoke HTTP GET method for the current request asynchronously.
<T> java.util.concurrent.Future<T>
get(InvocationCallback<T> callback)
          Invoke HTTP GET method for the current request asynchronously.
 java.util.concurrent.Future<Response> head()
          Invoke HTTP HEAD method for the current request asynchronously.
 java.util.concurrent.Future<Response> head(InvocationCallback<Response> callback)
          Invoke HTTP HEAD method for the current request asynchronously.
 java.util.concurrent.Future<Response> method(java.lang.String name)
          Invoke an arbitrary method for the current request asynchronously.
<T> java.util.concurrent.Future<T>
method(java.lang.String name, java.lang.Class<T> responseType)
          Invoke an arbitrary method for the current request asynchronously.
 java.util.concurrent.Future<Response> method(java.lang.String name, Entity<?> entity)
          Invoke an arbitrary method for the current request asynchronously.
<T> java.util.concurrent.Future<T>
method(java.lang.String name, Entity<?> entity, java.lang.Class<T> responseType)
          Invoke an arbitrary method for the current request asynchronously.
<T> java.util.concurrent.Future<T>
method(java.lang.String name, Entity<?> entity, GenericType<T> responseType)
          Invoke an arbitrary method for the current request asynchronously.
<T> java.util.concurrent.Future<T>
method(java.lang.String name, Entity<?> entity, InvocationCallback<T> callback)
          Invoke an arbitrary method for the current request asynchronously.
<T> java.util.concurrent.Future<T>
method(java.lang.String name, GenericType<T> responseType)
          Invoke an arbitrary method for the current request asynchronously.
<T> java.util.concurrent.Future<T>
method(java.lang.String name, InvocationCallback<T> callback)
          Invoke an arbitrary method for the current request asynchronously.
 java.util.concurrent.Future<Response> options()
          Invoke HTTP OPTIONS method for the current request asynchronously.
<T> java.util.concurrent.Future<T>
options(java.lang.Class<T> responseType)
          Invoke HTTP OPTIONS method for the current request asynchronously.
<T> java.util.concurrent.Future<T>
options(GenericType<T> responseType)
          Invoke HTTP OPTIONS method for the current request asynchronously.
<T> java.util.concurrent.Future<T>
options(InvocationCallback<T> callback)
          Invoke HTTP OPTIONS method for the current request asynchronously.
 java.util.concurrent.Future<Response> post(Entity<?> entity)
          Invoke HTTP POST method for the current request asynchronously.
<T> java.util.concurrent.Future<T>
post(Entity<?> entity, java.lang.Class<T> responseType)
          Invoke HTTP POST method for the current request asynchronously.
<T> java.util.concurrent.Future<T>
post(Entity<?> entity, GenericType<T> responseType)
          Invoke HTTP POST method for the current request asynchronously.
<T> java.util.concurrent.Future<T>
post(Entity<?> entity, InvocationCallback<T> callback)
          Invoke HTTP POST method for the current request asynchronously.
 java.util.concurrent.Future<Response> put(Entity<?> entity)
          Invoke HTTP PUT method for the current request asynchronously.
<T> java.util.concurrent.Future<T>
put(Entity<?> entity, java.lang.Class<T> responseType)
          Invoke HTTP PUT method for the current request asynchronously.
<T> java.util.concurrent.Future<T>
put(Entity<?> entity, GenericType<T> responseType)
          Invoke HTTP PUT method for the current request asynchronously.
<T> java.util.concurrent.Future<T>
put(Entity<?> entity, InvocationCallback<T> callback)
          Invoke HTTP PUT method for the current request asynchronously.
 java.util.concurrent.Future<Response> trace()
          Invoke HTTP TRACE method for the current request asynchronously.
<T> java.util.concurrent.Future<T>
trace(java.lang.Class<T> responseType)
          Invoke HTTP TRACE method for the current request asynchronously.
<T> java.util.concurrent.Future<T>
trace(GenericType<T> responseType)
          Invoke HTTP TRACE method for the current request asynchronously.
<T> java.util.concurrent.Future<T>
trace(InvocationCallback<T> callback)
          Invoke HTTP TRACE method for the current request asynchronously.
 

Method Detail

get

java.util.concurrent.Future<Response> get()
Invoke HTTP GET method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps an ClientException thrown in case of an invocation processing failure.

Returns:
invocation response future.

get

<T> java.util.concurrent.Future<T> get(java.lang.Class<T> responseType)
Invoke HTTP GET method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps either an ClientException thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses thrown in case the received response status code is not successful and the specified response type is not Response.

Type Parameters:
T - response entity type.
Parameters:
responseType - Java type the response entity will be converted to.
Returns:
invocation response future.

get

<T> java.util.concurrent.Future<T> get(GenericType<T> responseType)
Invoke HTTP GET method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps either an ClientException thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses thrown in case the received response status code is not successful and the specified response type is not Response.

Type Parameters:
T - generic response entity type.
Parameters:
responseType - representation of a generic Java type the response entity will be converted to.
Returns:
invocation response future.

get

<T> java.util.concurrent.Future<T> get(InvocationCallback<T> callback)
Invoke HTTP GET method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps either an ClientException thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses thrown in case the received response status code is not successful and the generic type of the supplied response callback is not Response.

Type Parameters:
T - generic response entity type.
Parameters:
callback - asynchronous invocation callback.
Returns:
invocation response future.

put

java.util.concurrent.Future<Response> put(Entity<?> entity)
Invoke HTTP PUT method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps an ClientException thrown in case of an invocation processing failure.

Parameters:
entity - request entity.
Returns:
invocation response future.

put

<T> java.util.concurrent.Future<T> put(Entity<?> entity,
                                       java.lang.Class<T> responseType)
Invoke HTTP PUT method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps either an ClientException thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses thrown in case the received response status code is not successful and the specified response type is not Response.

Type Parameters:
T - response entity type.
Parameters:
entity - request entity.
responseType - Java type the response entity will be converted to.
Returns:
invocation response future.

put

<T> java.util.concurrent.Future<T> put(Entity<?> entity,
                                       GenericType<T> responseType)
Invoke HTTP PUT method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps either an ClientException thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses thrown in case the received response status code is not successful and the specified response type is not Response.

Type Parameters:
T - generic response entity type.
Parameters:
entity - request entity.
responseType - representation of a generic Java type the response entity will be converted to.
Returns:
invocation response future.

put

<T> java.util.concurrent.Future<T> put(Entity<?> entity,
                                       InvocationCallback<T> callback)
Invoke HTTP PUT method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps either an ClientException thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses thrown in case the received response status code is not successful and the generic type of the supplied response callback is not Response.

Type Parameters:
T - generic response entity type.
Parameters:
entity - request entity.
callback - asynchronous invocation callback.
Returns:
invocation response future.

post

java.util.concurrent.Future<Response> post(Entity<?> entity)
Invoke HTTP POST method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps an ClientException thrown in case of an invocation processing failure.

Parameters:
entity - request entity.
Returns:
invocation response future.
Throws:
ClientException - in case the invocation processing has failed.

post

<T> java.util.concurrent.Future<T> post(Entity<?> entity,
                                        java.lang.Class<T> responseType)
Invoke HTTP POST method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps either an ClientException thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses thrown in case the received response status code is not successful and the specified response type is not Response.

Type Parameters:
T - response entity type.
Parameters:
entity - request entity.
responseType - Java type the response entity will be converted to.
Returns:
invocation response future.

post

<T> java.util.concurrent.Future<T> post(Entity<?> entity,
                                        GenericType<T> responseType)
Invoke HTTP POST method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps either an ClientException thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses thrown in case the received response status code is not successful and the specified response type is not Response.

Type Parameters:
T - generic response entity type.
Parameters:
entity - request entity.
responseType - representation of a generic Java type the response entity will be converted to.
Returns:
invocation response future.

post

<T> java.util.concurrent.Future<T> post(Entity<?> entity,
                                        InvocationCallback<T> callback)
Invoke HTTP POST method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps either an ClientException thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses thrown in case the received response status code is not successful and the generic type of the supplied response callback is not Response.

Type Parameters:
T - generic response entity type.
Parameters:
entity - request entity.
callback - asynchronous invocation callback.
Returns:
invocation response future.

delete

java.util.concurrent.Future<Response> delete()
Invoke HTTP DELETE method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps an ClientException thrown in case of an invocation processing failure.

Returns:
invocation response future.

delete

<T> java.util.concurrent.Future<T> delete(java.lang.Class<T> responseType)
Invoke HTTP DELETE method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps either an ClientException thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses thrown in case the received response status code is not successful and the specified response type is not Response.

Type Parameters:
T - response entity type.
Parameters:
responseType - Java type the response entity will be converted to.
Returns:
invocation response future.

delete

<T> java.util.concurrent.Future<T> delete(GenericType<T> responseType)
Invoke HTTP DELETE method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps either an ClientException thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses thrown in case the received response status code is not successful and the specified response type is not Response.

Type Parameters:
T - generic response entity type.
Parameters:
responseType - representation of a generic Java type the response entity will be converted to.
Returns:
invocation response future.

delete

<T> java.util.concurrent.Future<T> delete(InvocationCallback<T> callback)
Invoke HTTP DELETE method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps either an ClientException thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses thrown in case the received response status code is not successful and the generic type of the supplied response callback is not Response.

Type Parameters:
T - generic response entity type.
Parameters:
callback - asynchronous invocation callback.
Returns:
invocation response future.

head

java.util.concurrent.Future<Response> head()
Invoke HTTP HEAD method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps an ClientException thrown in case of an invocation processing failure.

Returns:
invocation response future.

head

java.util.concurrent.Future<Response> head(InvocationCallback<Response> callback)
Invoke HTTP HEAD method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps an ClientException thrown in case of an invocation processing failure.

Parameters:
callback - asynchronous invocation callback.
Returns:
invocation response future.

options

java.util.concurrent.Future<Response> options()
Invoke HTTP OPTIONS method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps an ClientException thrown in case of an invocation processing failure.

Returns:
invocation response future.

options

<T> java.util.concurrent.Future<T> options(java.lang.Class<T> responseType)
Invoke HTTP OPTIONS method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps either an ClientException thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses thrown in case the received response status code is not successful and the specified response type is not Response.

Type Parameters:
T - response entity type.
Parameters:
responseType - Java type the response entity will be converted to.
Returns:
invocation response future.

options

<T> java.util.concurrent.Future<T> options(GenericType<T> responseType)
Invoke HTTP OPTIONS method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps either an ClientException thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses thrown in case the received response status code is not successful and the specified response type is not Response.

Type Parameters:
T - generic response entity type.
Parameters:
responseType - representation of a generic Java type the response entity will be converted to.
Returns:
invocation response future.

options

<T> java.util.concurrent.Future<T> options(InvocationCallback<T> callback)
Invoke HTTP OPTIONS method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps either an ClientException thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses thrown in case the received response status code is not successful and the generic type of the supplied response callback is not Response.

Type Parameters:
T - generic response entity type.
Parameters:
callback - asynchronous invocation callback.
Returns:
invocation response future.

trace

java.util.concurrent.Future<Response> trace()
Invoke HTTP TRACE method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps an ClientException thrown in case of an invocation processing failure.

Returns:
invocation response future.

trace

<T> java.util.concurrent.Future<T> trace(java.lang.Class<T> responseType)
Invoke HTTP TRACE method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps either an ClientException thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses thrown in case the received response status code is not successful and the specified response type is not Response.

Type Parameters:
T - response entity type.
Parameters:
responseType - Java type the response entity will be converted to.
Returns:
invocation response future.

trace

<T> java.util.concurrent.Future<T> trace(GenericType<T> responseType)
Invoke HTTP TRACE method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps either an ClientException thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses thrown in case the received response status code is not successful and the specified response type is not Response.

Type Parameters:
T - generic response entity type.
Parameters:
responseType - representation of a generic Java type the response entity will be converted to.
Returns:
invocation response future.

trace

<T> java.util.concurrent.Future<T> trace(InvocationCallback<T> callback)
Invoke HTTP TRACE method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps either an ClientException thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses thrown in case the received response status code is not successful and the generic type of the supplied response callback is not Response.

Type Parameters:
T - generic response entity type.
Parameters:
callback - asynchronous invocation callback.
Returns:
invocation response future.

method

java.util.concurrent.Future<Response> method(java.lang.String name)
Invoke an arbitrary method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps an ClientException thrown in case of an invocation processing failure.

Parameters:
name - method name.
Returns:
invocation response future.

method

<T> java.util.concurrent.Future<T> method(java.lang.String name,
                                          java.lang.Class<T> responseType)
Invoke an arbitrary method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps either an ClientException thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses thrown in case the received response status code is not successful and the specified response type is not Response.

Type Parameters:
T - response entity type.
Parameters:
name - method name.
responseType - Java type the response entity will be converted to.
Returns:
invocation response future.

method

<T> java.util.concurrent.Future<T> method(java.lang.String name,
                                          GenericType<T> responseType)
Invoke an arbitrary method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps either an ClientException thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses thrown in case the received response status code is not successful and the specified response type is not Response.

Type Parameters:
T - generic response entity type.
Parameters:
name - method name.
responseType - representation of a generic Java type the response entity will be converted to.
Returns:
invocation response future.

method

<T> java.util.concurrent.Future<T> method(java.lang.String name,
                                          InvocationCallback<T> callback)
Invoke an arbitrary method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps either an ClientException thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses thrown in case the received response status code is not successful and the generic type of the supplied response callback is not Response.

Type Parameters:
T - generic response entity type.
Parameters:
name - method name.
callback - asynchronous invocation callback.
Returns:
invocation response future.

method

java.util.concurrent.Future<Response> method(java.lang.String name,
                                             Entity<?> entity)
Invoke an arbitrary method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps an ClientException thrown in case of an invocation processing failure.

Parameters:
name - method name.
entity - request entity.
Returns:
invocation response future.

method

<T> java.util.concurrent.Future<T> method(java.lang.String name,
                                          Entity<?> entity,
                                          java.lang.Class<T> responseType)
Invoke an arbitrary method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps either an ClientException thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses thrown in case the received response status code is not successful and the specified response type is not Response.

Type Parameters:
T - response entity type.
Parameters:
name - method name.
entity - request entity.
responseType - Java type the response entity will be converted to.
Returns:
invocation response future.

method

<T> java.util.concurrent.Future<T> method(java.lang.String name,
                                          Entity<?> entity,
                                          GenericType<T> responseType)
Invoke an arbitrary method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps either an ClientException thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses thrown in case the received response status code is not successful and the specified response type is not Response.

Type Parameters:
T - generic response entity type.
Parameters:
name - method name.
entity - request entity.
responseType - representation of a generic Java type the response entity will be converted to.
Returns:
invocation response future.

method

<T> java.util.concurrent.Future<T> method(java.lang.String name,
                                          Entity<?> entity,
                                          InvocationCallback<T> callback)
Invoke an arbitrary method for the current request asynchronously.

Note that calling the Future.get() method on the returned Future instance may throw an ExecutionException that wraps either an ClientException thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses thrown in case the received response status code is not successful and the generic type of the supplied response callback is not Response.

Type Parameters:
T - generic response entity type.
Parameters:
name - method name.
entity - request entity.
callback - asynchronous invocation callback.
Returns:
invocation response future.


Copyright © 2007-2012 Oracle Corporation. All Rights Reserved. Use is subject to license terms.