com.vmware.vcloud.sdk.admin.extensions
Class VcloudAdminExtension

java.lang.Object
  com.vmware.vcloud.sdk.admin.extensions.VcloudAdminExtension

public class VcloudAdminExtension
extends Object

Helper class for the vCloud Admin Extension Resource in vCloud Admin Extension API.

Author:

Administrator

Constructor Summary

VcloudAdminExtension(VcloudClient client)
Constructor for creating the Vcloud Admin Extension

Method Summary

void	clearUnusedLocalizationBundle() Clear the unused localization bundle.
void	clearUnusedRights() Clears all the rights that are not associated with a role or acl rule and which extension service is already deleted.
AdminService	createService(com.vmware.vcloud.api.rest.schema.extension.AdminServiceType serviceParams) Creates a new vcloud extension/service.
AdminService	createService(String serviceName, String serviceNamespace, String serviceExchange, String serviceRoutingKey, int servicePriority, boolean serviceAuthorizationEnabled) Creating an extension/service with the basic settings.
VMWExternalNetwork	createVMWExternalNetwork(com.vmware.vcloud.api.rest.schema.extension.VMWExternalNetworkType vmwExternalNetworkType) Creating VMWExternalNetwork
VMWNetworkPool	createVMWNetworkPool(com.vmware.vcloud.api.rest.schema.extension.VMWNetworkPoolType vmwNetworkPoolType) Creating VMWNetworkPool
VMWProviderVdc	createVMWProviderVdc(com.vmware.vcloud.api.rest.schema.extension.VMWProviderVdcParamsType vmwProviderVdcParams) Creating VMWProviderVdc
VMWProviderVdc	createVMWProviderVdc(com.vmware.vcloud.api.rest.schema.extension.VMWProviderVdcType vmwProviderVdcType) Deprecated. API 5.1, SDK 5.1, use VcloudAdminExtension createVMWProviderVdc(VMWProviderVdcParamsType)
VMWVdcTemplate	createVMWVdcTemplate(com.vmware.vcloud.api.rest.schema.extension.VMWVdcTemplateType vmwVdcTemplateType) Creating VMW VDC Template
AdminService	getAdminServiceByName(String serviceName) Search for the provided service/extension name.
ReferenceResult	getAdminServiceRefs() Returns the list of the extension services.
Collection<com.vmware.vcloud.api.rest.schema.ReferenceType>	getBlockingTaskRefs() Returns a collection of blocking tasks that have already been processed or are currently active.
ExtensionQueryService	getExtensionQueryService() Returns the Extension QueryService
Collection<com.vmware.vcloud.api.rest.schema.ReferenceType>	getLicensingReportRefs() Deprecated. API 1.5, SDK 5.5
com.vmware.vcloud.api.rest.schema.extension.OperationLimitsSettingsType	getOperationLimitsSettings() Retrieves OperationLimitsSettings
List<com.vmware.vcloud.api.rest.schema.extension.ObjectExtensionType>	getRegisteredObjExtensionRefs() Retrieves the list of currently registered object extensions.
com.vmware.vcloud.api.rest.schema.extension.VMWExtensionType	getResource() Returns the VMWExtension resource as defined in the vCloud API
ReferenceResult	getStrandedItemRefs() Returns the list of stranded item references.
VcloudAdminExtensionSettings	getVcloudAdminExtensionSettings() Returns the VcloudAdminExtensionSettings (General, Notifications, Amqp, BlockingTask, Approval settings).
List<com.vmware.vcloud.api.rest.schema.ReferenceType>	getVMWDatastoreRefs() Returns a Collection of VMWDatastore refs.
HashMap<String,com.vmware.vcloud.api.rest.schema.ReferenceType>	getVMWExternalNetworkRefsByName() Returns a HaspMap of the VMWExternalNetworkRefs By Name
HashMap<String,com.vmware.vcloud.api.rest.schema.ReferenceType>	getVMWHostRefsByName() Returns a HashMap of the VMWHostRefs By Name
HashMap<String,com.vmware.vcloud.api.rest.schema.ReferenceType>	getVMWNetworkPoolRefsByName() Returns a HashMap of the VMWNetworkPoolRefs By Name
HashMap<String,com.vmware.vcloud.api.rest.schema.ReferenceType>	getVMWProviderVdcRefsByName() Returns a HashMap of the VMWProviderVdcRefs By Name
List<com.vmware.vcloud.api.rest.schema.ReferenceType>	getVMWVdcTemplateRefs() Returns a Collection of VMWVdcTemplate refs.
HashMap<String,com.vmware.vcloud.api.rest.schema.ReferenceType>	getVMWVimServerRefsByName() Returns a HashMap of the VMWVimServerRefs By Name
boolean	isAuthorized(com.vmware.vcloud.api.rest.schema.extension.AuthorizationCheckParamsType authorizationCheckParamsType) Checks user authorization for all services with enabled authorization, URL and request verb.
boolean	isServiceAlreadyRegistered(String serviceName) Check if the service/extension is already registered.
com.vmware.vcloud.api.rest.schema.extension.ObjectExtensionType	registerObjectExtension(com.vmware.vcloud.api.rest.schema.extension.ObjectExtensionType vmwObjExtension) Registers a new object extension
com.vmware.vcloud.api.rest.schema.extension.RegisterVimServerParamsType	registerVMWVimServer(com.vmware.vcloud.api.rest.schema.extension.RegisterVimServerParamsType registerVimServerParamsType) Register the vimserver.
com.vmware.vcloud.api.rest.schema.extension.OperationLimitsSettingsType	updateOperationLimitsSettings(com.vmware.vcloud.api.rest.schema.extension.OperationLimitsSettingsType operationLimitsSettingsType) Update OperationLimitsSettings
void	uploadLocalizationBundle(com.vmware.vcloud.api.rest.schema.extension.BundleUploadParamsType bundleUploadParamsType, InputStream inputStream) Upload the localization bundle.
void	uploadLocalizationBundle(String localFileLocation, String serviceNamespace) Upload the localization bundle.

