org.jclouds.vcloud.director.v1_5.features
Interface CatalogApi

All Known Subinterfaces:

AdminCatalogApi

public interface CatalogApi

Provides synchronous access to Catalog objects.

Author:

grkvlt@apache.org, Adrian Cole

See Also:

CatalogAsyncApi

Method Summary

CatalogItem	addItem(String catalogUrn, CatalogItem item) Creates a catalog item in a catalog.
CatalogItem	addItem(URI catalogHref, CatalogItem item)
CatalogItem	editItem(String catalogItemUrn, CatalogItem catalogItem) Modifies a catalog item.
CatalogItem	editItem(URI catalogItemHref, CatalogItem catalogItem)
Catalog	get(String catalogUrn) Retrieves a catalog.
Catalog	get(URI catalogHref)
CatalogItem	getItem(String catalogItemUrn) Retrieves a catalog item.
CatalogItem	getItem(URI catalogItemHref)
void	removeItem(String catalogItemUrn) Deletes a catalog item.
void	removeItem(URI catalogItemHref)

Method Detail

get

Catalog get(String catalogUrn)

Retrieves a catalog.

 GET /catalog/{id}
 

Parameters:

catalogUri - the reference for the catalog

Returns:

a catalog

get

Catalog get(URI catalogHref)

addItem

CatalogItem addItem(String catalogUrn,
                    CatalogItem item)

Creates a catalog item in a catalog.

 POST /catalog/{id}/catalogItems
 

Parameters:

catalogUri - the URI of the catalog

item - the catalog item to add

Returns:

the addd catalog item

addItem

CatalogItem addItem(URI catalogHref,
                    CatalogItem item)

getItem

CatalogItem getItem(String catalogItemUrn)

Retrieves a catalog item.

 GET /catalogItem/{id}
 

Parameters:

catalogItemRef - the reference for the catalog item

Returns:

the catalog item

getItem

CatalogItem getItem(URI catalogItemHref)

editItem

CatalogItem editItem(String catalogItemUrn,
                     CatalogItem catalogItem)

Modifies a catalog item.

 PUT /catalogItem/{id}
 

Parameters:

catalogItemRef - the reference for the catalog item

catalogItem - the catalog item

Returns:

the edited catalog item

editItem

CatalogItem editItem(URI catalogItemHref,
                     CatalogItem catalogItem)

removeItem

void removeItem(String catalogItemUrn)

Deletes a catalog item.

 DELETE /catalogItem/{id}
 

Parameters:

catalogItemRef - the reference for the catalog item

removeItem

void removeItem(URI catalogItemHref)