com.vmware.vcloud.api.rest.client

Class VcdClientImpl

java.lang.Object

com.vmware.cxfrestclient.AbstractCxfRestClient

com.vmware.vcloud.api.rest.client.VcdClientImpl

All Implemented Interfaces:

JaxRsClient, VcdClient

public class VcdClientImpl
extends AbstractCxfRestClient
implements VcdClient

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VcdClientImpl.SessionTokenImpl Implementation of SessionToken to represent a current session with vCD.

Nested classes/interfaces inherited from interface com.vmware.vcloud.api.rest.client.VcdClient

VcdClient.ClientRequestIdProvider, VcdClient.Query<QueryResultClass>, VcdClient.QueryListPage<T>, VcdClient.ReferenceTypeChangedCallBack, VcdClient.SessionToken

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

Constructor Summary

Constructors

Constructor and Description
VcdClientImpl(URI endpoint, List<com.vmware.vcloud.api.rest.version.ApiVersion> candidateVersions, CxfClientSecurityContext cxfClientSecurityContext) Creates an instance of VcdClientImpl with given endpoint, cxfClientSecurityContext and determines an ApiVersion supported by both given vCD endpoint, and given list of preferred API versions in candidateVersions
VcdClientImpl(URI endpoint, String apiVersion, CxfClientSecurityContext cxfClientSecurityContext) Creates an instance of VcdClientImpl with given endpoint, API version and cxfClientSecurityContext.

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 static List<org.apache.cxf.jaxrs.provider.JAXBElementProvider<?>>	createJAXBElementProviderFromObjectFactories() Creates a JAXBElementProvider that will return JAXBContexts that handle all the JAXB-generated types using object factories supplied to this method.
org.apache.cxf.jaxrs.client.WebClient	createWebClient(URI uri, String type) Returns a CXF WebClient corresponding to the specified URI.
<ResponseClass> ResponseClass	deleteResource(com.vmware.vcloud.api.rest.schema_v1_5.ReferenceType ref, Boolean force, Boolean recursive, Class<ResponseClass> responseClass) Convenience wrapper over {@link JaxRsClient#deleteResource(java.net.URI, Class).
<ResponseClass> ResponseClass	deleteResource(com.vmware.vcloud.api.rest.schema_v1_5.ReferenceType ref, Class<ResponseClass> responseClass) Convenience wrapper over {@link JaxRsClient#deleteResource(java.net.URI, Class).
<ResponseClass> ResponseClass	deleteResource(com.vmware.vcloud.api.rest.schema_v1_5.ResourceType resource, Boolean force, Boolean recursive, Class<ResponseClass> responseClass) Deletes the resource described by the specified resource type.
<ResponseClass> ResponseClass	deleteResource(com.vmware.vcloud.api.rest.schema_v1_5.ResourceType ref, Class<ResponseClass> responseClass) Convenience wrapper over {@link JaxRsClient#deleteResource(java.net.URI, Class).
VcdClient	duplicate(boolean newSession) Creates a clone of current VcdClient The new client will communicate with the same vCD as this client and is initialized with same credentials and CxfClientSecurityContext.
protected String[]	getAcceptHeaders() Accept headers that must be included with the request.
com.vmware.vcloud.api.rest.schema_v1_5.VCloudType	getAdmin() Returns the "admin" root resource type.
com.vmware.vcloud.api.rest.schema_v1_5.ApiExtensibilityType	getApiExtensibility() Returns the Api Extensibility object
String	getClientApiVersion() Gets the API version used by the client for vCloud API requests
protected VcdClient.ClientRequestIdProvider	getClientRequestIdProvider()
protected List<?>	getCxfProviders()
<T extends com.vmware.vcloud.api.rest.schema_v1_5.EntityType> T	getEntity(com.vmware.vcloud.api.rest.schema_v1_5.ReferenceType referenceType, Class<T> resourceClass, VcdClient.ReferenceTypeChangedCallBack referenceTypeChangedCallBack) Get an entity using a ReferenceType by first trying with its href and, when it fails, trying to recover using the vcd entity resolver service.
<ResponseClass extends com.vmware.vcloud.api.rest.schema_v1_5.EntityType> ResponseClass	getEntity(String entityId, String mediaType, Class<ResponseClass> responseClass) Resolve a vCloud entity using its identifier and then fetch the corresponding vCloud entity instance.
EventViewer	getEventViewer()
com.vmware.vcloud.api.rest.schema_v1_5.extension.VMWExtensionType	getExtension() Returns the "extension" root resource type.
String	getJwtToken() Get the current JWT for this client.
com.vmware.vcloud.api.rest.schema_v1_5.AdminOrgType	getLoggedInAdminOrg() Returns info about the admin view of the org, the session is logged in as (if permitted).
com.vmware.vcloud.api.rest.schema_v1_5.OrgType	getLoggedInOrg() Returns info about the org the session is logged in as.
NsxProxyApiClient	getNsxProxyApiClient() Returns an NsxProxyApiClient (which continues to use the existing session).
OpenApiClient	getOpenApiClient() Returns an OpenApiClient (which continues to use the existing session).
protected URI	getOpenApiEndpoint() Gets the openApi endpoint.
List<com.vmware.vcloud.api.rest.schema_v1_5.ReferenceType>	getOrganizations() Gets the organizations defined/accessible in the vCloud server.
String	getOrgContextHeader() Get the value to be sent in the X-VMWARE-VCLOUD-ORG-ID header
com.vmware.vcloud.api.rest.schema.ovf.ObjectFactory	getOvfObjectFactory() Returns an object factory for OVF schema classes.
com.vmware.vcloud.api.rest.schema.ovf.vmware.ObjectFactory	getOvfVmwareObjectFactory() Returns an object factory VMware-specific OVF schema classes.
<QueryResultClass> VcdClient.Query<QueryResultClass>	getPackagedQuery(String queryPath, Class<QueryResultClass> queryResultClass) Returns an instance of the VcdClient.Query object for a packaged query and query result type.
<QueryResultClass> VcdClient.Query<QueryResultClass>	getQuery(String queryTypeName, Class<QueryResultClass> queryResultClass) Returns an instance of the VcdClient.Query object for the given query type name and query result type.
com.vmware.vcloud.api.rest.schema_v1_5.QueryListType	getQueryList() Returns the list of supported queries.
<ResourceClass> ResourceClass	getResource(com.vmware.vcloud.api.rest.schema_v1_5.ReferenceType reference, Class<ResourceClass> resourceClass) Convenience wrapper over JaxRsClient.getResource(java.net.URI, Class).
<ResourceClass extends com.vmware.vcloud.api.rest.schema_v1_5.ResourceType> ResourceClass	getResource(com.vmware.vcloud.api.rest.schema_v1_5.ResourceType resourceType, Class<ResourceClass> resourceClass) Gets the contents of the resource referenced by its href
<ResourceClass> ResourceClass	getResource(com.vmware.vcloud.api.rest.schema_v1_5.ResourceType resource, RelationType rel, String mediaType, Class<ResourceClass> resourceClass) Gets the contents of the resource referenced by the link with the specified rel and mediaType in the specified resource.
javax.ws.rs.core.Response	getServerStatus() Retrieves the current server status from the api/server_status endpoint, adjusting the Accept headers as needed.
com.vmware.vcloud.api.rest.schema_v1_5.SessionType	getSession() Returns the SessionType for the current session
VcdClient.SessionToken	getSessionToken() Get the current opaque session token for this client.
com.vmware.vcloud.api.rest.schema_v1_5.MultisiteSessionUserInfoType	getSessionUserInfo() Returns the MultisiteSessionUserInfoType for the current session's user
VcdTaskMonitor	getTaskMonitor() Returns task monitor, which can be used to monitor specific task returned by POST or PUT requests.
com.vmware.vcloud.api.rest.schema_v1_5.extension.ObjectFactory	getVCloudExtensionObjectFactory() Returns an object factory for vCD Extension API schema classes.
com.vmware.vcloud.api.rest.schema_v1_5.ObjectFactory	getVCloudObjectFactory() Returns an object factory for vCD API schema classes.
com.vmware.vcloud.api.rest.schema.versioning.SupportedVersionsType	getVersions() Gets information about the vCloud API versions supported by the server.
void	login(ClientCredentials credentials) Logs in to the remote vCloud API end point using the supplied credentials.
void	loginWithJwt(String jwt, String orgSecurityContext) Reuses an existing session on the remote vCloud API end point using the supplied JWT taken from another VcdClient.
void	loginWithToken(VcdClient.SessionToken sessionToken) Reuses an existing session on the remote vCloud API end point using the supplied session token taken from another VcdClient.
void	logout() Logs out of the remote vCloud API end point
protected VcdErrorException	makeException(javax.ws.rs.WebApplicationException webApplicationException)
<ContentsClass,ResponseClass> ResponseClass	postResource(com.vmware.vcloud.api.rest.schema_v1_5.ReferenceType reference, String mediaType, JAXBElement<ContentsClass> contents, Class<ResponseClass> responseClass) Convenience wrapper over JaxRsClient.postResource(java.net.URI, String, JAXBElement, Class)
<ContentsClass,ResponseClass> ResponseClass	postResource(com.vmware.vcloud.api.rest.schema_v1_5.ResourceType resource, RelationType rel, String mediaType, JAXBElement<ContentsClass> contents, Class<ResponseClass> responseClass) Posts the contents to the resource referenced by the link with the specified rel and mediaType in the specified resource
<ContentsClass,ResponseClass> ResponseClass	putResource(com.vmware.vcloud.api.rest.schema_v1_5.ReferenceType reference, String mediaType, JAXBElement<ContentsClass> contents, Class<ResponseClass> responseClass) Convenience wrapper over {@link JaxRsClient#putResource(java.net.URI, String, JAXBElement, Class)
<ContentsClass,ResponseClass> ResponseClass	putResource(com.vmware.vcloud.api.rest.schema_v1_5.ResourceType resource, RelationType rel, String mediaType, JAXBElement<ContentsClass> contents, Class<ResponseClass> responseClass) Puts the contents to the resource referenced by the link with the specified rel and mediaType in the specified resource
<ContentsClass extends com.vmware.vcloud.api.rest.schema_v1_5.ResourceType,ResponseClass> ResponseClass	putResource(String mediaType, JAXBElement<ContentsClass> contents, Class<ResponseClass> responseClass) Like VcdClient.putResource(ReferenceType, String, JAXBElement, Class) except constrains the type of the contents parameter to be a type that has an href field and assumes that field has been populated (which, for example, it will naturally if was returned by a getResource call and then modified for use in this call).
void	relogin() Repeats login if client credentials are present.
javax.ws.rs.core.Response	removeResource(com.vmware.vcloud.api.rest.schema_v1_5.ResourceType resource) Deletes the resource described by the specified resource type.
<ResponseClass> ResponseClass	removeResource(com.vmware.vcloud.api.rest.schema_v1_5.ResourceType resource, Boolean force, Boolean recursive, Class<ResponseClass> responseClass) Deletes the resource described by the specified resource type.
com.vmware.vcloud.api.rest.schema_v1_5.EntityType	resolveEntityById(String id) Returns information about the resource with the specified ID.
void	setAuthenticationHeader(org.apache.cxf.jaxrs.client.Client client) Sets the vCloud API authentication header in the specified JAX-RS Client object to be the one for this VcdClient.
protected void	setAuthenticationHeaders(org.apache.cxf.jaxrs.client.Client client) Configure authentication headers on the supplied clients
void	setClientRequestIdProvider(VcdClient.ClientRequestIdProvider clientRequestIdGenerator)
void	setCredentials(ClientCredentials credentials) Sets the credentials used for authentication.
void	setMultisiteRequests(boolean federateRequests) Controls whether requests made with this client request federated behavior or not.
void	setOrgContextHeader(String orgContext) Sets the X-VMWARE-VCLOUD-ORG-ID header to the specified value

Methods inherited from class com.vmware.cxfrestclient.AbstractCxfRestClient

configureClient, configureSSLTrustManager, createProxy, createWebClient, deleteResource, deleteResource, deleteResourceVoid, getEndpoint, getResource, getResource, 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

Methods inherited from interface com.vmware.cxfrestclient.JaxRsClient

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

Constructor Detail

VcdClientImpl

public VcdClientImpl(URI endpoint,
                     String apiVersion,
                     CxfClientSecurityContext cxfClientSecurityContext)

Creates an instance of VcdClientImpl with given endpoint, API version and cxfClientSecurityContext.

VcdClientImpl

public VcdClientImpl(URI endpoint,
                     List<com.vmware.vcloud.api.rest.version.ApiVersion> candidateVersions,
                     CxfClientSecurityContext cxfClientSecurityContext)

Creates an instance of VcdClientImpl with given endpoint, cxfClientSecurityContext and determines an ApiVersion supported by both given vCD endpoint, and given list of preferred API versions in candidateVersions

Parameters:

endpoint - URI of vCD

candidateVersions - a list of ApiVersions in order of most to least preferred by client

cxfClientSecurityContext - security context to use when communicating with given HTTPS vCD endpoint

Method Detail

createJAXBElementProviderFromObjectFactories

protected static List<org.apache.cxf.jaxrs.provider.JAXBElementProvider<?>> createJAXBElementProviderFromObjectFactories()

Creates a JAXBElementProvider that will return JAXBContexts that handle all the JAXB-generated types using object factories supplied to this method.

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.

getOpenApiEndpoint

protected URI getOpenApiEndpoint()

Gets the openApi endpoint.

getOrganizations

public List<com.vmware.vcloud.api.rest.schema_v1_5.ReferenceType> getOrganizations()

Description copied from interface: VcdClient

Gets the organizations defined/accessible in the vCloud server. VCloudClient#login must be called prior to calling this method.

Specified by:

getOrganizations in interface VcdClient

Returns:

list of organizations

getSession

public com.vmware.vcloud.api.rest.schema_v1_5.SessionType getSession()

Description copied from interface: VcdClient

Returns the SessionType for the current session

Specified by:

getSession in interface VcdClient

getSessionUserInfo

public com.vmware.vcloud.api.rest.schema_v1_5.MultisiteSessionUserInfoType getSessionUserInfo()

Description copied from interface: VcdClient

Returns the MultisiteSessionUserInfoType for the current session's user

Specified by:

getSessionUserInfo in interface VcdClient

getVersions

public com.vmware.vcloud.api.rest.schema.versioning.SupportedVersionsType getVersions()

Description copied from interface: VcdClient

Gets information about the vCloud API versions supported by the server.

Specified by:

getVersions in interface VcdClient

getClientApiVersion

public String getClientApiVersion()

Description copied from interface: VcdClient

Gets the API version used by the client for vCloud API requests

Specified by:

getClientApiVersion in interface VcdClient

getAdmin

public com.vmware.vcloud.api.rest.schema_v1_5.VCloudType getAdmin()

Description copied from interface: VcdClient

Returns the "admin" root resource type.

Specified by:

getAdmin in interface VcdClient

getExtension

public com.vmware.vcloud.api.rest.schema_v1_5.extension.VMWExtensionType getExtension()

Description copied from interface: VcdClient

Returns the "extension" root resource type.

Specified by:

getExtension in interface VcdClient

getQueryList

public com.vmware.vcloud.api.rest.schema_v1_5.QueryListType getQueryList()

Description copied from interface: VcdClient

Returns the list of supported queries.

Specified by:

getQueryList in interface VcdClient

getApiExtensibility

public com.vmware.vcloud.api.rest.schema_v1_5.ApiExtensibilityType getApiExtensibility()

Description copied from interface: VcdClient

Returns the Api Extensibility object

Specified by:

getApiExtensibility in interface VcdClient

getLoggedInOrg

public com.vmware.vcloud.api.rest.schema_v1_5.OrgType getLoggedInOrg()

Description copied from interface: VcdClient

Returns info about the org the session is logged in as.

Specified by:

getLoggedInOrg in interface VcdClient

resolveEntityById

public com.vmware.vcloud.api.rest.schema_v1_5.EntityType resolveEntityById(String id)

Description copied from interface: VcdClient

Returns information about the resource with the specified ID.

The class of the returned value corresponds to the media-type 'application/vnd.vmware.vcloud.entity', this means it's a strict instance of {link EntityType}, and not a specialization of EntityType.

Note that to fetch an entity and cast it to its specialized JAXB binding the methods #getEntity(ReferenceType, Class) and VcdClient.getEntity(ReferenceType, Class, ReferenceTypeChangedCallBack) are available.

Specified by:

resolveEntityById in interface VcdClient

Parameters:

id - the unique identifier of the entity to resolve

Returns:

an instance of EntityType

See Also:

#getEntity(ReferenceType, Class), VcdClient.getEntity(ReferenceType, Class, ReferenceTypeChangedCallBack)

getLoggedInAdminOrg

public com.vmware.vcloud.api.rest.schema_v1_5.AdminOrgType getLoggedInAdminOrg()

Description copied from interface: VcdClient

Returns info about the admin view of the org, the session is logged in as (if permitted).

Specified by:

getLoggedInAdminOrg in interface VcdClient

getOpenApiClient

public OpenApiClient getOpenApiClient()

Description copied from interface: VcdClient

Returns an OpenApiClient (which continues to use the existing session).

Specified by:

getOpenApiClient in interface VcdClient

getNsxProxyApiClient

public NsxProxyApiClient getNsxProxyApiClient()

Description copied from interface: VcdClient

Returns an NsxProxyApiClient (which continues to use the existing session).

Specified by:

getNsxProxyApiClient in interface VcdClient

getAcceptHeaders

protected String[] getAcceptHeaders()

Accept headers that must be included with the request.

Returns:

Appropriately formatted accept values in String format.

setAuthenticationHeader

public void setAuthenticationHeader(org.apache.cxf.jaxrs.client.Client client)

Description copied from interface: VcdClient

Sets the vCloud API authentication header in the specified JAX-RS Client object to be the one for this VcdClient.

Specified by:

setAuthenticationHeader in interface VcdClient

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.

getOrgContextHeader

public String getOrgContextHeader()

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

setOrgContextHeader

public void setOrgContextHeader(String orgContext)

Description copied from interface: VcdClient

Sets the X-VMWARE-VCLOUD-ORG-ID header to the specified value

Specified by:

setOrgContextHeader in interface VcdClient

login

public void login(ClientCredentials credentials)

Description copied from interface: VcdClient

Logs in to the remote vCloud API end point using the supplied credentials.

Specified by:

login in interface VcdClient

relogin

public void relogin()

Description copied from interface: VcdClient

Repeats login if client credentials are present. Throws a runtime exception if they are null.

Specified by:

relogin in interface VcdClient

loginWithJwt

public void loginWithJwt(String jwt,
                         String orgSecurityContext)

Description copied from interface: VcdClient

Reuses an existing session on the remote vCloud API end point using the supplied JWT taken from another VcdClient.

Specified by:

loginWithJwt in interface VcdClient

Parameters:

jwt - A JWT which represents an existing session from a VcdClient

orgSecurityContext - orgId of the org security context to make the request in. Used for Multisite requests. Pass null to use issuing org as the context.

loginWithToken

public void loginWithToken(VcdClient.SessionToken sessionToken)

Description copied from interface: VcdClient

Reuses an existing session on the remote vCloud API end point using the supplied session token taken from another VcdClient.

Specified by:

loginWithToken in interface VcdClient

Parameters:

sessionToken - An opaque token which represents an existing session from a VcdClient

getSessionToken

public VcdClient.SessionToken getSessionToken()

Description copied from interface: VcdClient

Get the current opaque session token for this client. This can be used to attach a new VcdClient to an existing logged in session.

Specified by:

getSessionToken in interface VcdClient

Returns:

The current session token for this client. null if there is none.

getJwtToken

public String getJwtToken()

Description copied from interface: VcdClient

Get the current JWT for this client. This can be used to attach a new VcdClient to an existing logged in session and for making a request to a different, associated, org.

Specified by:

getJwtToken in interface VcdClient

Returns:

The current JWT for this client. null if there is none.

logout

public void logout()

Description copied from interface: VcdClient

Logs out of the remote vCloud API end point

Specified by:

logout in interface VcdClient

duplicate

public VcdClient duplicate(boolean newSession)
                    throws VcdErrorException

Description copied from interface: VcdClient

Creates a clone of current VcdClient The new client will communicate with the same vCD as this client and is initialized with same credentials and CxfClientSecurityContext. The session may or may not be shared amond the 2 sessions.

Specified by:

duplicate in interface VcdClient

Parameters:

newSession - true if a new session should be created in the cloned client, false if both clients must share the session

Returns:

a new VcdClient

Throws:

VcdErrorException - if there were errors while initializing the cloned client

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

Overrides:

createWebClient in class AbstractCxfRestClient

getServerStatus

public javax.ws.rs.core.Response getServerStatus()

Description copied from interface: VcdClient

Retrieves the current server status from the api/server_status endpoint, adjusting the Accept headers as needed.

Specified by:

getServerStatus in interface VcdClient

Returns:

Response object containing response and http status code returned by the call.

getResource

public <ResourceClass> ResourceClass getResource(com.vmware.vcloud.api.rest.schema_v1_5.ResourceType resource,
                                                 RelationType rel,
                                                 String mediaType,
                                                 Class<ResourceClass> resourceClass)

Description copied from interface: VcdClient

Gets the contents of the resource referenced by the link with the specified rel and mediaType in the specified resource.

Specified by:

getResource in interface VcdClient

Type Parameters:

ResourceClass - JAXB-generated class of the linked-to resource

Parameters:

resource - the resource with the link

rel - the rel of the desired link

mediaType - media type of content

resourceClass - JAXB-generated class of the linked-to resource

Returns:

the contents of the linked-to resource

getResource

public <ResourceClass extends com.vmware.vcloud.api.rest.schema_v1_5.ResourceType> ResourceClass getResource(com.vmware.vcloud.api.rest.schema_v1_5.ResourceType resourceType,
                                                                                                             Class<ResourceClass> resourceClass)

Description copied from interface: VcdClient

Gets the contents of the resource referenced by its href

Specified by:

getResource in interface VcdClient

Type Parameters:

ResourceClass - JAXB-generated class of the linked-to resource

Parameters:

resourceType - the resource with the link

resourceClass - JAXB-generated class of the linked-to resource

Returns:

the contents of the linked-to resource

getResource

public <ResourceClass> ResourceClass getResource(com.vmware.vcloud.api.rest.schema_v1_5.ReferenceType reference,
                                                 Class<ResourceClass> resourceClass)

Description copied from interface: VcdClient

Convenience wrapper over JaxRsClient.getResource(java.net.URI, Class).

Specified by:

getResource in interface VcdClient

getEntity

public <ResponseClass extends com.vmware.vcloud.api.rest.schema_v1_5.EntityType> ResponseClass getEntity(String entityId,
                                                                                                         String mediaType,
                                                                                                         Class<ResponseClass> responseClass)

Description copied from interface: VcdClient

Resolve a vCloud entity using its identifier and then fetch the corresponding vCloud entity instance.

Specified by:

getEntity in interface VcdClient

Parameters:

entityId - the vCloud entity identifier to use to resolve the entity

mediaType - the media type corresponding to this entity

responseClass - the JAXB generated binding corresponding to the returned result

Returns:

a EntityType instance cast to its specific JAXB binding

See Also:

VcdClient.resolveEntityById(String), VcdClient.getEntity(ReferenceType, Class, ReferenceTypeChangedCallBack)

getEntity

public <T extends com.vmware.vcloud.api.rest.schema_v1_5.EntityType> T getEntity(com.vmware.vcloud.api.rest.schema_v1_5.ReferenceType referenceType,
                                                                                 Class<T> resourceClass,
                                                                                 VcdClient.ReferenceTypeChangedCallBack referenceTypeChangedCallBack)

Description copied from interface: VcdClient

Get an entity using a ReferenceType by first trying with its href and, when it fails, trying to recover using the vcd entity resolver service.

This method tolerates a ReferenceType instance where ReferenceType.getHref() might return null or an invalid href. When the href is invalid or null, an attempt is made at resolving a new href in order to GET the entity. This attempt is made possible by using the API endpoint associated to this VcdClient and the entity identifier set in the passed ReferenceType. The assumption is that the user of this API may persists the href of entities for some period of time, while the vCloud API endpoint may be changed independently later on. When an attempt to recover the entity href is successful, the passed VcdClient.ReferenceTypeChangedCallBack is invoked with the new href as a parameter.

In the context of this method, an invalid href is defined has a URL on which an HTTP GET fails, this happens when for example a href is:

• a null reference (the initial GET can be skipped in that case)
• or the host is not reachable,
• or the VCD server process on the host is unresponsive,
• or the path in the href is no longer supported by the VCD server process.

Specified by:

getEntity in interface VcdClient

Parameters:

referenceType - a ReferenceType of the entity to get

resourceClass - a specialized EntityType class

referenceTypeChangedCallBack - a VcdClient.ReferenceTypeChangedCallBack

Returns:

a EntityType corresponding to the given ReferenceType

putResource

public <ContentsClass,ResponseClass> ResponseClass putResource(com.vmware.vcloud.api.rest.schema_v1_5.ResourceType resource,
                                                               RelationType rel,
                                                               String mediaType,
                                                               JAXBElement<ContentsClass> contents,
                                                               Class<ResponseClass> responseClass)

Description copied from interface: VcdClient

Puts the contents to the resource referenced by the link with the specified rel and mediaType in the specified resource

Specified by:

putResource in interface VcdClient

Type Parameters:

ContentsClass - JAXB-generated class of the request contents

ResponseClass - JAXB-generated class of the response

Parameters:

resource - the resource with the link

rel - the rel of the desired link

mediaType - media type of content

contents - the contents to be put

responseClass - JAXB-generated class of the response

Returns:

response from the put request

putResource

public <ContentsClass,ResponseClass> ResponseClass putResource(com.vmware.vcloud.api.rest.schema_v1_5.ReferenceType reference,
                                                               String mediaType,
                                                               JAXBElement<ContentsClass> contents,
                                                               Class<ResponseClass> responseClass)

Description copied from interface: VcdClient

Convenience wrapper over {@link JaxRsClient#putResource(java.net.URI, String, JAXBElement, Class)

Specified by:

putResource in interface VcdClient

putResource

public <ContentsClass extends com.vmware.vcloud.api.rest.schema_v1_5.ResourceType,ResponseClass> ResponseClass putResource(String mediaType,
                                                                                                                           JAXBElement<ContentsClass> contents,
                                                                                                                           Class<ResponseClass> responseClass)

Description copied from interface: VcdClient

Like VcdClient.putResource(ReferenceType, String, JAXBElement, Class) except constrains the type of the contents parameter to be a type that has an href field and assumes that field has been populated (which, for example, it will naturally if was returned by a getResource call and then modified for use in this call).

Specified by:

putResource in interface VcdClient

Type Parameters:

ContentsClass - JAXB-generated class of the request contents

ResponseClass - JAXB-generated class of the response

Parameters:

mediaType - media type of the content

contents - the contents to put; contents.getHref() must be valid and identify the resource to be modified

responseClass - JAXB-generated class of the response

Returns:

response from the put request

postResource

public <ContentsClass,ResponseClass> ResponseClass postResource(com.vmware.vcloud.api.rest.schema_v1_5.ResourceType resource,
                                                                RelationType rel,
                                                                String mediaType,
                                                                JAXBElement<ContentsClass> contents,
                                                                Class<ResponseClass> responseClass)

Description copied from interface: VcdClient

Posts the contents to the resource referenced by the link with the specified rel and mediaType in the specified resource

Specified by:

postResource in interface VcdClient

Type Parameters:

ContentsClass - JAXB-generated class of the request contents

ResponseClass - JAXB-generated class of the response

Parameters:

resource - the resource with the link

rel - the rel of the desired link

mediaType - media type of content

contents - the contents to be post

responseClass - JAXB-generated class of the response

Returns:

response from the post request

postResource

public <ContentsClass,ResponseClass> ResponseClass postResource(com.vmware.vcloud.api.rest.schema_v1_5.ReferenceType reference,
                                                                String mediaType,
                                                                JAXBElement<ContentsClass> contents,
                                                                Class<ResponseClass> responseClass)

Description copied from interface: VcdClient

Convenience wrapper over JaxRsClient.postResource(java.net.URI, String, JAXBElement, Class)

Specified by:

postResource in interface VcdClient

makeException

protected VcdErrorException makeException(javax.ws.rs.WebApplicationException webApplicationException)

Overrides:

makeException in class AbstractCxfRestClient

removeResource

public javax.ws.rs.core.Response removeResource(com.vmware.vcloud.api.rest.schema_v1_5.ResourceType resource)

Description copied from interface: VcdClient

Deletes the resource described by the specified resource type. The target for the HTTP DELETE request is determined by looking for a "remove" link (RelationType.REMOVE) in the specified resource type (whose associated URL might or might not be the same as the value of the resource type's "href" field).

Specified by:

removeResource in interface VcdClient

removeResource

public <ResponseClass> ResponseClass removeResource(com.vmware.vcloud.api.rest.schema_v1_5.ResourceType resource,
                                                    Boolean force,
                                                    Boolean recursive,
                                                    Class<ResponseClass> responseClass)

Description copied from interface: VcdClient

Deletes the resource described by the specified resource type. The target for the HTTP DELETE request is determined by looking for a "remove" link (RelationType.REMOVE) in the specified resource type (whose associated URL might or might not be the same as the value of the resource type's "href" field).

Specified by:

removeResource in interface VcdClient

force - forces the resource to be deleted without regard to its state; child objects will not be removed unless recursive delete is also asserted; null indicates that this parameter will be omitted

recursive - recursively removes this resource and its children; null indicates that this parameter will be omitted

deleteResource

public <ResponseClass> ResponseClass deleteResource(com.vmware.vcloud.api.rest.schema_v1_5.ReferenceType ref,
                                                    Class<ResponseClass> responseClass)

Description copied from interface: VcdClient

Convenience wrapper over {@link JaxRsClient#deleteResource(java.net.URI, Class).

Specified by:

deleteResource in interface VcdClient

deleteResource

public <ResponseClass> ResponseClass deleteResource(com.vmware.vcloud.api.rest.schema_v1_5.ResourceType ref,
                                                    Class<ResponseClass> responseClass)

Description copied from interface: VcdClient

Convenience wrapper over {@link JaxRsClient#deleteResource(java.net.URI, Class).

Specified by:

deleteResource in interface VcdClient

deleteResource

public <ResponseClass> ResponseClass deleteResource(com.vmware.vcloud.api.rest.schema_v1_5.ResourceType resource,
                                                    Boolean force,
                                                    Boolean recursive,
                                                    Class<ResponseClass> responseClass)

Description copied from interface: VcdClient

Deletes the resource described by the specified resource type. The target for the HTTP DELETE request is the "href" of the ResourceType itself.

Specified by:

deleteResource in interface VcdClient

force - forces the resource to be deleted without regard to its state; child objects will not be removed unless recursive delete is also asserted; null indicates that this parameter will be omitted

recursive - recursively removes this resource and its children; null indicates that this parameter will be omitted

deleteResource

public <ResponseClass> ResponseClass deleteResource(com.vmware.vcloud.api.rest.schema_v1_5.ReferenceType ref,
                                                    Boolean force,
                                                    Boolean recursive,
                                                    Class<ResponseClass> responseClass)

Description copied from interface: VcdClient

Convenience wrapper over {@link JaxRsClient#deleteResource(java.net.URI, Class).

Specified by:

deleteResource in interface VcdClient

force - forces the resource to be deleted without regard to its state; child objects will not be removed unless recursive delete is also asserted; null indicates that this parameter will be omitted

recursive - recursively removes this resource and its children; null indicates that this parameter will be omitted

getVCloudObjectFactory

public com.vmware.vcloud.api.rest.schema_v1_5.ObjectFactory getVCloudObjectFactory()

Description copied from interface: VcdClient

Returns an object factory for vCD API schema classes.

Specified by:

getVCloudObjectFactory in interface VcdClient

getVCloudExtensionObjectFactory

public com.vmware.vcloud.api.rest.schema_v1_5.extension.ObjectFactory getVCloudExtensionObjectFactory()

Description copied from interface: VcdClient

Returns an object factory for vCD Extension API schema classes.

Specified by:

getVCloudExtensionObjectFactory in interface VcdClient

getOvfObjectFactory

public com.vmware.vcloud.api.rest.schema.ovf.ObjectFactory getOvfObjectFactory()

Description copied from interface: VcdClient

Returns an object factory for OVF schema classes.

Specified by:

getOvfObjectFactory in interface VcdClient

getOvfVmwareObjectFactory

public com.vmware.vcloud.api.rest.schema.ovf.vmware.ObjectFactory getOvfVmwareObjectFactory()

Description copied from interface: VcdClient

Returns an object factory VMware-specific OVF schema classes.

Specified by:

getOvfVmwareObjectFactory in interface VcdClient

getTaskMonitor

public VcdTaskMonitor getTaskMonitor()

Description copied from interface: VcdClient

Returns task monitor, which can be used to monitor specific task returned by POST or PUT requests.

Specified by:

getTaskMonitor in interface VcdClient

getEventViewer

public EventViewer getEventViewer()

Specified by:

getEventViewer in interface VcdClient

Returns:

an instance of EventViewer.

setMultisiteRequests

public void setMultisiteRequests(boolean federateRequests)

Description copied from interface: VcdClient

Controls whether requests made with this client request federated behavior or not.

Specified by:

setMultisiteRequests in interface VcdClient

setClientRequestIdProvider

public void setClientRequestIdProvider(VcdClient.ClientRequestIdProvider clientRequestIdGenerator)

Specified by:

setClientRequestIdProvider in interface VcdClient

Parameters:

clientRequestIdGenerator - VcdClient.ClientRequestIdProvider to use to populate client request ID in requests to VCD

getQuery

public <QueryResultClass> VcdClient.Query<QueryResultClass> getQuery(String queryTypeName,
                                                                     Class<QueryResultClass> queryResultClass)

Description copied from interface: VcdClient

Returns an instance of the VcdClient.Query object for the given query type name and query result type.

Specified by:

getQuery in interface VcdClient

Parameters:

queryTypeName - Query type name

queryResultClass - Type of query results. Must be ReferenceType or a type derived from QueryResultRecordType.

Returns:

an instance of the VcdClient.Query object

getPackagedQuery

public <QueryResultClass> VcdClient.Query<QueryResultClass> getPackagedQuery(String queryPath,
                                                                             Class<QueryResultClass> queryResultClass)

Description copied from interface: VcdClient

Returns an instance of the VcdClient.Query object for a packaged query and query result type.

Specified by:

getPackagedQuery in interface VcdClient

Parameters:

queryPath - packaged query path in the format /{package}/query

queryResultClass - Type of query results. Must be ReferenceType or a type derived from QueryResultRecordType.

Returns:

an instance of the VcdClient.Query object

setCredentials

public void setCredentials(ClientCredentials credentials)

Description copied from interface: VcdClient

Sets the credentials used for authentication. If the credentials are not session-less, a login is immediately performed.

Specified by:

setCredentials in interface VcdClient

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