com.vmware.vcloud.api.rest.client

Class VcdUtils

java.lang.Object

com.vmware.vcloud.api.rest.client.VcdUtils

public class VcdUtils
extends Object

Miscellaneous utility methods for use when working with VcdClients.

Constructor Summary

Constructors

Constructor and Description
VcdUtils()

Method Summary

Modifier and Type	Method and Description
static URI	buildDeleteUri(URI baseHref, Boolean force, Boolean recursive) Constructs a URI which has the correct delete parameters set as URL parameters if applicable
static com.vmware.vcloud.api.rest.schema_v1_5.LinkType	findLink(com.vmware.vcloud.api.rest.schema_v1_5.ResourceType resource, com.vmware.vcloud.api.rest.links.LinkRelation rel, String mediaType) Returns the link of the specified rel and type in the specified resource
static com.vmware.vcloud.api.rest.schema_v1_5.LinkType	findLink(com.vmware.vcloud.api.rest.schema_v1_5.ResourceType resource, com.vmware.vcloud.api.rest.links.LinkRelation rel, String mediaType, boolean failIfAbsent) Returns the link of the specified rel and type in the specified resource
static String	getEntityId(com.vmware.vcloud.api.rest.schema_v1_5.EntityType entityType) Gets an entity's ID in a form that can be used as an input parameter to a service method that expects an ID.
static List<com.vmware.vcloud.api.rest.schema_v1_5.LinkType>	getLinks(com.vmware.vcloud.api.rest.schema_v1_5.ResourceType resource, com.vmware.vcloud.api.rest.links.LinkRelation rel, String mediaType) Returns all the links of the specified rel and type in the specified resource
static <T extends com.vmware.vcloud.api.rest.schema_v1_5.EntityType> com.vmware.vcloud.api.rest.schema_v1_5.TaskType	getTask(T entityType) Convenience method to get TaskType from given resource.
static com.vmware.vcloud.api.rest.schema_v1_5.ReferenceType	makeRef(com.vmware.vcloud.api.rest.schema_v1_5.EntityType entity) Convenience method to turn an EntityType into a ReferenceType to that entity.
static com.vmware.vcloud.api.rest.schema_v1_5.ReferenceType	makeRef(com.vmware.vcloud.api.rest.schema_v1_5.IdentifiableResourceType identifiableResource) Convenience method to turn an IdentifiableResourceType into a ReferenceType to that resource.
static com.vmware.vcloud.api.rest.schema_v1_5.ReferenceType	makeRef(com.vmware.vcloud.api.rest.schema_v1_5.LinkType link) Convenience method to turn a LinkType into a ReferenceType to the linked-to resource.
static com.vmware.vcloud.api.rest.schema_v1_5.ReferenceType	makeRef(com.vmware.vcloud.api.rest.schema_v1_5.ResourceType resource) Convenience method to turn a ResourceType into a ReferenceType to that resource.
static com.vmware.vcloud.api.rest.schema_v1_5.ReferenceType	makeRef(String href) Convenience method to turn a String of an URL into a ReferenceType with that URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

VcdUtils

public VcdUtils()

Method Detail

buildDeleteUri

public static URI buildDeleteUri(URI baseHref,
                                 Boolean force,
                                 Boolean recursive)

Constructs a URI which has the correct delete parameters set as URL parameters if applicable

Parameters:

baseHref -

force - true, false or null which indicates the parameter should be omitted

recursive - true, false or null which indicates the parameter should be omitted

Returns:

a URI which can be further altered by the caller if necessary.

getEntityId

public static String getEntityId(com.vmware.vcloud.api.rest.schema_v1_5.EntityType entityType)

