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(Entity<?> entity) Invoke HTTP TRACE method for the current request asynchronously.
<T> java.util.concurrent.Future<T>	trace(Entity<?> entity, java.lang.Class<T> responseType) Invoke HTTP TRACE method for the current request asynchronously.
<T> java.util.concurrent.Future<T>	trace(Entity<?> entity, GenericType<T> responseType) Invoke HTTP TRACE method for the current request asynchronously.
<T> java.util.concurrent.Future<T>	trace(Entity<?> entity, InvocationCallback<T> callback) Invoke HTTP TRACE method for the current request asynchronously.

Method Detail

get

java.util.concurrent.Future<Response> get()
                                          throws InvocationException

Invoke HTTP GET method for the current request asynchronously.

Returns:

invocation response future.

Throws:

InvocationException - in case the invocation failed.

get

<T> java.util.concurrent.Future<T> get(java.lang.Class<T> responseType)
                                   throws InvocationException

Invoke HTTP GET method for the current request asynchronously.

Type Parameters:

T - response entity type.

Parameters:

responseType - Java type the response entity will be converted to.

Returns:

invocation response future.

Throws:

InvocationException - in case the invocation failed.

get

<T> java.util.concurrent.Future<T> get(GenericType<T> responseType)
                                   throws InvocationException

Invoke HTTP GET method for the current request asynchronously.

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.

Throws:

InvocationException - in case the invocation failed.

get

<T> java.util.concurrent.Future<T> get(InvocationCallback<T> callback)

Invoke HTTP GET method for the current request asynchronously.

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)
                                          throws InvocationException

Invoke HTTP PUT method for the current request asynchronously.

Parameters:

entity - request entity.

Returns:

invocation response future.

Throws:

InvocationException - in case the invocation failed.

put

<T> java.util.concurrent.Future<T> put(Entity<?> entity,
                                       java.lang.Class<T> responseType)
                                   throws InvocationException

Invoke HTTP PUT method for the current request asynchronously.

Type Parameters:

T - response entity type.

Parameters:

entity - request entity.

responseType - Java type the response entity will be converted to.

Returns:

invocation response future.

Throws:

InvocationException - in case the invocation failed.

put

<T> java.util.concurrent.Future<T> put(Entity<?> entity,
                                       GenericType<T> responseType)
                                   throws InvocationException

Invoke HTTP PUT method for the current request asynchronously.

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.

Throws:

InvocationException - in case the invocation failed.

put

<T> java.util.concurrent.Future<T> put(Entity<?> entity,
                                       InvocationCallback<T> callback)

Invoke HTTP PUT method for the current request asynchronously.

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)
                                           throws InvocationException

Invoke HTTP POST method for the current request asynchronously.

Parameters:

entity - request entity.

Returns:

invocation response future.

Throws:

InvocationException - in case the invocation failed.

post

<T> java.util.concurrent.Future<T> post(Entity<?> entity,
                                        java.lang.Class<T> responseType)
                                    throws InvocationException

Invoke HTTP POST method for the current request asynchronously.

Type Parameters:

T - response entity type.

Parameters:

entity - request entity.

responseType - Java type the response entity will be converted to.

Returns:

invocation response future.

Throws:

InvocationException - in case the invocation failed.

post

<T> java.util.concurrent.Future<T> post(Entity<?> entity,
                                        GenericType<T> responseType)
                                    throws InvocationException

Invoke HTTP POST method for the current request asynchronously.

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.

Throws:

InvocationException - in case the invocation failed.

post

<T> java.util.concurrent.Future<T> post(Entity<?> entity,
                                        InvocationCallback<T> callback)

Invoke HTTP POST method for the current request asynchronously.

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()
                                             throws InvocationException

Invoke HTTP DELETE method for the current request asynchronously.

Returns:

invocation response future.

Throws:

InvocationException - in case the invocation failed.

delete

<T> java.util.concurrent.Future<T> delete(java.lang.Class<T> responseType)
                                      throws InvocationException

Invoke HTTP DELETE method for the current request asynchronously.

Type Parameters:

T - response entity type.

Parameters:

responseType - Java type the response entity will be converted to.

Returns:

invocation response future.

Throws:

InvocationException - in case the invocation failed.

delete

<T> java.util.concurrent.Future<T> delete(GenericType<T> responseType)
                                      throws InvocationException

Invoke HTTP DELETE method for the current request asynchronously.

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.

Throws:

InvocationException - in case the invocation failed.

delete

<T> java.util.concurrent.Future<T> delete(InvocationCallback<T> callback)

Invoke HTTP DELETE method for the current request asynchronously.

Type Parameters:

T - generic response entity type.

Parameters:

callback - asynchronous invocation callback.

Returns:

invocation response future.

head

java.util.concurrent.Future<Response> head()
                                           throws InvocationException

Invoke HTTP HEAD method for the current request asynchronously.

Returns:

invocation response future.

Throws:

InvocationException - in case the invocation failed.

head

java.util.concurrent.Future<Response> head(InvocationCallback<Response> callback)

Invoke HTTP HEAD method for the current request asynchronously.

Parameters:

callback - asynchronous invocation callback.

Returns:

invocation response future.

options

java.util.concurrent.Future<Response> options()
                                              throws InvocationException

Invoke HTTP OPTIONS method for the current request asynchronously.

Returns:

invocation response future.

Throws:

InvocationException - in case the invocation failed.

options

<T> java.util.concurrent.Future<T> options(java.lang.Class<T> responseType)
                                       throws InvocationException

Invoke HTTP OPTIONS method for the current request asynchronously.

Type Parameters:

T - response entity type.

Parameters:

responseType - Java type the response entity will be converted to.

Returns:

invocation response future.

Throws:

InvocationException - in case the invocation failed.

options

<T> java.util.concurrent.Future<T> options(GenericType<T> responseType)
                                       throws InvocationException

Invoke HTTP OPTIONS method for the current request asynchronously.

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.

Throws:

InvocationException - in case the invocation failed.

options

<T> java.util.concurrent.Future<T> options(InvocationCallback<T> callback)

Invoke HTTP OPTIONS method for the current request asynchronously.

Type Parameters:

T - generic response entity type.

Parameters:

callback - asynchronous invocation callback.

Returns:

invocation response future.

trace

java.util.concurrent.Future<Response> trace(Entity<?> entity)
                                            throws InvocationException

Invoke HTTP TRACE method for the current request asynchronously.

Parameters:

entity - request entity.

Returns:

invocation response future.

Throws:

InvocationException - in case the invocation failed.

trace

<T> java.util.concurrent.Future<T> trace(Entity<?> entity,
                                         java.lang.Class<T> responseType)
                                     throws InvocationException

Invoke HTTP TRACE method for the current request asynchronously.

Type Parameters:

T - response entity type.

Parameters:

entity - request entity.

responseType - Java type the response entity will be converted to.

Returns:

invocation response future.

Throws:

InvocationException - in case the invocation failed.

trace

<T> java.util.concurrent.Future<T> trace(Entity<?> entity,
                                         GenericType<T> responseType)
                                     throws InvocationException

Invoke HTTP TRACE method for the current request asynchronously.

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.

Throws:

InvocationException - in case the invocation failed.

trace

<T> java.util.concurrent.Future<T> trace(Entity<?> entity,
                                         InvocationCallback<T> callback)

Invoke HTTP TRACE method for the current request asynchronously.

Type Parameters:

T - generic response entity type.

Parameters:

entity - request entity.

callback - asynchronous invocation callback.

Returns:

invocation response future.

method

java.util.concurrent.Future<Response> method(java.lang.String name)
                                             throws InvocationException

Invoke an arbitrary method for the current request asynchronously.

Parameters:

name - method name.

Returns:

invocation response future.

Throws:

InvocationException - in case the invocation failed.

method

<T> java.util.concurrent.Future<T> method(java.lang.String name,
                                          java.lang.Class<T> responseType)
                                      throws InvocationException

Invoke an arbitrary method for the current request asynchronously.

Type Parameters:

T - response entity type.

Parameters:

name - method name.

responseType - Java type the response entity will be converted to.

Returns:

invocation response future.

Throws:

InvocationException - in case the invocation failed.

method

<T> java.util.concurrent.Future<T> method(java.lang.String name,
                                          GenericType<T> responseType)
                                      throws InvocationException

Invoke an arbitrary method for the current request asynchronously.

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.

Throws:

InvocationException - in case the invocation failed.

method

<T> java.util.concurrent.Future<T> method(java.lang.String name,
                                          InvocationCallback<T> callback)

Invoke an arbitrary method for the current request asynchronously.

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)
                                             throws InvocationException

Invoke an arbitrary method for the current request asynchronously.

Parameters:

name - method name.

entity - request entity.

Returns:

invocation response future.

Throws:

InvocationException - in case the invocation failed.

method

<T> java.util.concurrent.Future<T> method(java.lang.String name,
                                          Entity<?> entity,
                                          java.lang.Class<T> responseType)
                                      throws InvocationException

Invoke an arbitrary method for the current request asynchronously.

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.

Throws:

InvocationException - in case the invocation failed.

method

<T> java.util.concurrent.Future<T> method(java.lang.String name,
                                          Entity<?> entity,
                                          GenericType<T> responseType)
                                      throws InvocationException

Invoke an arbitrary method for the current request asynchronously.

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.

Throws:

InvocationException - in case the invocation failed.

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.

Type Parameters:

T - generic response entity type.

Parameters:

name - method name.

entity - request entity.

callback - asynchronous invocation callback.

Returns:

invocation response future.