org.jclouds.vcloud.features
Interface CatalogClient


public interface CatalogClient

Provides access to Catalog functionality in vCloud

Author:
Adrian Cole
See Also:

Method Summary
 CatalogItem addVAppTemplateOrMediaImageToCatalogAndNameItem(URI entity, URI catalog, String name, CatalogItemOptions... options)
          A catalog can contain references to vApp templates and media images that have been uploaded to any vDC in an organization.
 void deleteCatalogItem(URI href)
           
 Catalog findCatalogInOrgNamed(String orgName, String catalogName)
          returns the catalog in the organization associated with the specified name.
 CatalogItem findCatalogItemInOrgCatalogNamed(String orgName, String catalogName, String itemName)
          returns the catalog item in the catalog associated with the specified name.
 Catalog getCatalog(URI catalogId)
           
 CatalogItem getCatalogItem(URI catalogItem)
           
 

Method Detail

getCatalog

Catalog getCatalog(URI catalogId)

findCatalogInOrgNamed

Catalog findCatalogInOrgNamed(@Nullable
                              String orgName,
                              @Nullable
                              String catalogName)
returns the catalog in the organization associated with the specified name. Note that both parameters can be null to choose default.

Parameters:
orgName - organization name, or null for the default
catalogName - catalog name, or null for the default
Throws:
NoSuchElementException - if you specified an org or catalog name that isn't present

getCatalogItem

CatalogItem getCatalogItem(URI catalogItem)

findCatalogItemInOrgCatalogNamed

CatalogItem findCatalogItemInOrgCatalogNamed(@Nullable
                                             String orgName,
                                             @Nullable
                                             String catalogName,
                                             String itemName)
returns the catalog item in the catalog associated with the specified name. Note that the org and catalog parameters can be null to choose default.

Parameters:
orgName - organization name, or null for the default
catalogName - catalog name, or null for the default
itemName - item you wish to lookup
Throws:
NoSuchElementException - if you specified an org, catalog, or catalog item name that isn't present

addVAppTemplateOrMediaImageToCatalogAndNameItem

CatalogItem addVAppTemplateOrMediaImageToCatalogAndNameItem(URI entity,
                                                            URI catalog,
                                                            String name,
                                                            CatalogItemOptions... options)
A catalog can contain references to vApp templates and media images that have been uploaded to any vDC in an organization. A vApp template or media image can be listed in at most one catalog.

Parameters:
entity - the reference to the vApp templates and media image
catalog - URI of the catalog to add the resourceEntity from
name - name of the entry in the catalog
options - options such as description or properties
Returns:
the new catalog item

deleteCatalogItem

void deleteCatalogItem(URI href)


Copyright © 2009-2012 jclouds. All Rights Reserved.