Methods inherited from class java.lang.Object

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

Constructor Detail

VcloudAdminExtension

public VcloudAdminExtension(VcloudClient client)
                     throws VCloudException

Constructor for creating the Vcloud Admin Extension

Parameters:

client - VcloudClient

Throws:

VCloudException

Method Detail

getVcloudAdminExtensionSettings

public VcloudAdminExtensionSettings getVcloudAdminExtensionSettings()
                                                             throws VCloudException

Returns the VcloudAdminExtensionSettings (General, Notifications, Amqp, BlockingTask, Approval settings).

Returns:

VcloudAdminExtensionSettings

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

getExtensionQueryService

public ExtensionQueryService getExtensionQueryService()

Returns the Extension QueryService

Returns:

ExtensionQueryService

Since:

API 1.5, SDK 1.5

getResource

public com.vmware.vcloud.api.rest.schema.extension.VMWExtensionType getResource()

Returns the VMWExtension resource as defined in the vCloud API

getVMWProviderVdcRefsByName

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

Returns a HashMap of the VMWProviderVdcRefs By Name

Returns:

HashMap

Throws:

VCloudException

getVMWExternalNetworkRefsByName

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

Returns a HaspMap of the VMWExternalNetworkRefs By Name

Returns:

HashMap

Throws:

VCloudException

getVMWNetworkPoolRefsByName

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

Returns a HashMap of the VMWNetworkPoolRefs By Name

Returns:

HashMap

Throws:

VCloudException

getVMWVimServerRefsByName

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

Returns a HashMap of the VMWVimServerRefs By Name

Returns:

HashMap

Throws:

VCloudException

getVMWHostRefsByName

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

Returns a HashMap of the VMWHostRefs By Name

Returns:

HashMap

Throws:

VCloudException

getVMWDatastoreRefs

public List<com.vmware.vcloud.api.rest.schema.ReferenceType> getVMWDatastoreRefs()
                                                                          throws VCloudException

Returns a Collection of VMWDatastore refs.

Returns:

List<ReferenceType>

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

getVMWVdcTemplateRefs

