Skip navigation links
A B C D E F G H I J L M N O P Q R S T U V W X 

A

AbstractCxfRestClient - Class in com.vmware.cxfrestclient
Base class for implementations of JaxRsClient that are based on CXF.
AbstractCxfRestClient(URI) - Constructor for class com.vmware.cxfrestclient.AbstractCxfRestClient
 
AbstractCxfRestClient(URI, CxfClientSecurityContext) - Constructor for class com.vmware.cxfrestclient.AbstractCxfRestClient
 
AbstractCxfRestClient(AbstractCxfRestClient) - Constructor for class com.vmware.cxfrestclient.AbstractCxfRestClient
 
AbstractCxfRestClient(URI, AbstractCxfRestClient) - Constructor for class com.vmware.cxfrestclient.AbstractCxfRestClient
 
ADMIN_ORGANIZATION - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.MediaType
 
API_EXTENSIBILITY - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.MediaType
 
API_VERSION_5_7 - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants
 
API_VERSION_ATTR - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants
 
apiVersion() - Method in enum com.vmware.vcloud.api.rest.client.constants.RelationType
 
APPLICATION_JSON - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.MediaType
 
AUTH_TYPE - Static variable in class com.vmware.vcloud.api.rest.client.VcdMultisiteLoginCredentials
 

B

buildDeleteUri(URI, Boolean, Boolean) - Static method in class com.vmware.vcloud.api.rest.client.VcdUtils
Constructs a URI which has the correct delete parameters set as URL parameters if applicable

C

ClientCredentials - Interface in com.vmware.vcloud.api.rest.client
Abstract credentials for use in authenticating REST/HTTP sessions.
com.vmware.cxfrestclient - package com.vmware.cxfrestclient
 
com.vmware.vcloud.api.rest.client - package com.vmware.vcloud.api.rest.client
Contains necessary client(s) to facilitate API calls to vCloud Director
com.vmware.vcloud.api.rest.client.constants - package com.vmware.vcloud.api.rest.client.constants
 
com.vmware.vcloud.api.rest.client.filters - package com.vmware.vcloud.api.rest.client.filters
 
com.vmware.vcloud.api.rest.client.impl - package com.vmware.vcloud.api.rest.client.impl
 
com.vmware.vcloud.api.rest.client.impl.tasks - package com.vmware.vcloud.api.rest.client.impl.tasks
 
configureClient(Object) - Method in class com.vmware.cxfrestclient.AbstractCxfRestClient
 
configureHttpRequestHeaders(Client) - Method in class com.vmware.cxfrestclient.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.
configureSSLTrustManager(ClientConfiguration) - Method in class com.vmware.cxfrestclient.AbstractCxfRestClient
Set the appropriate ssl context and https hostname verification for this client
createJAXBElementProviderFromObjectFactories() - Static method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
Creates a JAXBElementProvider that will return JAXBContexts that handle all the JAXB-generated types using object factories supplied to this method.
createMultisiteAuthorizationHeader(String, String, String, byte[]) - Method in class com.vmware.vcloud.api.rest.client.VcdMultisiteLoginCredentials
Create the multisite authorization header from the provided information
createProxy(Class<JaxRsClass>) - Method in class com.vmware.cxfrestclient.AbstractCxfRestClient
 
createProxy(Class<JaxRsClass>) - Method in interface com.vmware.cxfrestclient.JaxRsClient
Gets a proxy for the specified service.
createWebClient(URI) - Method in class com.vmware.cxfrestclient.AbstractCxfRestClient
 
createWebClient(URI, String) - Method in class com.vmware.cxfrestclient.AbstractCxfRestClient
 
createWebClient(URI, String) - Method in interface com.vmware.cxfrestclient.JaxRsClient
Returns a CXF WebClient corresponding to the specified URI.
createWebClient(URI) - Method in interface com.vmware.cxfrestclient.JaxRsClient
Returns a CXF WebClient corresponding to the specified URI.
createWebClient(URI, String) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
CxfClientSecurityContext - Class in com.vmware.cxfrestclient
A security context for AbstractCxfRestClient to control select SSL connection and https verification parameters

D

DEFAULT_CIPHER_LIST - Static variable in class com.vmware.cxfrestclient.CxfClientSecurityContext
 
DEFAULT_LINKS - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.QueryParams
 
DEFAULT_MAX_PAGE_SIZE - Static variable in interface com.vmware.vcloud.api.rest.client.VcdClient.Query
 
DEFAULT_PAGE - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.QueryParams
 
DEFAULT_PAGE_SIZE - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.QueryParams
 
DEFAULT_PROTOCOL_LIST - Static variable in class com.vmware.cxfrestclient.CxfClientSecurityContext
 
deleteResource(URI) - Method in class com.vmware.cxfrestclient.AbstractCxfRestClient
 
deleteResource(URI, Class<ResponseClass>) - Method in class com.vmware.cxfrestclient.AbstractCxfRestClient
 
