javax.ws.rs.client
Interface SyncInvoker

All Known Subinterfaces:
Invocation.Builder

public interface SyncInvoker

Uniform interface for synchronous invocation of HTTP methods.

Since:
2.0
Author:
Marek Potociar

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

Method Detail

get

Response get()
             throws InvocationException
Invoke HTTP GET method for the current request synchronously.

Returns:
invocation response.
Throws:
InvocationException - in case the invocation failed.

get

<T> T get(Class<T> responseType)
      throws InvocationException
Invoke HTTP GET method for the current request synchronously.

Type Parameters:
T - response entity type.
Parameters:
responseType - Java type the response entity will be converted to.
Returns:
invocation response.
Throws:
InvocationException - in case the invocation failed.

get

<T> T get(GenericType<T> responseType)
      throws InvocationException
Invoke HTTP GET method for the current request synchronously.

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.
Throws:
InvocationException - in case the invocation failed.

put

Response put(Entity<?> entity)
             throws InvocationException
Invoke HTTP PUT method for the current request synchronously.

Parameters:
entity - request entity.
Returns:
invocation response.
Throws:
InvocationException - in case the invocation failed.

put

<T> T put(Entity<?> entity,
          Class<T> responseType)
      throws InvocationException
Invoke HTTP PUT method for the current request synchronously.

Type Parameters:
T - response entity type.
Parameters:
entity - request entity.
responseType - Java type the response entity will be converted to.
Returns:
invocation response.
Throws:
InvocationException - in case the invocation failed.

put

<T> T put(Entity<?> entity,
          GenericType<T> responseType)
      throws InvocationException
Invoke HTTP PUT method for the current request synchronously.

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.
Throws:
InvocationException - in case the invocation failed.

post

Response post(Entity<?> entity)
              throws InvocationException
Invoke HTTP POST method for the current request synchronously.

Parameters:
entity - request entity.
Returns:
invocation response.
Throws:
InvocationException - in case the invocation failed.

post

<T> T post(Entity<?> entity,
           Class<T> responseType)
       throws InvocationException
Invoke HTTP POST method for the current request synchronously.

Type Parameters:
T - response entity type.
Parameters:
entity - request entity.
responseType - Java type the response entity will be converted to.
Returns:
invocation response.
Throws:
InvocationException - in case the invocation failed.

post

<T> T post(Entity<?> entity,
           GenericType<T> responseType)
       throws InvocationException
Invoke HTTP POST method for the current request synchronously.

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.
Throws:
InvocationException - in case the invocation failed.

delete

Response delete()
                throws InvocationException
Invoke HTTP DELETE method for the current request synchronously.

Returns:
invocation response.
Throws:
InvocationException - in case the invocation failed.

delete

<T> T delete(Class<T> responseType)
         throws InvocationException
Invoke HTTP DELETE method for the current request synchronously.

Type Parameters:
T - response entity type.
Parameters:
responseType - Java type the response entity will be converted to.
Returns:
invocation response.
Throws:
InvocationException - in case the invocation failed.

delete

<T> T delete(GenericType<T> responseType)
         throws InvocationException
Invoke HTTP DELETE method for the current request synchronously.

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.
Throws:
InvocationException - in case the invocation failed.

head

Response head()
              throws InvocationException
Invoke HTTP HEAD method for the current request synchronously.

Returns:
invocation response.
Throws:
InvocationException - in case the invocation failed.

options

Response options()
                 throws InvocationException
Invoke HTTP OPTIONS method for the current request synchronously.

Returns:
invocation response.
Throws:
InvocationException - in case the invocation failed.

options

<T> T options(Class<T> responseType)
          throws InvocationException
Invoke HTTP OPTIONS method for the current request synchronously.

Type Parameters:
T - response entity type.
Parameters:
responseType - Java type the response entity will be converted to.
Returns:
invocation response.
Throws:
InvocationException - in case the invocation failed.

options

<T> T options(GenericType<T> responseType)
          throws InvocationException
Invoke HTTP OPTIONS method for the current request synchronously.

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.
Throws:
InvocationException - in case the invocation failed.

trace

Response trace(Entity<?> entity)
               throws InvocationException
Invoke HTTP TRACE method for the current request synchronously.

Parameters:
entity - request entity.
Returns:
invocation response.
Throws:
InvocationException - in case the invocation failed.

trace

<T> T trace(Entity<?> entity,
            Class<T> responseType)
        throws InvocationException
Invoke HTTP TRACE method for the current request synchronously.

Type Parameters:
T - response entity type.
Parameters:
entity - request entity.
responseType - Java type the response entity will be converted to.
Returns:
invocation response.
Throws:
InvocationException - in case the invocation failed.

trace

<T> T trace(Entity<?> entity,
            GenericType<T> responseType)
        throws InvocationException
Invoke HTTP TRACE method for the current request synchronously.

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.
Throws:
InvocationException - in case the invocation failed.

method

Response method(String name)
                throws InvocationException
Invoke an arbitrary method for the current request synchronously.

Parameters:
name - method name.
Returns:
invocation response.
Throws:
InvocationException - in case the invocation failed.

method

<T> T method(String name,
             Class<T> responseType)
         throws InvocationException
Invoke an arbitrary method for the current request synchronously.

Type Parameters:
T - response entity type.
Parameters:
name - method name.
responseType - Java type the response entity will be converted to.
Returns:
invocation response.
Throws:
InvocationException - in case the invocation failed.

method

<T> T method(String name,
             GenericType<T> responseType)
         throws InvocationException
Invoke an arbitrary method for the current request synchronously.

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.
Throws:
InvocationException - in case the invocation failed.

method

Response method(String name,
                Entity<?> entity)
                throws InvocationException
Invoke an arbitrary method for the current request synchronously.

Parameters:
name - method name.
entity - request entity.
Returns:
invocation response.
Throws:
InvocationException - in case the invocation failed.

method

<T> T method(String name,
             Entity<?> entity,
             Class<T> responseType)
         throws InvocationException
Invoke an arbitrary method for the current request synchronously.

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.
Throws:
InvocationException - in case the invocation failed.

method

<T> T method(String name,
             Entity<?> entity,
             GenericType<T> responseType)
         throws InvocationException
Invoke an arbitrary method for the current request synchronously.

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.
Throws:
InvocationException - in case the invocation failed.


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