|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Invocation
A client request invocation. An invocation is a request that has been prepared and is ready for execution. Invocations provide a generic (command) interface that enables a separation of concerns between the creator and the submitter. In particular, the submitter does not need to know how the invocation was prepared, but only how it should be executed (synchronously or asynchronously) and when.
Invocation.Builder
Nested Class Summary | |
---|---|
static interface |
Invocation.Builder
A client request invocation builder. |
Method Summary | ||
---|---|---|
Configuration |
configuration()
Get access to the underlying configuration . |
|
Response |
invoke()
Synchronously invoke the request and receive a response back. |
|
|
invoke(java.lang.Class<T> responseType)
Synchronously invoke the request and receive a response of the specified type back. |
|
|
invoke(GenericType<T> responseType)
Synchronously invoke the request and receive a response of the specified generic type back. |
|
java.util.concurrent.Future<Response> |
submit()
Submit the request for an asynchronous invocation and receive a future response back. |
|
|
submit(java.lang.Class<T> responseType)
Submit the request for an asynchronous invocation and receive a future response of the specified type back. |
|
|
submit(GenericType<T> responseType)
Submit the request for an asynchronous invocation and receive a future response of the specified generic type back. |
|
|
submit(InvocationCallback<T> callback)
Submit the request for an asynchronous invocation and register an InvocationCallback to process the future result of the invocation. |
Method Detail |
---|
Response invoke() throws ClientException
response
object as a result of the request
invocation.
ClientException
- in case the invocation processing has failed.<T> T invoke(java.lang.Class<T> responseType) throws ClientException, WebApplicationException
T
- response typeresponseType
- Java type the response should be converted into.
ClientException
- in case the invocation processing has failed.
WebApplicationException
- in case the response status code of the response
returned by the server is not
successful
.<T> T invoke(GenericType<T> responseType) throws ClientException, WebApplicationException
T
- generic response typeresponseType
- type literal representing a generic Java type the
response should be converted into.
ClientException
- in case the invocation processing has failed.
WebApplicationException
- in case the response status code of the response
returned by the server is not
successful
.java.util.concurrent.Future<Response> submit()
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.
response
object as a result of the request
invocation.<T> java.util.concurrent.Future<T> submit(java.lang.Class<T> responseType)
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
.
T
- response typeresponseType
- Java type the response should be converted into.
<T> java.util.concurrent.Future<T> submit(GenericType<T> responseType)
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
.
T
- generic response typeresponseType
- type literal representing a generic Java type the
response should be converted into.
<T> java.util.concurrent.Future<T> submit(InvocationCallback<T> callback)
InvocationCallback
to process the future result of the invocation.
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
.
T
- response typecallback
- invocation callback for asynchronous processing of the
request invocation result.
Configuration configuration()
configuration
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |