com.vmware.vcloud.sdk.admin
Class VcloudAdmin

java.lang.Object
  com.vmware.vcloud.sdk.admin.VcloudAdmin

public class VcloudAdmin
extends Object

Helper class for the Vcloud Admin Resource in vCloud Admin API. Entry point for the vCloud Admin API

See Also:

VCloudType

Constructor Summary

VcloudAdmin(VcloudClient client)
Default Parameterized Constructor.

Method Summary

AdminOrganization	createAdminOrg(com.vmware.vcloud.api.rest.schema.AdminOrgType adminOrgType) Creating an Organization
com.vmware.vcloud.api.rest.schema.SelectorExtensionType	createCatalogsSelectorExtension(com.vmware.vcloud.api.rest.schema.SelectorExtensionType selectorExtensionType) Creates a default Catalog selector extension.
com.vmware.vcloud.api.rest.schema.SelectorExtensionType	createOrgsSelectorExtension(com.vmware.vcloud.api.rest.schema.SelectorExtensionType selectorExtensionType) Creates a default Org selector extension..
com.vmware.vcloud.api.rest.schema.SelectorExtensionType	createProviderVdcsSelectorExtension(com.vmware.vcloud.api.rest.schema.SelectorExtensionType selectorExtensionType) Creates a default ProviderVdc selector extension.
Role	createRole(com.vmware.vcloud.api.rest.schema.RoleType roleType) Creating a role
com.vmware.vcloud.api.rest.schema.SelectorExtensionType	createVdcsSelectorExtension(com.vmware.vcloud.api.rest.schema.SelectorExtensionType selectorExtensionType) Creates a default VDC selector extension.
void	deleteCatalogsSelectorExtensionById(String selectorExtensionId) Deletes a CatalogSelector Extension.
void	deleteOrgsSelectorExtensionById(String selectorExtensionId) Deletes a OrgSelector Extension.
void	deleteProviderVdcsSelectorExtensionById(String selectorExtensionId) Deletes a ProviderVdcSelector Extension.
void	deleteVdcsSelectorExtensionById(String selectorExtensionId) Deletes a VdcSelector Extension.
com.vmware.vcloud.api.rest.schema.ReferenceType	getAdminOrgRefByName(String name) Returns the Admin Organization reference by name
Collection<com.vmware.vcloud.api.rest.schema.ReferenceType>	getAdminOrgRefs() Returns Admin Organization References
HashMap<String,com.vmware.vcloud.api.rest.schema.ReferenceType>	getAdminOrgRefsByName() Returns the Admin Organization References By Name
AdminQueryService	getAdminQueryService() Returns the Admin QueryService
List<com.vmware.vcloud.api.rest.schema.SelectorExtensionType>	getCatalogsSelectorExtension() Retrieves a list of default Catalog selector extensions.
com.vmware.vcloud.api.rest.schema.SelectorExtensionType	getCatalogsSelectorExtensionById(String selectorExtensionId) Retrieves a CatalogSelector Extension.
com.vmware.vcloud.api.rest.schema.ReferenceType	getExternalNetworkRefByName(String name) Returns the ExternalNetwork reference by name
Collection<com.vmware.vcloud.api.rest.schema.ReferenceType>	getExternalNetworkRefs() Returns ExternalNetwork References
HashMap<String,com.vmware.vcloud.api.rest.schema.ReferenceType>	getExternalNetworkRefsByName() Returns ExternalNetwork References By Name
List<com.vmware.vcloud.api.rest.schema.SelectorExtensionType>	getOrgsSelectorExtension() Retrieves a list of default Orgs selector extensions.
com.vmware.vcloud.api.rest.schema.SelectorExtensionType	getOrgsSelectorExtensionById(String selectorExtensionId) Retrieves a OrgSelector Extension.
com.vmware.vcloud.api.rest.schema.ReferenceType	getProviderVdcRefByName(String name) Returns the ProviderVdc reference by name
Collection<com.vmware.vcloud.api.rest.schema.ReferenceType>	getProviderVdcRefs() Returns ProviderVdc References
HashMap<String,com.vmware.vcloud.api.rest.schema.ReferenceType>	getProviderVdcRefsByName() Returns ProviderVdc References By Name
List<com.vmware.vcloud.api.rest.schema.SelectorExtensionType>	getProviderVdcsSelectorExtension() Retrieves a list of default ProviderVdc selector extensions
com.vmware.vcloud.api.rest.schema.SelectorExtensionType	getProviderVdcsSelectorExtensionById(String selectorExtensionId) Retrieves a ProviderVdcSelector Extension.
com.vmware.vcloud.api.rest.schema.VCloudType	getResource() Returns the Vcloud Admin Resource as defined in the vCloud API
com.vmware.vcloud.api.rest.schema.ReferenceType	getRightRefByName(String name) Returns the Right reference by name
Collection<com.vmware.vcloud.api.rest.schema.ReferenceType>	getRightRefs() Returns Right References
HashMap<String,com.vmware.vcloud.api.rest.schema.ReferenceType>	getRightRefsByName() Returns Right References By Name
com.vmware.vcloud.api.rest.schema.ReferenceType	getRoleRefByName(String name) Returns the Role reference by name
Collection<com.vmware.vcloud.api.rest.schema.ReferenceType>	getRoleRefs() Returns Role References
HashMap<String,com.vmware.vcloud.api.rest.schema.ReferenceType>	getRoleRefsByName() Returns Role References By Name
AdminOrganization	getSystemAdminOrg() Returns the System Admin Organization
List<com.vmware.vcloud.api.rest.schema.SelectorExtensionType>	getVdcsSelectorExtension() Retrieves a list of default Vdc selector extensions
com.vmware.vcloud.api.rest.schema.SelectorExtensionType	getVdcsSelectorExtensionById(String selectorExtensionId) Retrieves a VdcSelector Extension.
com.vmware.vcloud.api.rest.schema.SelectorExtensionType	updateCatalogsSelectorExtensionById(String selectorExtensionId, com.vmware.vcloud.api.rest.schema.SelectorExtensionType selectorExtensionType) Updates a CatalogSelector Extension.
com.vmware.vcloud.api.rest.schema.SelectorExtensionType	updateOrgsSelectorExtensionById(String selectorExtensionId, com.vmware.vcloud.api.rest.schema.SelectorExtensionType selectorExtensionType) Updates a OrgSelector Extension.
com.vmware.vcloud.api.rest.schema.SelectorExtensionType	updateProviderVdcsSelectorExtensionById(String selectorExtensionId, com.vmware.vcloud.api.rest.schema.SelectorExtensionType selectorExtensionType) Updates a ProviderVdcSelector Extension.
com.vmware.vcloud.api.rest.schema.SelectorExtensionType	updateVdcsSelectorExtensionById(String selectorExtensionId, com.vmware.vcloud.api.rest.schema.SelectorExtensionType selectorExtensionType) Updates a VdcSelector Extension.

