com.vmware.vcloud.sdk.admin
Class AdminCatalog

java.lang.Object
  com.vmware.vcloud.sdk.VcloudResource<T>
      com.vmware.vcloud.sdk.VcloudEntity<com.vmware.vcloud.api.rest.schema.AdminCatalogType>
          com.vmware.vcloud.sdk.admin.AdminCatalog

public class AdminCatalog
extends VcloudEntity<com.vmware.vcloud.api.rest.schema.AdminCatalogType>

Helper class for Admin Catalog Resource in vCloud Admin API.

Author:

Administrator

Method Summary

CatalogItem	addCatalogItem(com.vmware.vcloud.api.rest.schema.CatalogItemType catalogItemType) Adding a catalogItem
void	changeOwner(com.vmware.vcloud.api.rest.schema.ReferenceType userReference) Change Catalog owner.
static void	changeOwner(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType catalogRef, com.vmware.vcloud.api.rest.schema.ReferenceType userReference) Change Catalog owner.
com.vmware.vcloud.api.rest.schema.SelectorExtensionType	createCatalogSelectorExtension(com.vmware.vcloud.api.rest.schema.SelectorExtensionType selectorExtensionType) Creates a Selector Extension for selector Catalog.
void	delete() Delete Admin Catalog
static void	delete(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType adminCatalogRef) Delete Admin Catalog
void	deleteCatalogSelectorExtensionById(String selectorExtensionId) Deletes a Selector Extensions that is associated with this Catalog.
com.vmware.vcloud.api.rest.schema.ReferenceType	getAdminOrganizationReference() Returns the Admin Organization reference.
static AdminCatalog	getCatalogById(VcloudClient client, String vCloudId) Get Admin Catalog helper using the vCloud ID
static AdminCatalog	getCatalogByReference(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType catalogRef) Returns Catalog using the Catalog ReferenceType typically obtained from the Admin Organization.
com.vmware.vcloud.api.rest.schema.ReferenceType	getCatalogItemRefByName(String name) Returns a catalog item reference for the given catalogitem name
Collection<com.vmware.vcloud.api.rest.schema.ReferenceType>	getCatalogItemReferences() Returns a collection of catalogItem references
HashMap<String,com.vmware.vcloud.api.rest.schema.ReferenceType>	getCatalogItemRefsByName() Returns a hashmap of catalog item references by name
com.vmware.vcloud.api.rest.schema.ReferenceType	getCatalogReference() Returns the Catalog reference
List<com.vmware.vcloud.api.rest.schema.SelectorExtensionType>	getCatalogSelectorExtension() Retrieves a list of Selector Extensions that are associated with this Catalog.
com.vmware.vcloud.api.rest.schema.SelectorExtensionType	getCatalogSelectorExtensionById(String selectorExtensionId) Retrieves a Selector Extensions that is associated with this Catalog.
com.vmware.vcloud.api.rest.schema.ReferenceType	getOwner() Returns the owner of the catalog.
static com.vmware.vcloud.api.rest.schema.ReferenceType	getOwner(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType adminCatalogRef) Returns the owner of the catalog
void	publishCatalog(com.vmware.vcloud.api.rest.schema.PublishCatalogParamsType publishCatalogParamsType) Publishing the Catalog
void	publishToExternalOrganizations(com.vmware.vcloud.api.rest.schema.PublishExternalCatalogParamsType publishExternalCatalogParams) Publish a catalog to external organizations
void	subscribeToExternalCatalog(com.vmware.vcloud.api.rest.schema.ExternalCatalogSubscriptionParamsType externalCatalogSubscription) Subscribe to an external catalog
AdminCatalog	updateAdminCatalog(com.vmware.vcloud.api.rest.schema.AdminCatalogType catalogType) Updating the Admin Catalog
com.vmware.vcloud.api.rest.schema.SelectorExtensionType	updateCatalogSelectorExtensionById(String selectorExtensionId, com.vmware.vcloud.api.rest.schema.SelectorExtensionType selectorExtensionType) Updates a Selector Extensions that is associated with this Catalog.