public List<com.vmware.vcloud.api.rest.schema.ReferenceType> getVMWVdcTemplateRefs()
                                                                            throws VCloudException

Returns a Collection of VMWVdcTemplate refs.

Returns:

List<ReferenceType>

Throws:

VCloudException

Since:

API 5.7, SDK 5.7

getLicensingReportRefs

public Collection<com.vmware.vcloud.api.rest.schema.ReferenceType> getLicensingReportRefs()
                                                                                   throws VCloudException

Deprecated. API 1.5, SDK 5.5

Returns a Collection of Licensing Report References

Returns:

Collection

Throws:

VCloudException

registerVMWVimServer

public com.vmware.vcloud.api.rest.schema.extension.RegisterVimServerParamsType registerVMWVimServer(com.vmware.vcloud.api.rest.schema.extension.RegisterVimServerParamsType registerVimServerParamsType)
                                                                                             throws VCloudException

Register the vimserver. The returned RegisterVimServerParams contains references to the newly registered vimserver and vshieldmanager. The newly registered vimserver contains the task associated with this registration

Parameters:

registerVimServerParamsType - RegisterVimServerParamsType

Returns:

RegisterVimServerParamsType

Throws:

VCloudException

createVMWProviderVdc

public VMWProviderVdc createVMWProviderVdc(com.vmware.vcloud.api.rest.schema.extension.VMWProviderVdcType vmwProviderVdcType)
                                    throws VCloudException

Deprecated. API 5.1, SDK 5.1, use VcloudAdminExtension createVMWProviderVdc(VMWProviderVdcParamsType)

Creating VMWProviderVdc

Parameters:

vmwProviderVdcType - VMWProviderVdcType

Returns:

VMWProviderVdc

Throws:

VCloudException

createVMWProviderVdc

public VMWProviderVdc createVMWProviderVdc(com.vmware.vcloud.api.rest.schema.extension.VMWProviderVdcParamsType vmwProviderVdcParams)
                                    throws VCloudException

Creating VMWProviderVdc

Parameters:

vmwProviderVdcParams - VMWProviderVdcParamsType

Returns:

VMWProviderVdc

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

createVMWExternalNetwork

public VMWExternalNetwork createVMWExternalNetwork(com.vmware.vcloud.api.rest.schema.extension.VMWExternalNetworkType vmwExternalNetworkType)
                                            throws VCloudException

Creating VMWExternalNetwork

Parameters:

vmwExternalNetworkType - VMWExternalNetworkType

Returns:

VMWExternalNetwork

Throws:

VCloudException

createVMWNetworkPool

public VMWNetworkPool createVMWNetworkPool(com.vmware.vcloud.api.rest.schema.extension.VMWNetworkPoolType vmwNetworkPoolType)
                                    throws VCloudException

Creating VMWNetworkPool

Parameters:

vmwNetworkPoolType - NetworkPoolType

Returns:

VMWNetworkPool

Throws:

VCloudException

getBlockingTaskRefs

public Collection<com.vmware.vcloud.api.rest.schema.ReferenceType> getBlockingTaskRefs()
                                                                                throws VCloudException

Returns a collection of blocking tasks that have already been processed or are currently active.

Returns:

Collection<ReferenceType>

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

getStrandedItemRefs

public ReferenceResult getStrandedItemRefs()
                                    throws VCloudException

Returns the list of stranded item references.

Returns:

ReferenceResult

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

getAdminServiceRefs

public ReferenceResult getAdminServiceRefs()
                                    throws VCloudException

Returns the list of the extension services.

Returns:

ReferenceResult

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

getAdminServiceByName

public AdminService getAdminServiceByName(String serviceName)
                                   throws VCloudException

Search for the provided service/extension name.

Parameters:

serviceName -

Returns:

AdminService

Throws:

VCloudException

Since:

API 5.1, SDK 5.5

isServiceAlreadyRegistered

public boolean isServiceAlreadyRegistered(String serviceName)

Check if the service/extension is already registered.

Parameters:

serviceName -

Returns:

Since:

API 5.1, SDK 5.5

createService