Gets an entity's ID in a form that can be used as an input parameter to a service method that expects an ID. TODO: The existence of this method is an indication of a flaw in the nature of VcdClient and/or CXF's REST client support. The vCloud API, being a "proper" sort of REST, returns links to resources in its responses with the idea that clients traverse the graph of vCloud objects by following those links. However, the vCloud JAX-RS interfaces/handlers are "service-oriented" in a way that makes it hard to usefully represent those links in a CXF REST client. Instead, clients end up doing the bad thing of using entity IDs to compose URLs (CXF composes them on the clients behalf, using JAX-RS annotations in the vCloud JAX-RS interfaces, which is just as bad), rather than simply following returned links. We should figure out if there's a way to do better.

findLink

public static com.vmware.vcloud.api.rest.schema_v1_5.LinkType findLink(com.vmware.vcloud.api.rest.schema_v1_5.ResourceType resource,
                                                                       com.vmware.vcloud.api.rest.links.LinkRelation rel,
                                                                       String mediaType)
                                                                throws MissingLinkException,
                                                                       MultipleLinksException

Returns the link of the specified rel and type in the specified resource

Parameters:

resource - the resource with the link

rel - the rel of the desired link

mediaType - media type of content

Returns:

the link

Throws:

MissingLinkException - if no link of the specified rel and media type is found

MultipleLinksException - if multiple links of the specified rel and media type are found

findLink

public static com.vmware.vcloud.api.rest.schema_v1_5.LinkType findLink(com.vmware.vcloud.api.rest.schema_v1_5.ResourceType resource,
                                                                       com.vmware.vcloud.api.rest.links.LinkRelation rel,
                                                                       String mediaType,
                                                                       boolean failIfAbsent)
                                                                throws MissingLinkException,
                                                                       MultipleLinksException

Returns the link of the specified rel and type in the specified resource

Parameters:

resource - the resource with the link

rel - the rel of the desired link

mediaType - media type of content

failIfAbsent - controls whether an exception is thrown if there's not exactly one link of the specified rel and media type

Returns:

the link, or null if no such link is present and failIfAbsent is false

Throws:

MissingLinkException - if no link of the specified rel and media type is found

MultipleLinksException - if multiple links of the specified rel and media type are found

getLinks

public static List<com.vmware.vcloud.api.rest.schema_v1_5.LinkType> getLinks(com.vmware.vcloud.api.rest.schema_v1_5.ResourceType resource,
                                                                             com.vmware.vcloud.api.rest.links.LinkRelation rel,
                                                                             String mediaType)

Returns all the links of the specified rel and type in the specified resource

Parameters:

resource - the resource with the link

rel - the rel of the desired link

mediaType - media type of content

Returns:

the links (could be an empty list)

makeRef

public static com.vmware.vcloud.api.rest.schema_v1_5.ReferenceType makeRef(com.vmware.vcloud.api.rest.schema_v1_5.ResourceType resource)

Convenience method to turn a ResourceType into a ReferenceType to that resource.

makeRef

public static com.vmware.vcloud.api.rest.schema_v1_5.ReferenceType makeRef(com.vmware.vcloud.api.rest.schema_v1_5.IdentifiableResourceType identifiableResource)

Convenience method to turn an IdentifiableResourceType into a ReferenceType to that resource.

makeRef

public static com.vmware.vcloud.api.rest.schema_v1_5.ReferenceType makeRef(com.vmware.vcloud.api.rest.schema_v1_5.EntityType entity)

Convenience method to turn an EntityType into a ReferenceType to that entity.

makeRef

public static com.vmware.vcloud.api.rest.schema_v1_5.ReferenceType makeRef(com.vmware.vcloud.api.rest.schema_v1_5.LinkType link)

Convenience method to turn a LinkType into a ReferenceType to the linked-to resource.

makeRef

public static com.vmware.vcloud.api.rest.schema_v1_5.ReferenceType makeRef(String href)

Convenience method to turn a String of an URL into a ReferenceType with that URL.

getTask

public static <T extends com.vmware.vcloud.api.rest.schema_v1_5.EntityType> com.vmware.vcloud.api.rest.schema_v1_5.TaskType getTask(T entityType)

Convenience method to get TaskType from given resource.

Throws:

RuntimeException - if more than one TaskType found in given resource.