com.vmware.cxfrestclient

Interface JaxRsClient

All Known Subinterfaces:

OpenApiClient, VcdClient

All Known Implementing Classes:

AbstractCxfRestClient, NsxProxyApiClient, VcdClientImpl

public interface JaxRsClient

A REST API client. Allows simple, type-safe access to standard HTTP methods. Each HTTP method has two corresponding methods in this interface: one that returns an application-specific response object of a JAXB-generated class (representing the body of the response to the HTTP method request), and one that returns a generic JAX-RS Response object. The latter is primarily for use by callers that need the response's metadata (perhaps in addition to it body). It can also be used in cases where the response has no body, although an equivalent approach is to specify Void as the "ResponseClass" generic parameter and Void.class as the "requestType" method parameter.

Users of this interface can use setErrorHandler(ErrorHandler) to set an JaxRsClient.ErrorHandler to control whether retries happen or not when HTTP request fail. (If there's no handler, no retry is attempted).

Largely a wrapper around Apache CXF WebClient.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	JaxRsClient.ErrorHandler The interface used when requests fail.

Field Summary

Fields

Modifier and Type	Field and Description
static JAXBElement<?>	EMPTY_CONTENTS

Method Summary

Modifier and Type	Method and Description
<JaxRsClass> JaxRsClass	createProxy(Class<JaxRsClass> jaxRsClass) Gets a proxy for the specified service.
org.apache.cxf.jaxrs.client.WebClient	createWebClient(URI uri) Returns a CXF WebClient corresponding to the specified URI.
org.apache.cxf.jaxrs.client.WebClient	createWebClient(URI uri, String mediaType) Returns a CXF WebClient corresponding to the specified URI.
javax.ws.rs.core.Response	deleteResource(URI ref) Deletes the specified resource.
<ResponseClass> ResponseClass	deleteResource(URI ref, Class<ResponseClass> responseClass) Deletes the specified contents to the specified resource.
void	deleteResourceVoid(URI ref) Deletes the specified resource and expects a HTTP 204 response status.
URI	getEndpoint() Retrieves the endpoint used to create this client
<ContentsClass> javax.ws.rs.core.Response	getResource(URI ref) Gets the specified contents to the specified resource.
<ResourceClass> ResourceClass	getResource(URI ref, Class<ResourceClass> resourceClass) Gets the contents of the specified resource.
javax.ws.rs.core.Response	optionsResource(URI ref) Gets OPTIONS response of the specified resource.
<ContentsClass> javax.ws.rs.core.Response	postResource(URI ref, String mediaType, JAXBElement<ContentsClass> contents) Posts the specified contents to the specified resource.
<ContentsClass,ResponseClass> ResponseClass	postResource(URI ref, String mediaType, JAXBElement<ContentsClass> contents, Class<ResponseClass> responseClass) Posts the specified contents to the specified resource.
<ContentsClass> void	postResourceVoid(URI ref, String mediaType, JAXBElement<ContentsClass> contents) Posts the specified contents to the specified resource.
javax.ws.rs.core.Response	putFile(URI uri, File file, String mediaType) Puts the contents of the specified file to the specified uri.
<ContentsClass> javax.ws.rs.core.Response	putResource(URI ref, String mediaType, JAXBElement<ContentsClass> contents) Puts the specified contents to the specified resource.
<ContentsClass,ResponseClass> ResponseClass	putResource(URI ref, String mediaType, JAXBElement<ContentsClass> contents, Class<ResponseClass> responseClass) Puts the specified contents to the specified resource.
<ContentsClass> void	putResourceVoid(URI ref, String mediaType, JAXBElement<ContentsClass> contents) Puts the specified contents to the specified resource.
void	setErrorHandler(JaxRsClient.ErrorHandler errorHandler) Sets the handler to be called when requests made with this client fail.

Field Detail

EMPTY_CONTENTS

static final JAXBElement<?> EMPTY_CONTENTS

Method Detail

createProxy

<JaxRsClass> JaxRsClass createProxy(Class<JaxRsClass> jaxRsClass)

Gets a proxy for the specified service.

Type Parameters:

JaxRsClass - the JAXRS-annotated class

Parameters:

jaxRsClass - the JAXRS-annotated class

Returns:

a service proxy

getEndpoint

URI getEndpoint()

Retrieves the endpoint used to create this client

Returns:

URI of the endpoint this client talks to

getResource

<ContentsClass> javax.ws.rs.core.Response getResource(URI ref)

Gets the specified contents to the specified resource. (Does an HTTP GET.)

Type Parameters:

ContentsClass - JAXB-generated class of the request contents

Parameters:

ref - reference to the resource

Returns:

response from the get request

getResource

<ResourceClass> ResourceClass getResource(URI ref,
                                          Class<ResourceClass> resourceClass)

Gets the contents of the specified resource. (Does an HTTP GET.)

Type Parameters:

ResourceClass - JAXB-generated class of the resource

Parameters:

ref - reference to the resource

resourceClass - JAXB-generated class of the resource

Returns:

the contents of the resource

putResource

<ContentsClass> javax.ws.rs.core.Response putResource(URI ref,
                                                      String mediaType,
                                                      JAXBElement<ContentsClass> contents)

Puts the specified contents to the specified resource. (Does an HTTP PUT.)

Type Parameters:

ContentsClass - JAXB-generated class of the request contents

Parameters:

ref - reference to the resource

mediaType - media type of content

contents - contents to be put

Returns:

response from the put request

putResourceVoid

<ContentsClass> void putResourceVoid(URI ref,
                                     String mediaType,
                                     JAXBElement<ContentsClass> contents)

Puts the specified contents to the specified resource. (Does an HTTP PUT.) And expects a HTTP 204 response status.

Type Parameters:

ContentsClass - JAXB-generated class of the request contents

Parameters:

ref - reference to the resource

mediaType - media type of content

contents - contents to be put

putResource

<ContentsClass,ResponseClass> ResponseClass putResource(URI ref,
                                                        String mediaType,
                                                        JAXBElement<ContentsClass> contents,
                                                        Class<ResponseClass> responseClass)

Puts the specified contents to the specified resource. (Does an HTTP PUT.)

Type Parameters:

ContentsClass - JAXB-generated class of the request contents

ResponseClass - JAXB-generated class of the response

Parameters:

ref - reference to the resource

mediaType - media type of content

contents - contents to be put

responseClass - JAXB-generated class of the response

Returns:

response from the put request

putFile

javax.ws.rs.core.Response putFile(URI uri,
                                  File file,
                                  String mediaType)

Puts the contents of the specified file to the specified uri. (Does an HTTP PUT.)

Parameters:

uri - HTTP PUT target URI

file - File to upload

mediaType - media type of content

Returns:

response from the put request

postResource

<ContentsClass> javax.ws.rs.core.Response postResource(URI ref,
                                                       String mediaType,
                                                       JAXBElement<ContentsClass> contents)

Posts the specified contents to the specified resource. (Does an HTTP POST.)

Type Parameters:

ContentsClass - JAXB-generated class of the request contents

Parameters:

ref - reference to the resource

mediaType - media type of content

contents - contents to be post

Returns:

response from the the post request

postResourceVoid

<ContentsClass> void postResourceVoid(URI ref,
                                      String mediaType,
                                      JAXBElement<ContentsClass> contents)

Posts the specified contents to the specified resource. (Does an HTTP POST.) And expects a HTTP 204 response status.

Type Parameters:

ContentsClass - JAXB-generated class of the request contents

Parameters:

ref - reference to the resource

mediaType - media type of content

contents - contents to be post

postResource

<ContentsClass,ResponseClass> ResponseClass postResource(URI ref,
                                                         String mediaType,
                                                         JAXBElement<ContentsClass> contents,
                                                         Class<ResponseClass> responseClass)

Posts the specified contents to the specified resource. (Does an HTTP POST.)

Type Parameters:

ContentsClass - JAXB-generated class of the request contents

ResponseClass - JAXB-generated class of the response

Parameters:

ref - reference to the resource

mediaType - media type of content

contents - contents to be post

responseClass - JAXB-generated class of the response

Returns:

response from the post request

deleteResource

javax.ws.rs.core.Response deleteResource(URI ref)

Deletes the specified resource. (Does an HTTP DELETE.)

Parameters:

ref - reference to the resource

Returns:

response from the delete request

deleteResourceVoid

void deleteResourceVoid(URI ref)

Deletes the specified resource and expects a HTTP 204 response status. (Does an HTTP DELETE.)

Parameters:

ref - reference to the resource

deleteResource

<ResponseClass> ResponseClass deleteResource(URI ref,
                                             Class<ResponseClass> responseClass)

Deletes the specified contents to the specified resource. (Does an HTTP DELETE.)

Type Parameters:

ResponseClass - JAXB-generated class of the response

Parameters:

ref - reference to the resource

responseClass - JAXB-generated class of the response

Returns:

response from the delete request

optionsResource

javax.ws.rs.core.Response optionsResource(URI ref)

Gets OPTIONS response of the specified resource.

Parameters:

ref - reference to the resource

Returns:

response from the options request

setErrorHandler

void setErrorHandler(JaxRsClient.ErrorHandler errorHandler)

Sets the handler to be called when requests made with this client fail.

createWebClient

org.apache.cxf.jaxrs.client.WebClient createWebClient(URI uri,
                                                      String mediaType)

Returns a CXF WebClient corresponding to the specified URI. Requests on the resulting WebClient will have their "Content-Type" header set to the specified media type.

createWebClient

org.apache.cxf.jaxrs.client.WebClient createWebClient(URI uri)

Returns a CXF WebClient corresponding to the specified URI.