deleteResource(URI) - Method in interface com.vmware.cxfrestclient.JaxRsClient
Deletes the specified resource.
deleteResource(URI, Class<ResponseClass>) - Method in interface com.vmware.cxfrestclient.JaxRsClient
Deletes the specified contents to the specified resource.
deleteResource(ReferenceType, Class<ResponseClass>) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Convenience wrapper over {@link JaxRsClient#deleteResource(java.net.URI, Class).
deleteResource(ResourceType, Class<ResponseClass>) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Convenience wrapper over {@link JaxRsClient#deleteResource(java.net.URI, Class).
deleteResource(ReferenceType, Boolean, Boolean, Class<ResponseClass>) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Convenience wrapper over {@link JaxRsClient#deleteResource(java.net.URI, Class).
deleteResource(ResourceType, Boolean, Boolean, Class<ResponseClass>) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Deletes the resource described by the specified resource type.
deleteResource(ReferenceType, Class<ResponseClass>) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
deleteResource(ResourceType, Class<ResponseClass>) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
deleteResource(ResourceType, Boolean, Boolean, Class<ResponseClass>) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
deleteResource(ReferenceType, Boolean, Boolean, Class<ResponseClass>) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
deleteResourceVoid(URI) - Method in class com.vmware.cxfrestclient.AbstractCxfRestClient
 
deleteResourceVoid(URI) - Method in interface com.vmware.cxfrestclient.JaxRsClient
Deletes the specified resource and expects a HTTP 204 response status.
duplicate(boolean) - Method in interface com.vmware.vcloud.api.rest.client.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.
duplicate(boolean) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 

E

EMPTY_CONTENTS - Static variable in interface com.vmware.cxfrestclient.JaxRsClient
 
endpoint - Variable in class com.vmware.cxfrestclient.AbstractCxfRestClient
 
ENTITY - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.MediaType
 
equals(Object) - Method in class com.vmware.cxfrestclient.CxfClientSecurityContext
 
equals(Object) - Method in class com.vmware.vcloud.api.rest.client.VcdBasicLoginCredentials
 
equals(Object) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl.SessionTokenImpl
 
EventViewer - Interface in com.vmware.vcloud.api.rest.client
Helper methods to search for events.
EventViewerImpl - Class in com.vmware.vcloud.api.rest.client.impl
 
EventViewerImpl(VcdClient) - Constructor for class com.vmware.vcloud.api.rest.client.impl.EventViewerImpl
 
execute() - Method in interface com.vmware.vcloud.api.rest.client.VcdClient.Query
Executes the query and returns an iterator over list of pages of results.

F

FIELDS - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.QueryParams
 
FILTER - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.QueryParams
 
filter(ClientRequestContext) - Method in class com.vmware.vcloud.api.rest.client.filters.MultisiteAuthorizationFilter
 
findLink(ResourceType, LinkRelation, String) - Static method in class com.vmware.vcloud.api.rest.client.VcdUtils
Returns the link of the specified rel and type in the specified resource
findLink(ResourceType, LinkRelation, String, boolean) - Static method in class com.vmware.vcloud.api.rest.client.VcdUtils
Returns the link of the specified rel and type in the specified resource
findUnique() - Method in interface com.vmware.vcloud.api.rest.client.VcdClient.Query
Convenience wrapper over VcdClient.Query.execute() for the case where exactly one match is expected.
FORCE - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.DeleteParameters
Forced deletion
from(String) - Static method in enum com.vmware.vcloud.api.rest.client.TaskStatus
 

G

getAcceptHeaders() - Method in class com.vmware.vcloud.api.rest.client.NsxProxyApiClient
 
getAcceptHeaders() - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getAdmin() - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Returns the "admin" root resource type.
getAdmin() - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getApiExtensibility() - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Returns the Api Extensibility object
getApiExtensibility() - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getApiString() - Method in enum com.vmware.vcloud.api.rest.client.QueryResultFormat
 
getAuthenticationToken() - Method in interface com.vmware.vcloud.api.rest.client.VcdClient.SessionToken
 
getAuthenticationToken() - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl.SessionTokenImpl
 
getCause() - Method in exception com.vmware.vcloud.api.rest.client.VcdErrorException
Returns the original WebApplicationException returned by the framework
getCharsetAsString(MediaType) - Static method in class com.vmware.vcloud.api.rest.client.XStreamXmlProvider
 
getClientApiVersion() - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Gets the API version used by the client for vCloud API requests
getClientApiVersion() - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getClientRequestId() - Method in interface com.vmware.vcloud.api.rest.client.VcdClient.ClientRequestIdProvider
 
getCxfClientSecurityContext(KeyStore, char[], KeyStore, Collection<String>, boolean) - Static method in class com.vmware.cxfrestclient.CxfClientSecurityContext
Factory method to get a context that will configure AbstractCxfRestClient's SSL Handshake context and hostname verifier as specified by the input provided
getCxfClientSecurityContext(KeyStore, char[], KeyStore, Collection<String>, Collection<String>, boolean) - Static method in class com.vmware.cxfrestclient.CxfClientSecurityContext
Factory method to get a context that will configure AbstractCxfRestClient's SSL Handshake context and hostname verifier as specified by the input provided
getCxfClientSecurityContext(SSLSocketFactory, boolean) - Static method in class com.vmware.cxfrestclient.CxfClientSecurityContext
Factory method to get a context that will configure AbstractCxfRestClient's SSL Handshake context and hostname verifier as specified by the input provided
getCxfProviders() - Method in class com.vmware.cxfrestclient.AbstractCxfRestClient
 
getCxfProviders() - Method in class com.vmware.vcloud.api.rest.client.NsxProxyApiClient
 
getCxfProviders() - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getDefaultCxfClientSecurityContext() - Static method in class com.vmware.cxfrestclient.CxfClientSecurityContext
Factory method to get a context that will configure AbstractCxfRestClient to use system default key managers, trust managers and cipher suites for SSL Handshake and system default hostname verifier for https
getEndpoint() - Method in class com.vmware.cxfrestclient.AbstractCxfRestClient
 
getEndpoint() - Method in interface com.vmware.cxfrestclient.JaxRsClient
Retrieves the endpoint used to create this client
getEntity(ReferenceType, Class<T>, VcdClient.ReferenceTypeChangedCallBack) - Method in interface com.vmware.vcloud.api.rest.client.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.
getEntity(String, String, Class<ResponseClass>) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Resolve a vCloud entity using its identifier and then fetch the corresponding vCloud entity instance.
getEntity(String, String, Class<ResponseClass>) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getEntity(ReferenceType, Class<T>, VcdClient.ReferenceTypeChangedCallBack) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getEntityId(EntityType) - Static method in class com.vmware.vcloud.api.rest.client.VcdUtils
Gets an entity's ID in a form that can be used as an input parameter to a service method that expects an ID.
getError() - Method in exception com.vmware.vcloud.api.rest.client.VcdTaskException
 
getErrorMessage() - Method in exception com.vmware.vcloud.api.rest.client.VcdTaskException
 
getErrorResponseProcessingException() - Method in exception com.vmware.vcloud.api.rest.client.VcdErrorResponseProcessingException
 
getEventViewer() - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
 
getEventViewer() - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getExtension() - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Returns the "extension" root resource type.
getExtension() - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getFilterBuilder() - Static method in interface com.vmware.vcloud.api.rest.client.VcdClient.Query
Return a SearchConditionBuilder - Apache CXF's FIQL Query builder configured for use as per URL query format requirements
getHeaderName() - Method in interface com.vmware.vcloud.api.rest.client.ClientCredentials
Returns the name of the HTTP header used for authentication in a REST request
getHeaderName() - Method in class com.vmware.vcloud.api.rest.client.VcdBasicLoginCredentials
 
getHeaderName() - Method in class com.vmware.vcloud.api.rest.client.VcdBearerLoginCredentials
 
getHeaderName() - Method in class com.vmware.vcloud.api.rest.client.VcdMultisiteLoginCredentials
 
getHeaderName() - Method in class com.vmware.vcloud.api.rest.client.VcdSignLoginCredentials
 
getHeaderValue() - Method in interface com.vmware.vcloud.api.rest.client.ClientCredentials
Renders client authentication credentials in a form suitable to be used as the value in a header whose name is returned by ClientCredentials.getHeaderName()
getHeaderValue() - Method in class com.vmware.vcloud.api.rest.client.VcdBasicLoginCredentials
 
getHeaderValue() - Method in class com.vmware.vcloud.api.rest.client.VcdBearerLoginCredentials
 
getHeaderValue() - Method in class com.vmware.vcloud.api.rest.client.VcdMultisiteLoginCredentials
 
getHeaderValue() - Method in class com.vmware.vcloud.api.rest.client.VcdSignLoginCredentials
 
getHttpStatusCode() - Method in exception com.vmware.vcloud.api.rest.client.VcdErrorException
 
getJwtToken() - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Get the current JWT for this client.
getJwtToken() - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getLabel() - Method in enum com.vmware.vcloud.api.rest.client.TaskStatus
Getter for TaskStatus.label
getLatestEvent(String) - Method in interface com.vmware.vcloud.api.rest.client.EventViewer
Returns the latest event of specified type.
getLatestEvent(String) - Method in class com.vmware.vcloud.api.rest.client.impl.EventViewerImpl
 
getLinks(ResourceType, LinkRelation, String) - Static method in class com.vmware.vcloud.api.rest.client.VcdUtils
Returns all the links of the specified rel and type in the specified resource
getLoggedInAdminOrg() - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Returns info about the admin view of the org, the session is logged in as (if permitted).
getLoggedInAdminOrg() - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getLoggedInOrg() - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Returns info about the org the session is logged in as.
getLoggedInOrg() - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getMediaType() - Method in exception com.vmware.vcloud.api.rest.client.LinkException
 
getMediaType() - Method in enum com.vmware.vcloud.api.rest.client.QueryResultFormat
 
getMessage() - Method in exception com.vmware.vcloud.api.rest.client.VcdErrorException
 
getMessage() - Method in exception com.vmware.vcloud.api.rest.client.VcdErrorResponseException
 
getMessage() - Method in exception com.vmware.vcloud.api.rest.client.VcdErrorResponseProcessingException
 
getMessage() - Method in exception com.vmware.vcloud.api.rest.client.VcdTaskException
 
getMultiTaskTracker() - Method in class com.vmware.vcloud.api.rest.client.impl.tasks.VcdTaskMonitorImpl
 
getMultiTaskTracker() - Method in interface com.vmware.vcloud.api.rest.client.VcdTaskMonitor
Get a new instance of VcdTaskMonitor.MultiTaskTracker that will track all tasks that complete after this call.
getNsxProxyApiClient() - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Returns an NsxProxyApiClient (which continues to use the existing session).
getNsxProxyApiClient() - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getOpenApiClient() - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Returns an OpenApiClient (which continues to use the existing session).
getOpenApiClient() - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getOpenApiEndpoint() - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
Gets the openApi endpoint.
getOrganizations() - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Gets the organizations defined/accessible in the vCloud server.
getOrganizations() - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getOrgContextHeader() - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getOvfObjectFactory() - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Returns an object factory for OVF schema classes.
getOvfObjectFactory() - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getOvfVmwareObjectFactory() - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Returns an object factory VMware-specific OVF schema classes.
getOvfVmwareObjectFactory() - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getOwner() - Method in exception com.vmware.vcloud.api.rest.client.VcdTaskException
 
getPackagedQuery(String, Class<QueryResultClass>) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Returns an instance of the VcdClient.Query object for a packaged query and query result type.
getPackagedQuery(String, Class<QueryResultClass>) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getPage() - Method in class com.vmware.vcloud.api.rest.client.VcdClient.QueryListPage
 
getQuery(String, Class<QueryResultClass>) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Returns an instance of the VcdClient.Query object for the given query type name and query result type.
getQuery(String, Class<QueryResultClass>) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getQueryList() - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Returns the list of supported queries.
getQueryList() - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getRel() - Method in exception com.vmware.vcloud.api.rest.client.LinkException
 
getRequestId() - Method in exception com.vmware.vcloud.api.rest.client.VcdErrorResponseException
 
getResource(URI) - Method in class com.vmware.cxfrestclient.AbstractCxfRestClient
 
getResource(URI, Class<ResourceClass>) - Method in class com.vmware.cxfrestclient.AbstractCxfRestClient
 
getResource(URI) - Method in interface com.vmware.cxfrestclient.JaxRsClient
Gets the specified contents to the specified resource.
getResource(URI, Class<ResourceClass>) - Method in interface com.vmware.cxfrestclient.JaxRsClient
Gets the contents of the specified resource.
getResource(ReferenceType, Class<ResourceClass>) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
getResource(ResourceType, Class<ResourceClass>) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Gets the contents of the resource referenced by its href
getResource(ResourceType, RelationType, String, Class<ResourceClass>) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Gets the contents of the resource referenced by the link with the specified rel and mediaType in the specified resource.
getResource(ResourceType, RelationType, String, Class<ResourceClass>) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getResource(ResourceType, Class<ResourceClass>) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getResource(ReferenceType, Class<ResourceClass>) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getServerStatus() - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Retrieves the current server status from the api/server_status endpoint, adjusting the Accept headers as needed.
getServerStatus() - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getSession() - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Returns the SessionType for the current session
getSession() - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getSessionToken() - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Get the current opaque session token for this client.
getSessionToken() - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getSessionUserInfo() - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Returns the MultisiteSessionUserInfoType for the current session's user
getSessionUserInfo() - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getSingleEvent(String, String) - Method in interface com.vmware.vcloud.api.rest.client.EventViewer
Returns an event of specified type for the specified entity.
getSingleEvent(String, String) - Method in class com.vmware.vcloud.api.rest.client.impl.EventViewerImpl
 
getSize(Object, Class<?>, Type, Annotation[], MediaType) - Method in class com.vmware.vcloud.api.rest.client.XStreamXmlProvider
 
getSSLSocketFactory() - Method in class com.vmware.cxfrestclient.CxfClientSecurityContext
 
getTask(T) - Static method in class com.vmware.vcloud.api.rest.client.VcdUtils
Convenience method to get TaskType from given resource.
getTaskMonitor() - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Returns task monitor, which can be used to monitor specific task returned by POST or PUT requests.
getTaskMonitor() - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getTotalItemCount() - Method in class com.vmware.vcloud.api.rest.client.VcdClient.QueryListPage
 
getVcdError() - Method in exception com.vmware.vcloud.api.rest.client.VcdErrorResponseException
 
getVCloudExtensionObjectFactory() - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Returns an object factory for vCD Extension API schema classes.
getVCloudExtensionObjectFactory() - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getVCloudObjectFactory() - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Returns an object factory for vCD API schema classes.
getVCloudObjectFactory() - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getVCloudToken() - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl.SessionTokenImpl
 
getVersions() - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Gets information about the vCloud API versions supported by the server.
getVersions() - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
getWebClientForNextCall(JaxRsClass) - Method in interface com.vmware.vcloud.api.rest.client.OpenApiClient
Returns the underlying Client for next call only.
getXStream(Class) - Method in class com.vmware.vcloud.api.rest.client.XStreamXmlProvider
 

H

handleError(JaxRsClient, URI, WebApplicationException, int) - Method in interface com.vmware.cxfrestclient.JaxRsClient.ErrorHandler
Returns an indication of whether a request made to the specified URI which failed with the specified exception should be retried or failed.
hashCode() - Method in class com.vmware.cxfrestclient.CxfClientSecurityContext
 
hashCode() - Method in class com.vmware.vcloud.api.rest.client.VcdBasicLoginCredentials
 
hrefChanged(String) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient.ReferenceTypeChangedCallBack
Invoked when an href is automatically repaired.

I

IDRECORDS - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.MediaType
 
isReadable(Class<?>, Type, Annotation[], MediaType) - Method in class com.vmware.vcloud.api.rest.client.XStreamXmlProvider
 
isWriteable(Class<?>, Type, Annotation[], MediaType) - Method in class com.vmware.vcloud.api.rest.client.XStreamXmlProvider
 

J

JaxRsClient - Interface in com.vmware.cxfrestclient
A REST API client.
JaxRsClient.ErrorHandler - Interface in com.vmware.cxfrestclient
The interface used when requests fail.
JaxRsClient.ErrorHandler.Disposition - Enum in com.vmware.cxfrestclient
 
JSON_FORMAT_SUFFIX - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestAdminConstants.MediaType
 
JSON_FORMAT_SUFFIX - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.MediaType
 
JWT_COOKIE_NAME - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants
 

L

LinkException - Exception in com.vmware.vcloud.api.rest.client
Base class for exceptions related to operations on <link> elements in responses.
LinkException(String, LinkRelation, String) - Constructor for exception com.vmware.vcloud.api.rest.client.LinkException
 
LINKS - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.QueryParams
 
login(ClientCredentials) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Deprecated.
login(ClientCredentials) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
loginWithJwt(String, String) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Reuses an existing session on the remote vCloud API end point using the supplied JWT taken from another VcdClient.
loginWithJwt(String, String) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
loginWithToken(VcdClient.SessionToken) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Reuses an existing session on the remote vCloud API end point using the supplied session token taken from another VcdClient.
loginWithToken(VcdClient.SessionToken) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
logout() - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Logs out of the remote vCloud API end point
logout() - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 

M

makeException(WebApplicationException) - Method in class com.vmware.cxfrestclient.AbstractCxfRestClient
 
makeException(WebApplicationException) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
makeRef(ResourceType) - Static method in class com.vmware.vcloud.api.rest.client.VcdUtils
Convenience method to turn a ResourceType into a ReferenceType to that resource.
makeRef(IdentifiableResourceType) - Static method in class com.vmware.vcloud.api.rest.client.VcdUtils
Convenience method to turn an IdentifiableResourceType into a ReferenceType to that resource.
makeRef(EntityType) - Static method in class com.vmware.vcloud.api.rest.client.VcdUtils
Convenience method to turn an EntityType into a ReferenceType to that entity.
makeRef(LinkType) - Static method in class com.vmware.vcloud.api.rest.client.VcdUtils
Convenience method to turn a LinkType into a ReferenceType to the linked-to resource.
makeRef(String) - Static method in class com.vmware.vcloud.api.rest.client.VcdUtils
Convenience method to turn a String of an URL into a ReferenceType with that URL.
MAX_PAGE_SIZE - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.QueryParams
 
MissingLinkException - Exception in com.vmware.vcloud.api.rest.client
An exception to indicate that a resource being queried for a <link> element of a particular rel and media type in fact has no such link.
MissingLinkException(String, LinkRelation, String) - Constructor for exception com.vmware.vcloud.api.rest.client.MissingLinkException
 
MissingRecordException - Exception in com.vmware.vcloud.api.rest.client
An exception to indicate that a query failed to return an expected record.
MissingRecordException() - Constructor for exception com.vmware.vcloud.api.rest.client.MissingRecordException
 
MissingRecordException(String) - Constructor for exception com.vmware.vcloud.api.rest.client.MissingRecordException
 
MissingRecordException(String, Throwable) - Constructor for exception com.vmware.vcloud.api.rest.client.MissingRecordException
 
MissingRecordException(Throwable) - Constructor for exception com.vmware.vcloud.api.rest.client.MissingRecordException
 
MultipleLinksException - Exception in com.vmware.vcloud.api.rest.client
An exception to indicate that a resource being queried for a single <link> element of a particular rel and media type in fact has multiple matching such elements.
MultipleLinksException(String, LinkRelation, String) - Constructor for exception com.vmware.vcloud.api.rest.client.MultipleLinksException
 
MultipleRecordsException - Exception in com.vmware.vcloud.api.rest.client
An exception to indicate that a query returned more than one record when it was expected to return exactly one record.
MultipleRecordsException() - Constructor for exception com.vmware.vcloud.api.rest.client.MultipleRecordsException
 
MultipleRecordsException(String) - Constructor for exception com.vmware.vcloud.api.rest.client.MultipleRecordsException
 
MultipleRecordsException(String, Throwable) - Constructor for exception com.vmware.vcloud.api.rest.client.MultipleRecordsException
 
MultipleRecordsException(Throwable) - Constructor for exception com.vmware.vcloud.api.rest.client.MultipleRecordsException
 
MULTISITE_ATTR - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants
 
MULTISITE_ATTR_GLOBAL - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants
 
MULTISITE_ATTR_LOCAL - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants
 
MULTISITE_BASIC_AUTH_HEADER_TEMPLATE - Static variable in class com.vmware.vcloud.api.rest.client.VcdMultisiteLoginCredentials
 
MULTISITE_BASIC_AUTH_USERORG_TEMPLATE - Static variable in class com.vmware.vcloud.api.rest.client.VcdMultisiteLoginCredentials
 
MULTISITE_QUERY_HEADER - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants
 
MULTISITE_SSO_AUTH_HEADER_TEMPLATE - Static variable in class com.vmware.vcloud.api.rest.client.VcdMultisiteLoginCredentials
 
MultisiteAuthorizationFilter - Class in com.vmware.vcloud.api.rest.client.filters
Filter for intercepting outgoing requests and adding the Multisite authorization header to them
MultisiteAuthorizationFilter(VcdMultisiteLoginCredentials) - Constructor for class com.vmware.vcloud.api.rest.client.filters.MultisiteAuthorizationFilter
 

N

NsxProxyApiClient - Class in com.vmware.vcloud.api.rest.client
A client to interact with VCD's NSX/networking proxy API.

O

OFFSET - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.QueryParams
 
OPENAPI_BASE_PATH - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants
 
OpenApiClient - Interface in com.vmware.vcloud.api.rest.client
REST API client built on OpenAPI framework.
optionsResource(URI) - Method in class com.vmware.cxfrestclient.AbstractCxfRestClient
 
optionsResource(URI) - Method in interface com.vmware.cxfrestclient.JaxRsClient
Gets OPTIONS response of the specified resource.
ORGANIZATION - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.MediaType
 
ORGANIZATION_LIST - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.MediaType
 
ORGANIZATIONM - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestAdminConstants.MediaType
 

P

PAGE - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.QueryParams
 
PAGE_SIZE - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.QueryParams
 
postResource(URI, String, JAXBElement<ContentsClass>) - Method in class com.vmware.cxfrestclient.AbstractCxfRestClient
 
postResource(URI, String, JAXBElement<ContentsClass>, Class<ResponseClass>) - Method in class com.vmware.cxfrestclient.AbstractCxfRestClient
 
postResource(URI, String, JAXBElement<ContentsClass>) - Method in interface com.vmware.cxfrestclient.JaxRsClient
Posts the specified contents to the specified resource.
postResource(URI, String, JAXBElement<ContentsClass>, Class<ResponseClass>) - Method in interface com.vmware.cxfrestclient.JaxRsClient
Posts the specified contents to the specified resource.
postResource(ReferenceType, String, JAXBElement<ContentsClass>, Class<ResponseClass>) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
postResource(ResourceType, RelationType, String, JAXBElement<ContentsClass>, Class<ResponseClass>) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Posts the contents to the resource referenced by the link with the specified rel and mediaType in the specified resource
postResource(ResourceType, RelationType, String, JAXBElement<ContentsClass>, Class<ResponseClass>) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
postResource(ReferenceType, String, JAXBElement<ContentsClass>, Class<ResponseClass>) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
postResourceVoid(URI, String, JAXBElement<ContentsClass>) - Method in class com.vmware.cxfrestclient.AbstractCxfRestClient
 
postResourceVoid(URI, String, JAXBElement<ContentsClass>) - Method in interface com.vmware.cxfrestclient.JaxRsClient
Posts the specified contents to the specified resource.
putFile(URI, File, String) - Method in class com.vmware.cxfrestclient.AbstractCxfRestClient
 
putFile(URI, File, String) - Method in interface com.vmware.cxfrestclient.JaxRsClient
Puts the contents of the specified file to the specified uri.
putResource(URI, String, JAXBElement<ContentsClass>) - Method in class com.vmware.cxfrestclient.AbstractCxfRestClient
 
putResource(URI, String, JAXBElement<ContentsClass>, Class<ResponseClass>) - Method in class com.vmware.cxfrestclient.AbstractCxfRestClient
 
putResource(URI, String, JAXBElement<ContentsClass>) - Method in interface com.vmware.cxfrestclient.JaxRsClient
Puts the specified contents to the specified resource.
putResource(URI, String, JAXBElement<ContentsClass>, Class<ResponseClass>) - Method in interface com.vmware.cxfrestclient.JaxRsClient
Puts the specified contents to the specified resource.
putResource(ReferenceType, String, JAXBElement<ContentsClass>, Class<ResponseClass>) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Convenience wrapper over {@link JaxRsClient#putResource(java.net.URI, String, JAXBElement, Class)
putResource(String, JAXBElement<ContentsClass>, Class<ResponseClass>) - Method in interface com.vmware.vcloud.api.rest.client.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).
putResource(ResourceType, RelationType, String, JAXBElement<ContentsClass>, Class<ResponseClass>) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Puts the contents to the resource referenced by the link with the specified rel and mediaType in the specified resource
putResource(ResourceType, RelationType, String, JAXBElement<ContentsClass>, Class<ResponseClass>) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
putResource(ReferenceType, String, JAXBElement<ContentsClass>, Class<ResponseClass>) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
putResource(String, JAXBElement<ContentsClass>, Class<ResponseClass>) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
putResourceVoid(URI, String, JAXBElement<ContentsClass>) - Method in class com.vmware.cxfrestclient.AbstractCxfRestClient
 
putResourceVoid(URI, String, JAXBElement<ContentsClass>) - Method in interface com.vmware.cxfrestclient.JaxRsClient
Puts the specified contents to the specified resource.

Q

QUERY_FIELDS_SEPARATOR - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.QueryParams
 
QUERY_LIST - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.MediaType
 
QUERY_PARAMS_SEPARATOR - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.QueryParams
 
QueryListPage(List<T>, long) - Constructor for class com.vmware.vcloud.api.rest.client.VcdClient.QueryListPage
 
QueryResultFormat - Enum in com.vmware.vcloud.api.rest.client
Form of result returned by a query.

R

readFrom(Class<Object>, Type, Annotation[], MediaType, MultivaluedMap<String, String>, InputStream) - Method in class com.vmware.vcloud.api.rest.client.XStreamXmlProvider
 
RECORDS - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.MediaType
 
RECURSIVE - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.DeleteParameters
Recursive deletion of child objects
REFERENCES - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.MediaType
 
RelationType - Enum in com.vmware.vcloud.api.rest.client.constants
Contains a relation(rel) which a link provide to a resource or operation.
relogin() - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Repeats login if client credentials are present.
relogin() - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
removeResource(ResourceType) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Deletes the resource described by the specified resource type.
removeResource(ResourceType, Boolean, Boolean, Class<ResponseClass>) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Deletes the resource described by the specified resource type.
removeResource(ResourceType) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
removeResource(ResourceType, Boolean, Boolean, Class<ResponseClass>) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
resolveEntityById(String) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Returns information about the resource with the specified ID.
resolveEntityById(String) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
RestAdminConstants - Interface in com.vmware.vcloud.api.rest.client.constants
 
RestAdminConstants.MediaType - Interface in com.vmware.vcloud.api.rest.client.constants
 
RestConstants - Interface in com.vmware.vcloud.api.rest.client.constants
A variety of vCloud REST API constants
RestConstants.DeleteParameters - Interface in com.vmware.vcloud.api.rest.client.constants
 
RestConstants.HttpStatusCodes - Interface in com.vmware.vcloud.api.rest.client.constants
 
RestConstants.MediaType - Interface in com.vmware.vcloud.api.rest.client.constants
 
RestConstants.QueryParams - Interface in com.vmware.vcloud.api.rest.client.constants
 
RestConstants.Uri - Interface in com.vmware.vcloud.api.rest.client.constants
 

S

SC_ACCEPTED - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.HttpStatusCodes
 
SC_BAD_REQUEST - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.HttpStatusCodes
HTTP BAD REQUEST status code
SC_CONFLICT - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.HttpStatusCodes
HTTP Conflict status code
SC_CREATED - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.HttpStatusCodes
 
SC_FORBIDDEN - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.HttpStatusCodes
HTTP Forbidden status code
SC_GATEWAY_TIMEOUT_ERROR - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.HttpStatusCodes
HTTP Gateway Timeout
SC_INTERNAL_SERVER_ERROR - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.HttpStatusCodes
HTTP Internal server error status code
SC_METHOD_NOT_ALLOWED - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.HttpStatusCodes
HTTP Method not allowed status code
SC_MOVED_PERMANENTLY - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.HttpStatusCodes
 
SC_NO_CONTENT - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.HttpStatusCodes
 
SC_NOT_ACCEPTABLE - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.HttpStatusCodes
HTTP Not Acceptable status code
SC_NOT_FOUND - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.HttpStatusCodes
HTTP NOT FOUND status code
SC_OK - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.HttpStatusCodes
 
SC_PARTIAL_CONTENT - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.HttpStatusCodes
 
SC_SERVICE_NOT_AVAILABLE - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.HttpStatusCodes
 
SC_UNAUTHORIZED - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.HttpStatusCodes
HTTP UNAUTHORIZED status code
SC_UNSUPPORTED_MEDIA_TYPE - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.HttpStatusCodes
HTTP Unsupported Media Type
SESSION - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.MediaType
 
SESSION - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.Uri
 
SESSION_COOKIE_NAME - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants
 
SESSIONS - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.Uri
 
SessionTokenImpl(String, String) - Constructor for class com.vmware.vcloud.api.rest.client.VcdClientImpl.SessionTokenImpl
 
setAuthenticationHeader(Client) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Sets the vCloud API authentication header in the specified JAX-RS Client object to be the one for this VcdClient.
setAuthenticationHeader(Client) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
setAuthenticationHeaders(Client) - Method in class com.vmware.vcloud.api.rest.client.NsxProxyApiClient
 
setAuthenticationHeaders(Client) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
setClientRequestIdProvider(VcdClient.ClientRequestIdProvider) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
 
setClientRequestIdProvider(VcdClient.ClientRequestIdProvider) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
setCredentials(ClientCredentials) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Sets the credentials used for authentication.
setCredentials(ClientCredentials) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
setEqualityFilter(String, String) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient.Query
Sets equality filter to query that the specified attribute name has the specified value.
setErrorHandler(JaxRsClient.ErrorHandler) - Method in class com.vmware.cxfrestclient.AbstractCxfRestClient
 
setErrorHandler(JaxRsClient.ErrorHandler) - Method in interface com.vmware.cxfrestclient.JaxRsClient
Sets the handler to be called when requests made with this client fail.
setFields(Collection<String>) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient.Query
Sets query fields.
setFilter(String) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient.Query
Sets query filter.
setIncludeLinks(boolean) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient.Query
Sets flag for including links in query results.
setMultisiteRequests(boolean) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Controls whether requests made with this client request federated behavior or not.
setMultisiteRequests(boolean) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
setOrgContextHeader(String) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient
Sets the X-VMWARE-VCLOUD-ORG-ID header to the specified value
setOrgContextHeader(String) - Method in class com.vmware.vcloud.api.rest.client.VcdClientImpl
 
setPage(int) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient.Query
Sets page number to retrieve.
setPageSize(int) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient.Query
Sets page size.
setQueryResultFormat(QueryResultFormat) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient.Query
Sets query result format.
setSortAsc(String) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient.Query
Sets ascending sort order by specified field.
setSortDesc(String) - Method in interface com.vmware.vcloud.api.rest.client.VcdClient.Query
Sets descending sort order by specified field.
SORT_ASC - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.QueryParams
 
SORT_DESC - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.QueryParams
 
stream() - Method in interface com.vmware.vcloud.api.rest.client.VcdClient.Query
Executes the query and returns an Stream of all results over all pages
supportsSessionless() - Method in interface com.vmware.vcloud.api.rest.client.ClientCredentials
Indicates whether the ClientCredentials supports session-less requests.
supportsSessionless() - Method in class com.vmware.vcloud.api.rest.client.VcdBasicLoginCredentials
 
supportsSessionless() - Method in class com.vmware.vcloud.api.rest.client.VcdBearerLoginCredentials
 
supportsSessionless() - Method in class com.vmware.vcloud.api.rest.client.VcdMultisiteLoginCredentials
 
supportsSessionless() - Method in class com.vmware.vcloud.api.rest.client.VcdSignLoginCredentials
 

T

TaskMonitor - Interface in com.vmware.vcloud.api.rest.client
Monitors tasks for success or failure returned by post and put methods in JaxRsClient.
TaskMonitorImpl - Class in com.vmware.vcloud.api.rest.client
 
TaskMonitorImpl(JaxRsClient) - Constructor for class com.vmware.vcloud.api.rest.client.TaskMonitorImpl
 
TaskStatus - Enum in com.vmware.vcloud.api.rest.client
The status of a task Note: This Enum is clone of com.vmware.vcloud.api.presentation.entity.common.TaskStatus.
toString() - Method in class com.vmware.cxfrestclient.CxfClientSecurityContext
 
toString() - Method in exception com.vmware.vcloud.api.rest.client.LinkException
 
toString() - Method in enum com.vmware.vcloud.api.rest.client.TaskStatus
 
toString() - Method in exception com.vmware.vcloud.api.rest.client.VcdErrorException
 
toString() - Method in exception com.vmware.vcloud.api.rest.client.VcdErrorResponseException
 
toString() - Method in exception com.vmware.vcloud.api.rest.client.VcdErrorResponseProcessingException
 
toString() - Method in exception com.vmware.vcloud.api.rest.client.VcdTaskException
 
toTrackingFuture() - Method in interface com.vmware.vcloud.api.rest.client.VcdTaskMonitor.MultiTaskTracker
Indicate to the tracker that all tasks desirous to be tracked have been added to the tracker.
track(TaskType...) - Method in interface com.vmware.vcloud.api.rest.client.VcdTaskMonitor.MultiTaskTracker
Add a list of tasks for the monitor to track.
track(Collection<TaskType>) - Method in interface com.vmware.vcloud.api.rest.client.VcdTaskMonitor.MultiTaskTracker
Add a list of tasks for the monitor to track.
TYPE - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.QueryParams
 

U

USER - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.MediaType
 

V

value() - Method in enum com.vmware.vcloud.api.rest.client.constants.RelationType
 
valueOf(String) - Static method in enum com.vmware.cxfrestclient.JaxRsClient.ErrorHandler.Disposition
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.vmware.vcloud.api.rest.client.constants.RelationType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.vmware.vcloud.api.rest.client.QueryResultFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.vmware.vcloud.api.rest.client.TaskStatus
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.vmware.cxfrestclient.JaxRsClient.ErrorHandler.Disposition
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.vmware.vcloud.api.rest.client.constants.RelationType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.vmware.vcloud.api.rest.client.QueryResultFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.vmware.vcloud.api.rest.client.TaskStatus
Returns an array containing the constants of this enum type, in the order they are declared.
VcdBasicLoginCredentials - Class in com.vmware.vcloud.api.rest.client
Username@Org/password Credentials suitable for use in authenticating with a vCD server using the vCloud API
VcdBasicLoginCredentials(String, String) - Constructor for class com.vmware.vcloud.api.rest.client.VcdBasicLoginCredentials
Construct credentials from a valid vCD organization qualified username (username@orgname) and a password.
VcdBasicLoginCredentials(String, String, String) - Constructor for class com.vmware.vcloud.api.rest.client.VcdBasicLoginCredentials
Construct credentials from a valid vCD user and org names and a password.
VcdBearerLoginCredentials - Class in com.vmware.vcloud.api.rest.client
Bearer Token credentials suitable for use in authenticating with a vCD server using the vCloud API.
VcdBearerLoginCredentials(String, String) - Constructor for class com.vmware.vcloud.api.rest.client.VcdBearerLoginCredentials
Construct a VcdBearerLoginCredentials object using an OAuth Bearer token and VCD org name
VcdClient - Interface in com.vmware.vcloud.api.rest.client
A vCloud REST API client.
VcdClient.ClientRequestIdProvider - Interface in com.vmware.vcloud.api.rest.client
Returns client request ID to use when making request to VCD.
VcdClient.Query<QueryResultClass> - Interface in com.vmware.vcloud.api.rest.client
Represents a query which can be executed against VCD.
VcdClient.QueryListPage<T> - Class in com.vmware.vcloud.api.rest.client
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.
VcdClient.ReferenceTypeChangedCallBack - Interface in com.vmware.vcloud.api.rest.client
A callback contract to inform the caller that a href value has been repaired.
VcdClient.SessionToken - Interface in com.vmware.vcloud.api.rest.client
An token that can be retrieved from one VcdClient to attach another VcdClient to the same session.
VcdClientImpl - Class in com.vmware.vcloud.api.rest.client
 
VcdClientImpl(URI, String, CxfClientSecurityContext) - Constructor for class com.vmware.vcloud.api.rest.client.VcdClientImpl
Creates an instance of VcdClientImpl with given endpoint, API version and cxfClientSecurityContext.
VcdClientImpl(URI, List<ApiVersion>, CxfClientSecurityContext) - Constructor for class com.vmware.vcloud.api.rest.client.VcdClientImpl
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.SessionTokenImpl - Class in com.vmware.vcloud.api.rest.client
Implementation of SessionToken to represent a current session with vCD.
VcdErrorException - Exception in com.vmware.vcloud.api.rest.client
Base exception to represent errors returned by VCD.
VcdErrorException(int, WebApplicationException) - Constructor for exception com.vmware.vcloud.api.rest.client.VcdErrorException
 
VcdErrorResponseException - Exception in com.vmware.vcloud.api.rest.client
Exception for encapsulating errors returned by VCD as Jaxb ErrorType object
VcdErrorResponseException(int, String, ErrorType, WebApplicationException) - Constructor for exception com.vmware.vcloud.api.rest.client.VcdErrorResponseException
 
VcdErrorResponseException(int, String, String, WebApplicationException) - Constructor for exception com.vmware.vcloud.api.rest.client.VcdErrorResponseException
 
VcdErrorResponseProcessingException - Exception in com.vmware.vcloud.api.rest.client
Exception to note that error returned by VCD cannot be processed.
VcdErrorResponseProcessingException(int, Exception, WebApplicationException) - Constructor for exception com.vmware.vcloud.api.rest.client.VcdErrorResponseProcessingException
 
VcdMultisiteLoginCredentials - Class in com.vmware.vcloud.api.rest.client
Certificate based credentials for signing the body of a multisite request.
VcdMultisiteLoginCredentials(UUID, UUID, String, String, String) - Constructor for class com.vmware.vcloud.api.rest.client.VcdMultisiteLoginCredentials
Construct the multisite credentials with the key to sign with and basic credentials of the user the multisite request is made on behalf of
VcdMultisiteLoginCredentials(UUID, UUID, String, String) - Constructor for class com.vmware.vcloud.api.rest.client.VcdMultisiteLoginCredentials
Construct the multisite credentials with the key to sign with and the SSO credentials of the user the multisite request is made on behalf of
VcdSignLoginCredentials - Class in com.vmware.vcloud.api.rest.client
Saml Token/Org-name credentials suitable for use in authenticating with a vCD server using the vCloud API
VcdSignLoginCredentials(String, String) - Constructor for class com.vmware.vcloud.api.rest.client.VcdSignLoginCredentials
Construct a ClientCredentials object to generate vCD custom format SIGN Authentication header for login message to login into the specified org using the provided bearer token.
VcdSignLoginCredentials(String, String, PrivateKey) - Constructor for class com.vmware.vcloud.api.rest.client.VcdSignLoginCredentials
Construct a ClientCredentials object to generate vCD custom format SIGN Authentication header for login message to login into the specified org using the provided Holder-of-Key token and its signature generated using the specified private key.
VcdTaskException - Exception in com.vmware.vcloud.api.rest.client
Exception thrown when task failed to complete.
VcdTaskException(ReferenceType, String, ErrorType) - Constructor for exception com.vmware.vcloud.api.rest.client.VcdTaskException
 
VcdTaskMonitor - Interface in com.vmware.vcloud.api.rest.client
VCD specific enhancement for TaskMonitor.
VcdTaskMonitor.MultiTaskTracker - Interface in com.vmware.vcloud.api.rest.client
A monitor for many tasks that will eventually report the final TaskStatus of each task identified by the task URN
VcdTaskMonitorImpl - Class in com.vmware.vcloud.api.rest.client.impl.tasks
An implementation of VcdTaskMonitor that extends the functionality of TaskMonitorImpl
VcdTaskMonitorImpl(VcdClient) - Constructor for class com.vmware.vcloud.api.rest.client.impl.tasks.VcdTaskMonitorImpl
 
VcdUtils - Class in com.vmware.vcloud.api.rest.client
Miscellaneous utility methods for use when working with VcdClients.
VcdUtils() - Constructor for class com.vmware.vcloud.api.rest.client.VcdUtils
 
VCLOUD_ACCESS_TOKEN_HEADER - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants
 
VCLOUD_AUTH_CONTEXT_HEADER - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants
 
VCLOUD_AUTHENTICATION_HEADER - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants
 
VCLOUD_CLIENT_REQUEST_ID_HEADER - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants
 
VCLOUD_COOKIE_NAME - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants
 
VCLOUD_ORG_CONTEXT_HEADER - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants
 
VCLOUD_REQUEST_ID_HEADER - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants
 
VCLOUD_TASK_HREF_HEADER - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants
 
VCLOUD_TASK_ID_HEADER - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants
 
VCLOUD_TOKEN_TYPE_HEADER - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants
 
VCLOUDM - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestAdminConstants.MediaType
 
VERSIONS - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.Uri
 
VMW_EXTENSION - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.MediaType
 

W

waitForStatus(TaskType, long, long, TaskStatus, TaskStatus...) - Method in interface com.vmware.vcloud.api.rest.client.TaskMonitor
Waits for task to reach expected status.
waitForStatus(String, long, long, TaskStatus, TaskStatus...) - Method in interface com.vmware.vcloud.api.rest.client.TaskMonitor
Waits for task to reach expected status.
waitForStatus(TaskType, long, long, TaskStatus, TaskStatus...) - Method in class com.vmware.vcloud.api.rest.client.TaskMonitorImpl
 
waitForStatus(String, long, long, TaskStatus, TaskStatus...) - Method in class com.vmware.vcloud.api.rest.client.TaskMonitorImpl
 
waitForSuccess(TaskType, long) - Method in interface com.vmware.vcloud.api.rest.client.TaskMonitor
Waits for task to complete.
waitForSuccess(String, long) - Method in interface com.vmware.vcloud.api.rest.client.TaskMonitor
Waits for task to complete.
waitForSuccess(EntityType, long) - Method in interface com.vmware.vcloud.api.rest.client.TaskMonitor
Convenience wrapper over TaskMonitor.waitForSuccess(TaskType, long) that waits on the task that's associated with the specified EntityType.
waitForSuccess(TaskType, long) - Method in class com.vmware.vcloud.api.rest.client.TaskMonitorImpl
 
waitForSuccess(String, long) - Method in class com.vmware.vcloud.api.rest.client.TaskMonitorImpl
 
waitForSuccess(EntityType, long) - Method in class com.vmware.vcloud.api.rest.client.TaskMonitorImpl
 
writeTo(Object, Class<?>, Type, Annotation[], MediaType, MultivaluedMap<String, Object>, OutputStream) - Method in class com.vmware.vcloud.api.rest.client.XStreamXmlProvider
 

X

XML_FORMAT_SUFFIX - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestAdminConstants.MediaType
 
XML_FORMAT_SUFFIX - Static variable in interface com.vmware.vcloud.api.rest.client.constants.RestConstants.MediaType
 
XStreamXmlProvider - Class in com.vmware.vcloud.api.rest.client
JAX-RS's Provider to handle XStream in XML format.
XStreamXmlProvider() - Constructor for class com.vmware.vcloud.api.rest.client.XStreamXmlProvider
 
A B C D E F G H I J L M N O P Q R S T U V W X 
Skip navigation links

Copyright © 2019 VMware. All rights reserved.