Methods inherited from class com.vmware.vcloud.sdk.VcloudEntity

getMetadata, getReference, getTasks

Methods inherited from class com.vmware.vcloud.sdk.VcloudResource

getResource

Methods inherited from class java.lang.Object

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

Method Detail

getAdminOrganizationReference

public com.vmware.vcloud.api.rest.schema.ReferenceType getAdminOrganizationReference()
                                                                              throws VCloudException

Returns the Admin Organization reference.

Returns:

ReferenceType

Throws:

VCloudException

getCatalogReference

public com.vmware.vcloud.api.rest.schema.ReferenceType getCatalogReference()
                                                                    throws VCloudException

Returns the Catalog reference

Returns:

ReferenceType

Throws:

VCloudException

getCatalogByReference

public static AdminCatalog getCatalogByReference(VcloudClient client,
                                                 com.vmware.vcloud.api.rest.schema.ReferenceType catalogRef)
                                          throws VCloudException

Returns Catalog using the Catalog ReferenceType typically obtained from the Admin Organization.

Parameters:

client - vCloud API client VcloudClient

catalogRef - Catalog Ref ReferenceType

Returns:

Catalog helper Catalog

Throws:

VCloudException

getCatalogById

public static AdminCatalog getCatalogById(VcloudClient client,
                                          String vCloudId)
                                   throws VCloudException

Get Admin Catalog helper using the vCloud ID

Parameters:

client - VcloudClient

vCloudId - format - The vCloud ID is of the form: "urn:vcloud:type:uuid". For example: "urn:vcloud:media:d9d976ba-e0ec-4682-a67d-380af49b54e1". String

Returns:

AdminCatalog

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

addCatalogItem

public CatalogItem addCatalogItem(com.vmware.vcloud.api.rest.schema.CatalogItemType catalogItemType)
                           throws VCloudException

Adding a catalogItem

Parameters:

catalogItemType - CatalogItemType

Returns:

CatalogItem helper

Throws:

VCloudException

updateAdminCatalog

public AdminCatalog updateAdminCatalog(com.vmware.vcloud.api.rest.schema.AdminCatalogType catalogType)
                                throws VCloudException

Updating the Admin Catalog

Parameters:

catalogType - AdminCatalogType

Returns:

AdminCatalog

Throws:

VCloudException

delete

public void delete()
            throws VCloudException

Delete Admin Catalog

Throws:

VCloudException

delete

public static void delete(VcloudClient client,
                          com.vmware.vcloud.api.rest.schema.ReferenceType adminCatalogRef)
                   throws VCloudException

Delete Admin Catalog

Parameters:

client - vCloud Client VcloudClient

adminCatalogRef - Admin Catalog Ref

Throws:

VCloudException

publishCatalog

public void publishCatalog(com.vmware.vcloud.api.rest.schema.PublishCatalogParamsType publishCatalogParamsType)
                    throws VCloudException

Publishing the Catalog

Parameters:

publishCatalogParamsType - PublishCatalogParamsType

Throws:

VCloudException

getOwner

public com.vmware.vcloud.api.rest.schema.ReferenceType getOwner()
                                                         throws VCloudException

Returns the owner of the catalog.

Returns:

ReferenceType

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

getOwner

public static com.vmware.vcloud.api.rest.schema.ReferenceType getOwner(VcloudClient client,
                                                                       com.vmware.vcloud.api.rest.schema.ReferenceType adminCatalogRef)
                                                                throws VCloudException

Returns the owner of the catalog

Parameters:

client - - VcloudClient

adminCatalogRef - - ReferenceType ReferenceType of the AdminCatalog.

Returns:

ReferenceType

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

changeOwner

public static void changeOwner(VcloudClient client,
                               com.vmware.vcloud.api.rest.schema.ReferenceType catalogRef,
                               com.vmware.vcloud.api.rest.schema.ReferenceType userReference)
                        throws VCloudException