Methods inherited from class java.lang.Object

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

Constructor Detail

VcloudAdmin

public VcloudAdmin(VcloudClient client)
            throws VCloudException

Default Parameterized Constructor. Initializes, fetches and sorts the Vcloud Admin objects

Parameters:

client - VcloudClient

Throws:

VCloudException

Method Detail

getAdminQueryService

public AdminQueryService getAdminQueryService()

Returns the Admin QueryService

Returns:

AdminQueryService

Since:

API 1.5, SDK 1.5

getResource

public com.vmware.vcloud.api.rest.schema.VCloudType getResource()

Returns the Vcloud Admin Resource as defined in the vCloud API

getSystemAdminOrg

public AdminOrganization getSystemAdminOrg()
                                    throws VCloudException

Returns the System Admin Organization

Returns:

AdminOrganization

Throws:

VCloudException

createRole

public Role createRole(com.vmware.vcloud.api.rest.schema.RoleType roleType)
                throws VCloudException

Creating a role

Parameters:

roleType - RoleType

Returns:

Role

Throws:

VCloudException

createAdminOrg

public AdminOrganization createAdminOrg(com.vmware.vcloud.api.rest.schema.AdminOrgType adminOrgType)
                                 throws VCloudException

Creating an Organization

Parameters:

adminOrgType - AdminOrgType

Returns:

AdminOrganization

Throws:

VCloudException

getAdminOrgRefsByName

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

Returns the Admin Organization References By Name

Returns:

HashMap

getAdminOrgRefs

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

Returns Admin Organization References

Returns:

Collection

getAdminOrgRefByName

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

Returns the Admin Organization reference by name

Parameters:

name -

Returns:

ReferenceType

getProviderVdcRefsByName

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

Returns ProviderVdc References By Name

Returns:

HashMap

getProviderVdcRefs

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

Returns ProviderVdc References

Returns:

Collection

getProviderVdcRefByName

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

Returns the ProviderVdc reference by name

Parameters:

name -

Returns:

ReferenceType

getRightRefsByName

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

Returns Right References By Name

Returns:

HashMap

getRightRefs

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

Returns Right References

Returns:

