com.vmware.vcloud.api.rest.client

Interface VcdClient

All Superinterfaces:

JaxRsClient

All Known Implementing Classes:

VcdClientImpl

public interface VcdClient
extends JaxRsClient

A vCloud REST API client. Extends JaxRsClient with behaviors specific to the vCloud REST API.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	VcdClient.ClientRequestIdProvider Returns client request ID to use when making request to VCD.
static interface	VcdClient.Query<QueryResultClass> Represents a query which can be executed against VCD.
static class	VcdClient.QueryListPage<T> A generic class to store the List of items of the specified class, which are returned by a typed query, and the total number of matching items, which might be greater than the number of items returned.
static interface	VcdClient.ReferenceTypeChangedCallBack A callback contract to inform the caller that a href value has been repaired.
static interface	VcdClient.SessionToken An token that can be retrieved from one VcdClient to attach another VcdClient to the same session.

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

JaxRsClient.ErrorHandler

Field Summary

Fields inherited from interface com.vmware.cxfrestclient.JaxRsClient

EMPTY_CONTENTS

Method Summary

Modifier and Type	Method and Description
<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.
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
<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).
List<com.vmware.vcloud.api.rest.schema_v1_5.ReferenceType>	getOrganizations() Gets the organizations defined/accessible in the vCloud server.
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 packagedQueryPath, 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 ref, 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 resource, 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) Deprecated.
void	loginWithJwt(String jwt, String orgIdSecurityContext) 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
<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 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.
void	setClientRequestIdProvider(VcdClient.ClientRequestIdProvider clientRequestIdProvider)
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 interface com.vmware.cxfrestclient.JaxRsClient

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

Method Detail

getVersions

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

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

getClientApiVersion

String getClientApiVersion()

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

login

@Deprecated
void login(ClientCredentials credentials)

Deprecated.

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

relogin

void relogin()

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

setCredentials

void setCredentials(ClientCredentials credentials)

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

loginWithToken

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.

Parameters:

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

loginWithJwt

void loginWithJwt(String jwt,
                  String orgIdSecurityContext)

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

Parameters:

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

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

logout

void logout()

Logs out of the remote vCloud API end point

duplicate

VcdClient duplicate(boolean newSession)
             throws VcdErrorException

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.

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

setClientRequestIdProvider

void setClientRequestIdProvider(VcdClient.ClientRequestIdProvider clientRequestIdProvider)

Parameters:

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

getSessionToken

VcdClient.SessionToken getSessionToken()

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

Returns:

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

getJwtToken

String getJwtToken()

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.

Returns:

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

getServerStatus

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

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

Returns:

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

getResource

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

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

getEntity

<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.

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.

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

getResource

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

Gets the contents of the resource referenced by its href

Type Parameters:

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

Parameters:

resource - the resource with the link

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

Returns:

the contents of the linked-to resource

getResource

<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.

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

putResource

<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)

putResource

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

Like 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).

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

putResource

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

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

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

Throws:

VcdErrorException - put request completes with error.

postResource

<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)

postResource

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

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

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

Throws:

VcdErrorException - post request completes with error.

deleteResource

<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).

deleteResource

<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).

Parameters:

ref -

responseClass -

removeResource

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

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).

Throws:

VcdErrorException - delete request completes with error.

deleteResource

<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).

Parameters:

ref -

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

responseClass -

deleteResource

<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. The target for the HTTP DELETE request is the "href" of the ResourceType itself.

Parameters:

resource -

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

responseClass -

removeResource

<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. 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).

Parameters:

resource -

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

responseClass -

getOrganizations

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

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

Returns:

list of organizations

Throws:

IllegalStateException - if called when not logged in

getLoggedInOrg

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

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

Throws:

IllegalStateException - if called when not logged in

getLoggedInAdminOrg

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).

Throws:

MissingLinkException - if link is unavailable because the user may not have access to it.

getSession

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

Returns the SessionType for the current session

Throws:

IllegalStateException - if called when not logged in

getSessionUserInfo

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

Returns the MultisiteSessionUserInfoType for the current session's user

Throws:

IllegalStateException - if called when not logged in

getAdmin

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

Returns the "admin" root resource type.

Throws:

IllegalStateException - if called when not logged in

getOpenApiClient

OpenApiClient getOpenApiClient()

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

getNsxProxyApiClient

NsxProxyApiClient getNsxProxyApiClient()

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

getExtension

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

Returns the "extension" root resource type.

Throws:

IllegalStateException - if called when not logged in

getQueryList

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

Returns the list of supported queries.

Throws:

IllegalStateException - if called when not logged in

getApiExtensibility

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

Returns the Api Extensibility object

Throws:

IllegalStateException - if called when not logged in

resolveEntityById

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

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 getEntity(ReferenceType, Class, ReferenceTypeChangedCallBack) are available.

Parameters:

id - the unique identifier of the entity to resolve

Returns:

an instance of EntityType

Throws:

IllegalStateException - if called when not logged in

See Also:

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

getEntity

<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.

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:

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

getVCloudObjectFactory

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

Returns an object factory for vCD API schema classes.

getVCloudExtensionObjectFactory

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

Returns an object factory for vCD Extension API schema classes.

getOvfObjectFactory

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

Returns an object factory for OVF schema classes.

getOvfVmwareObjectFactory

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

Returns an object factory VMware-specific OVF schema classes.

getTaskMonitor

VcdTaskMonitor getTaskMonitor()

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

getEventViewer

EventViewer getEventViewer()

Returns:

an instance of EventViewer.

setMultisiteRequests

void setMultisiteRequests(boolean federateRequests)

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

Parameters:

federateRequests -

setAuthenticationHeader

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.

Throws:

IllegalStateException - if called when not logged in

setOrgContextHeader

void setOrgContextHeader(String orgContext)

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

getQuery

<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.

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

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

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

Parameters:

packagedQueryPath - 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