com.vmware.cxfrestclient

Class AbstractCxfRestClient

java.lang.Object

com.vmware.cxfrestclient.AbstractCxfRestClient

All Implemented Interfaces:

JaxRsClient

Direct Known Subclasses:

NsxProxyApiClient, VcdClientImpl

public abstract class AbstractCxfRestClient
extends Object
implements JaxRsClient

Base class for implementations of JaxRsClient that are based on CXF.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.cxfrestclient.JaxRsClient

JaxRsClient.ErrorHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected URI	endpoint

Fields inherited from interface com.vmware.cxfrestclient.JaxRsClient

EMPTY_CONTENTS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCxfRestClient(AbstractCxfRestClient client)
protected	AbstractCxfRestClient(URI endpoint)
protected	AbstractCxfRestClient(URI endpoint, AbstractCxfRestClient client)
protected	AbstractCxfRestClient(URI endpoint, CxfClientSecurityContext cxfClientSecurityContext)

Method Summary

Modifier and Type	Method and Description
protected void	configureClient(Object client)
protected abstract void	configureHttpRequestHeaders(org.apache.cxf.jaxrs.client.Client client) A method that must be implemented by derived classes to set any HTTP request headers that the REST API implemented in such derived classes require for proper operation.
protected void	configureSSLTrustManager(org.apache.cxf.jaxrs.client.ClientConfiguration config) Set the appropriate ssl context and https hostname verification for this client
<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 type) Returns a CXF WebClient corresponding to the specified URI.
javax.ws.rs.core.Response	deleteResource(URI uri) Deletes the specified resource.
<ResponseClass> ResponseClass	deleteResource(URI uri, Class<ResponseClass> responseClass) Deletes the specified contents to the specified resource.
void	deleteResourceVoid(URI uri) Deletes the specified resource and expects a HTTP 204 response status.
protected abstract List<?>	getCxfProviders()
URI	getEndpoint() Retrieves the endpoint used to create this client
javax.ws.rs.core.Response	getResource(URI uri) Gets the specified contents to the specified resource.
<ResourceClass> ResourceClass	getResource(URI uri, Class<ResourceClass> resourceClass) Gets the contents of the specified resource.
protected RuntimeException	makeException(javax.ws.rs.WebApplicationException exception)
javax.ws.rs.core.Response	optionsResource(URI uri) Gets OPTIONS response of the specified resource.
<ContentsClass> javax.ws.rs.core.Response	postResource(URI uri, String type, JAXBElement<ContentsClass> contents) Posts the specified contents to the specified resource.
<ContentsClass,ResponseClass> ResponseClass	postResource(URI uri, String type, JAXBElement<ContentsClass> contents, Class<ResponseClass> responseClass) Posts the specified contents to the specified resource.
<ContentsClass> void	postResourceVoid(URI uri, String type, JAXBElement<ContentsClass> contents) Posts the specified contents to the specified resource.
javax.ws.rs.core.Response	putFile(URI uri, File file, String type) Puts the contents of the specified file to the specified uri.
<ContentsClass> javax.ws.rs.core.Response	putResource(URI uri, String type, JAXBElement<ContentsClass> contents) Puts the specified contents to the specified resource.
<ContentsClass,ResponseClass> ResponseClass	putResource(URI uri, String type, JAXBElement<ContentsClass> contents, Class<ResponseClass> responseClass) Puts the specified contents to the specified resource.
<ContentsClass> void	putResourceVoid(URI uri, String type, 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

endpoint

protected final URI endpoint

Constructor Detail

AbstractCxfRestClient

protected AbstractCxfRestClient(URI endpoint)

AbstractCxfRestClient

protected AbstractCxfRestClient(URI endpoint,
                                CxfClientSecurityContext cxfClientSecurityContext)

AbstractCxfRestClient

protected AbstractCxfRestClient(AbstractCxfRestClient client)

AbstractCxfRestClient

protected AbstractCxfRestClient(URI endpoint,
                                AbstractCxfRestClient client)

Method Detail

getCxfProviders

protected abstract List<?> getCxfProviders()

Returns:

a List of CXF providers for use with CXF proxies and WebClients we create.

configureHttpRequestHeaders

protected abstract void configureHttpRequestHeaders(org.apache.cxf.jaxrs.client.Client client)

A method that must be implemented by derived classes to set any HTTP request headers that the REST API implemented in such derived classes require for proper operation.

createProxy

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

Description copied from interface: JaxRsClient

Gets a proxy for the specified service.

Specified by:

createProxy in interface JaxRsClient

Type Parameters:

JaxRsClass - the JAXRS-annotated class

Parameters:

jaxRsClass - the JAXRS-annotated class

Returns:

a service proxy

getEndpoint

public URI getEndpoint()

Description copied from interface: JaxRsClient

Retrieves the endpoint used to create this client

Specified by:

getEndpoint in interface JaxRsClient

Returns:

URI of the endpoint this client talks to

getResource

public javax.ws.rs.core.Response getResource(URI uri)

Description copied from interface: JaxRsClient

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

Specified by:

getResource in interface JaxRsClient

Parameters:

uri - reference to the resource

Returns:

response from the get request

getResource

public <ResourceClass> ResourceClass getResource(URI uri,
                                                 Class<ResourceClass> resourceClass)

Description copied from interface: JaxRsClient

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

Specified by:

getResource in interface JaxRsClient

Type Parameters:

ResourceClass - JAXB-generated class of the resource

Parameters:

uri - reference to the resource

resourceClass - JAXB-generated class of the resource

Returns:

the contents of the resource

putResource

public <ContentsClass> javax.ws.rs.core.Response putResource(URI uri,
                                                             String type,
                                                             JAXBElement<ContentsClass> contents)

Description copied from interface: JaxRsClient

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

Specified by:

putResource in interface JaxRsClient

Type Parameters:

ContentsClass - JAXB-generated class of the request contents

Parameters:

uri - reference to the resource

type - media type of content

contents - contents to be put

Returns:

response from the put request

putResourceVoid

public <ContentsClass> void putResourceVoid(URI uri,
                                            String type,
                                            JAXBElement<ContentsClass> contents)

Description copied from interface: JaxRsClient

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

Specified by:

putResourceVoid in interface JaxRsClient

Type Parameters:

ContentsClass - JAXB-generated class of the request contents

Parameters:

uri - reference to the resource

type - media type of content

contents - contents to be put

putResource

public <ContentsClass,ResponseClass> ResponseClass putResource(URI uri,
                                                               String type,
                                                               JAXBElement<ContentsClass> contents,
                                                               Class<ResponseClass> responseClass)

Description copied from interface: JaxRsClient

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

Specified by:

putResource in interface JaxRsClient

Type Parameters:

ContentsClass - JAXB-generated class of the request contents

ResponseClass - JAXB-generated class of the response

Parameters:

uri - reference to the resource

type - media type of content

contents - contents to be put

responseClass - JAXB-generated class of the response

Returns:

response from the put request

putFile

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

Description copied from interface: JaxRsClient

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

Specified by:

putFile in interface JaxRsClient

Parameters:

uri - HTTP PUT target URI

file - File to upload

type - media type of content

Returns:

response from the put request

postResource

public <ContentsClass> javax.ws.rs.core.Response postResource(URI uri,
                                                              String type,
                                                              JAXBElement<ContentsClass> contents)

Description copied from interface: JaxRsClient

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

Specified by:

postResource in interface JaxRsClient

Type Parameters:

ContentsClass - JAXB-generated class of the request contents

Parameters:

uri - reference to the resource

type - media type of content

contents - contents to be post

Returns:

response from the the post request

postResourceVoid

public <ContentsClass> void postResourceVoid(URI uri,
                                             String type,
                                             JAXBElement<ContentsClass> contents)

Description copied from interface: JaxRsClient

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

Specified by:

postResourceVoid in interface JaxRsClient

Type Parameters:

ContentsClass - JAXB-generated class of the request contents

Parameters:

uri - reference to the resource

type - media type of content

contents - contents to be post

postResource

public <ContentsClass,ResponseClass> ResponseClass postResource(URI uri,
                                                                String type,
                                                                JAXBElement<ContentsClass> contents,
                                                                Class<ResponseClass> responseClass)

Description copied from interface: JaxRsClient

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

Specified by:

postResource in interface JaxRsClient

Type Parameters:

ContentsClass - JAXB-generated class of the request contents

ResponseClass - JAXB-generated class of the response

Parameters:

uri - reference to the resource

type - media type of content

contents - contents to be post

responseClass - JAXB-generated class of the response

Returns:

response from the post request

deleteResource

public javax.ws.rs.core.Response deleteResource(URI uri)

Description copied from interface: JaxRsClient

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

Specified by:

deleteResource in interface JaxRsClient

Parameters:

uri - reference to the resource

Returns:

response from the delete request

makeException

protected RuntimeException makeException(javax.ws.rs.WebApplicationException exception)

deleteResourceVoid

public void deleteResourceVoid(URI uri)

Description copied from interface: JaxRsClient

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

Specified by:

deleteResourceVoid in interface JaxRsClient

Parameters:

uri - reference to the resource

deleteResource

public <ResponseClass> ResponseClass deleteResource(URI uri,
                                                    Class<ResponseClass> responseClass)

Description copied from interface: JaxRsClient

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

Specified by:

deleteResource in interface JaxRsClient

Type Parameters:

ResponseClass - JAXB-generated class of the response

Parameters:

uri - reference to the resource

responseClass - JAXB-generated class of the response

Returns:

response from the delete request

optionsResource

public javax.ws.rs.core.Response optionsResource(URI uri)

Description copied from interface: JaxRsClient

Gets OPTIONS response of the specified resource.

Specified by:

optionsResource in interface JaxRsClient

Parameters:

uri - reference to the resource

Returns:

response from the options request

createWebClient

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

Description copied from interface: JaxRsClient

Returns a CXF WebClient corresponding to the specified URI.

Specified by:

createWebClient in interface JaxRsClient

createWebClient

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

Description copied from interface: JaxRsClient

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.

Specified by:

createWebClient in interface JaxRsClient

setErrorHandler

public void setErrorHandler(JaxRsClient.ErrorHandler errorHandler)

Description copied from interface: JaxRsClient

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

Specified by:

setErrorHandler in interface JaxRsClient

configureSSLTrustManager

protected final void configureSSLTrustManager(org.apache.cxf.jaxrs.client.ClientConfiguration config)

Set the appropriate ssl context and https hostname verification for this client

configureClient

protected void configureClient(Object client)