com.vmware.vcloud.api.rest.client

Class NsxProxyApiClient

java.lang.Object

com.vmware.cxfrestclient.AbstractCxfRestClient

com.vmware.vcloud.api.rest.client.NsxProxyApiClient

All Implemented Interfaces:

JaxRsClient

public class NsxProxyApiClient
extends AbstractCxfRestClient

A client to interact with VCD's NSX/networking proxy API.

An instance of this can only be acquired from VcdClient.getOpenApiClient() call and this client's authentication is tied to the parent VcdClient from which this is instantiated

Nested Class Summary

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

JaxRsClient.ErrorHandler

Field Summary

Fields inherited from class com.vmware.cxfrestclient.AbstractCxfRestClient

endpoint

Fields inherited from interface com.vmware.cxfrestclient.JaxRsClient

EMPTY_CONTENTS

Method Summary

Modifier and Type	Method and Description
protected 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 String[]	getAcceptHeaders() Accept headers that must be included with the request.
protected VcdClient.ClientRequestIdProvider	getClientRequestIdProvider()
protected List<?>	getCxfProviders()
protected String	getOrgContextHeader() Get the value to be sent in the X-VMWARE-VCLOUD-ORG-ID header
protected void	setAuthenticationHeaders(org.apache.cxf.jaxrs.client.Client client) Configure authentication headers on the supplied clients
protected void	setClientRequestIdProvider(VcdClient.ClientRequestIdProvider clientRequestIdGenerator)

Methods inherited from class com.vmware.cxfrestclient.AbstractCxfRestClient

configureClient, configureSSLTrustManager, createProxy, createWebClient, createWebClient, deleteResource, deleteResource, deleteResourceVoid, getEndpoint, getResource, getResource, makeException, optionsResource, postResource, postResource, postResourceVoid, putFile, putResource, putResource, putResourceVoid, setErrorHandler

Methods inherited from class java.lang.Object

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

Method Detail

getCxfProviders

protected List<?> getCxfProviders()

Specified by:

getCxfProviders in class AbstractCxfRestClient

Returns:

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

setAuthenticationHeaders

protected void setAuthenticationHeaders(org.apache.cxf.jaxrs.client.Client client)

Configure authentication headers on the supplied clients

May possibly set cookies too, if applicable.

Parameters:

client - Client to set authentication headers on.

getAcceptHeaders

protected String[] getAcceptHeaders()

Accept headers that must be included with the request.

Returns:

Appropriately formatted accept values in String format.

getOrgContextHeader

protected String getOrgContextHeader()

Get the value to be sent in the X-VMWARE-VCLOUD-ORG-ID header

getClientRequestIdProvider

protected VcdClient.ClientRequestIdProvider getClientRequestIdProvider()

configureHttpRequestHeaders

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

Description copied from class: AbstractCxfRestClient

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.

Specified by:

configureHttpRequestHeaders in class AbstractCxfRestClient

setClientRequestIdProvider

protected void setClientRequestIdProvider(VcdClient.ClientRequestIdProvider clientRequestIdGenerator)