Collection

getRightRefByName

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

Returns the Right reference by name

Parameters:

name -

Returns:

ReferenceType

getRoleRefsByName

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

Returns Role References By Name

Returns:

HashMap

getRoleRefs

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

Returns Role References

Returns:

Collection

getRoleRefByName

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

Returns the Role reference by name

Parameters:

name -

Returns:

ReferenceType

getExternalNetworkRefsByName

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

Returns ExternalNetwork References By Name

Returns:

HashMap

getExternalNetworkRefs

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

Returns ExternalNetwork References

Returns:

Collection

getExternalNetworkRefByName

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

Returns the ExternalNetwork reference by name

Parameters:

name -

Returns:

ReferenceType

createOrgsSelectorExtension

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

Creates a default Org selector extension..

Parameters:

SelectorExtensionType -

Returns:

SelectorExtensionType

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10

getOrgsSelectorExtension

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

Retrieves a list of default Orgs selector extensions.

Returns:

List SelectorExtensionType

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10

getOrgsSelectorExtensionById

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

Retrieves a OrgSelector Extension.

Parameters:

string - selectorExtensionId

Returns:

SelectorExtensionType

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10

updateOrgsSelectorExtensionById

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

Updates a OrgSelector Extension.

Parameters:

SelectorExtensionType - SelectorExtensionType

String - SelectorExtensionId

Returns:

SelectorExtensionType

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10

deleteOrgsSelectorExtensionById

public void deleteOrgsSelectorExtensionById(String selectorExtensionId)
                                     throws VCloudException

Deletes a OrgSelector Extension.

Parameters:

String - SelectorExtensionId

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10

createCatalogsSelectorExtension

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

Creates a default Catalog selector extension.

Parameters:

SelectorExtensionType -

Returns:

SelectorExtensionType

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10

getCatalogsSelectorExtension

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

Retrieves a list of default Catalog selector extensions.

Returns:

List SelectorExtensionType

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10

getCatalogsSelectorExtensionById

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

Retrieves a CatalogSelector Extension.

Parameters:

String - SelectorExtensionId

Returns:

SelectorExtensionType

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10

updateCatalogsSelectorExtensionById

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

Updates a CatalogSelector Extension.

Parameters:

SelectorExtensionType - SelectorExtensionType

String - SelectorExtensionId

Returns:

SelectorExtensionType

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10

deleteCatalogsSelectorExtensionById

public void deleteCatalogsSelectorExtensionById(String selectorExtensionId)
                                         throws VCloudException

Deletes a CatalogSelector Extension.

Parameters:

String - SelectorExtensionId

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10

createProviderVdcsSelectorExtension

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

Creates a default ProviderVdc selector extension.

Parameters:

SelectorExtensionType -

Returns:

SelectorExtensionType

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10

getProviderVdcsSelectorExtension

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

Retrieves a list of default ProviderVdc selector extensions

Returns:

List SelectorExtensionType

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10

getProviderVdcsSelectorExtensionById

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

Retrieves a ProviderVdcSelector Extension.

Parameters:

String - SelectorExtensionId

Returns:

SelectorExtensionType

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10

updateProviderVdcsSelectorExtensionById

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

Updates a ProviderVdcSelector Extension.

Parameters:

SelectorExtensionType - SelectorExtensionType

String - SelectorExtensionId

Returns:

SelectorExtensionType

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10

deleteProviderVdcsSelectorExtensionById

public void deleteProviderVdcsSelectorExtensionById(String selectorExtensionId)
                                             throws VCloudException

Deletes a ProviderVdcSelector Extension.

Parameters:

String - SelectorExtensionId

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10

createVdcsSelectorExtension

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

Creates a default VDC selector extension.

Parameters:

SelectorExtensionType -

Returns:

SelectorExtensionType

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10

getVdcsSelectorExtension

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

Retrieves a list of default Vdc selector extensions

Returns:

List SelectorExtensionType

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10

getVdcsSelectorExtensionById

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

Retrieves a VdcSelector Extension.

Parameters:

String - SelectorExtensionId

Returns:

SelectorExtensionType

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10

updateVdcsSelectorExtensionById

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

Updates a VdcSelector Extension.

Parameters:

SelectorExtensionType - SelectorExtensionType

String - SelectorExtensionId

Returns:

SelectorExtensionType

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10

deleteVdcsSelectorExtensionById

public void deleteVdcsSelectorExtensionById(String selectorExtensionId)
                                     throws VCloudException

Deletes a VdcSelector Extension.

Parameters:

String - SelectorExtensionId

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10