public AdminService createService(com.vmware.vcloud.api.rest.schema.extension.AdminServiceType serviceParams)
                           throws VCloudException

Creates a new vcloud extension/service.

Parameters:

serviceParams -

Returns:

AdminService

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

createService

public AdminService createService(String serviceName,
                                  String serviceNamespace,
                                  String serviceExchange,
                                  String serviceRoutingKey,
                                  int servicePriority,
                                  boolean serviceAuthorizationEnabled)
                           throws VCloudException

Creating an extension/service with the basic settings.

Parameters:

serviceName -

serviceNamespace -

serviceExchange -

serviceRoutingKey -

servicePriority -

serviceAuthorizationEnabled -

Returns:

AdminService

Throws:

VCloudException

Since:

API 5.1, SDK 5.5

clearUnusedRights

public void clearUnusedRights()
                       throws VCloudException

Clears all the rights that are not associated with a role or acl rule and which extension service is already deleted.

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

clearUnusedLocalizationBundle

public void clearUnusedLocalizationBundle()
                                   throws VCloudException

Clear the unused localization bundle.

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

uploadLocalizationBundle

public void uploadLocalizationBundle(com.vmware.vcloud.api.rest.schema.extension.BundleUploadParamsType bundleUploadParamsType,
                                     InputStream inputStream)
                              throws VCloudException

Upload the localization bundle.

Parameters:

bundleUploadParamsType -

inputStream -

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

uploadLocalizationBundle

public void uploadLocalizationBundle(String localFileLocation,
                                     String serviceNamespace)
                              throws VCloudException

Upload the localization bundle.

Parameters:

localFileLocation -

serviceNamespace -

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

isAuthorized

public boolean isAuthorized(com.vmware.vcloud.api.rest.schema.extension.AuthorizationCheckParamsType authorizationCheckParamsType)
                     throws VCloudException

Checks user authorization for all services with enabled authorization, URL and request verb. Returns true if authorized, otherwise false.

Parameters:

authorizationCheckParamsType -

Returns:

Boolean

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

createVMWVdcTemplate

public VMWVdcTemplate createVMWVdcTemplate(com.vmware.vcloud.api.rest.schema.extension.VMWVdcTemplateType vmwVdcTemplateType)
                                    throws VCloudException

Creating VMW VDC Template

Parameters:

vmwVdcTemplateType - VMWVdcTemplateType

Returns:

VMWVdcTemplate

Throws:

VCloudException

Since:

API 5.7, SDK 5.7

getRegisteredObjExtensionRefs

public List<com.vmware.vcloud.api.rest.schema.extension.ObjectExtensionType> getRegisteredObjExtensionRefs()
                                                                                                    throws VCloudException

Retrieves the list of currently registered object extensions.

Returns:

List

Throws:

VCloudException

Since:

API 20.0, SDK 8.10

registerObjectExtension

public com.vmware.vcloud.api.rest.schema.extension.ObjectExtensionType registerObjectExtension(com.vmware.vcloud.api.rest.schema.extension.ObjectExtensionType vmwObjExtension)
                                                                                        throws VCloudException

Registers a new object extension

Parameters:

vmwOrgExtension - ObjectExtensionType

Returns:

ObjectExtensionType

Throws:

VCloudException

Since:

API 20.0, SDK 8.10

getOperationLimitsSettings

public com.vmware.vcloud.api.rest.schema.extension.OperationLimitsSettingsType getOperationLimitsSettings()
                                                                                                   throws VCloudException

Retrieves OperationLimitsSettings

Returns:

ReferenceResult

Throws:

VCloudException

Since:

API 20.0, SDK 8.10

updateOperationLimitsSettings

public com.vmware.vcloud.api.rest.schema.extension.OperationLimitsSettingsType updateOperationLimitsSettings(com.vmware.vcloud.api.rest.schema.extension.OperationLimitsSettingsType operationLimitsSettingsType)
                                                                                                      throws VCloudException

Update OperationLimitsSettings

Returns:

ReferenceResult

Throws:

VCloudException

Since:

API 20.0, SDK 8.10