Change Catalog owner. The Catalog ownership cannot be transferred outside the current organization

Parameters:

client - - VcloudClient

catalogRef - - ReferenceType Catalog ReferenceType contained in the organization

userReference - - ReferenceType

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

changeOwner

public void changeOwner(com.vmware.vcloud.api.rest.schema.ReferenceType userReference)
                 throws VCloudException

Change Catalog owner. The Catalog ownership cannot be transferred outside the current organization

Parameters:

userReference - ReferenceType

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

getCatalogItemRefsByName

public HashMap<String,com.vmware.vcloud.api.rest.schema.ReferenceType> getCatalogItemRefsByName()

Returns a hashmap of catalog item references by name

Returns:

HashMap

getCatalogItemRefByName

public com.vmware.vcloud.api.rest.schema.ReferenceType getCatalogItemRefByName(String name)

Returns a catalog item reference for the given catalogitem name

Parameters:

name - String

Returns:

ReferenceType

getCatalogItemReferences

public Collection<com.vmware.vcloud.api.rest.schema.ReferenceType> getCatalogItemReferences()

Returns a collection of catalogItem references

Returns:

Collection

publishToExternalOrganizations

public void publishToExternalOrganizations(com.vmware.vcloud.api.rest.schema.PublishExternalCatalogParamsType publishExternalCatalogParams)
                                    throws VCloudException

Publish a catalog to external organizations

Parameters:

publishExternalCatalogParams - PublishExternalCatalogParamsType

Throws:

VCloudException

Since:

API 5.5, SDK 5.5

subscribeToExternalCatalog

public void subscribeToExternalCatalog(com.vmware.vcloud.api.rest.schema.ExternalCatalogSubscriptionParamsType externalCatalogSubscription)
                                throws VCloudException

Subscribe to an external catalog

Parameters:

externalCatalogSubscription - ExternalCatalogSubscriptionParamsType

Throws:

VCloudException

Since:

API 5.5, SDK 5.5

createCatalogSelectorExtension

public com.vmware.vcloud.api.rest.schema.SelectorExtensionType createCatalogSelectorExtension(com.vmware.vcloud.api.rest.schema.SelectorExtensionType selectorExtensionType)
                                                                                       throws VCloudException

Creates a Selector Extension for selector Catalog.

Parameters:

SelectorExtensionType -

Returns:

SelectorExtensionType

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10

getCatalogSelectorExtension

public List<com.vmware.vcloud.api.rest.schema.SelectorExtensionType> getCatalogSelectorExtension()
                                                                                          throws VCloudException

Retrieves a list of Selector Extensions that are associated with this Catalog.

Returns:

List SelectorExtensionType

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10

getCatalogSelectorExtensionById

public com.vmware.vcloud.api.rest.schema.SelectorExtensionType getCatalogSelectorExtensionById(String selectorExtensionId)
                                                                                        throws VCloudException

Retrieves a Selector Extensions that is associated with this Catalog.

Parameters:

string - selectorExtensionId

Returns:

SelectorExtensionType

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10

updateCatalogSelectorExtensionById

public com.vmware.vcloud.api.rest.schema.SelectorExtensionType updateCatalogSelectorExtensionById(String selectorExtensionId,
                                                                                                  com.vmware.vcloud.api.rest.schema.SelectorExtensionType selectorExtensionType)
                                                                                           throws VCloudException

Updates a Selector Extensions that is associated with this Catalog.

Parameters:

SelectorExtensionType - SelectorExtensionType

String - SelectorExtensionId

Returns:

SelectorExtensionType

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10

deleteCatalogSelectorExtensionById

public void deleteCatalogSelectorExtensionById(String selectorExtensionId)
                                        throws VCloudException

Deletes a Selector Extensions that is associated with this Catalog.

Parameters:

String - SelectorExtensionId

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10