com.segue.scc.published.api.cloud

Interface CloudProviderProfile

public interface CloudProviderProfile

Implementations of this interface accomplish access and control of an external cloud system, like VMware infrastructure, Microsoft Hyper-V, or a public cloud. It is used to execute automated tests on a virtual infrastructure, which is deployed on demand. This API was introduced with Silk Central 13.0 and is subject to change in future versions.

Method Summary

Modifier and Type	Method and Description
CloudDeployedInstanceInfo	deployNewInstanceFromTemplate(java.util.Map<java.lang.String,java.lang.String> templateProperties) Deploy a new instance in the cloud with the specified template properties.
java.util.Map<java.lang.String,java.lang.String>	getCloudTemplateProperties(java.lang.String template)
java.util.List<CloudTemplate>	getCloudTemplates() Retrieve the human readable names of available templates in the cloud which can be selected for a cloud execution server.
java.lang.String	getPluginVersion()
CloudProviderProperty[]	getProviderProperties() Returns the properties used to configure a cloud provider profile.
java.lang.String	getProviderTypeId()
java.lang.String	getProviderTypeLabel()
StringResolver	getStringResolver()
boolean	isInstanceRunning(java.util.Map<java.lang.String,java.lang.String> instanceProperties) Indicate if a specific instance is running
void	setLogHandler(java.util.logging.Handler logHandler) This is called once after an implementing object has been created to allow the plugin to delegate log messages to the Silk Central log file.
void	setProfileProperties(java.lang.String username, java.lang.String password, java.util.Map<java.lang.String,java.lang.String> propertyValues) Sets the property values entered in the New/Edit Cloud Provider Profile dialog as ID/value pairs.
void	undeployAndDeleteInstance(java.util.Map<java.lang.String,java.lang.String> instanceProperties) Undeploy and delete the instance identified by the passed instance properties.
void	validateProfile() Verify if the cloud can be accessed applying the properties set before with setProfileProperties(String, String, Map)

Method Detail

setLogHandler

void setLogHandler(java.util.logging.Handler logHandler)

This is called once after an implementing object has been created to allow the plugin to delegate log messages to the Silk Central log file.

Parameters:

logHandler -

getPluginVersion

java.lang.String getPluginVersion()

Returns:

the implementation version of the plugin implementing this interface

getProviderTypeId

java.lang.String getProviderTypeId()

Returns:

a unique ID used to identify the cloud provider type, this ID should never change.

getProviderTypeLabel

java.lang.String getProviderTypeLabel()

Returns:

the human readable name of the cloud provider type.

getProviderProperties

CloudProviderProperty[] getProviderProperties()

Returns the properties used to configure a cloud provider profile. The Create/Edit Cloud Provider Profile dialog calls getStringResolver() to obtain translated human readable strings for each of these properties.

Returns:

an array containing the CloudProviderPropertys for this cloud provider. Must not be null.

setProfileProperties

void setProfileProperties(java.lang.String username,
                          java.lang.String password,
                          java.util.Map<java.lang.String,java.lang.String> propertyValues)

Sets the property values entered in the New/Edit Cloud Provider Profile dialog as ID/value pairs. These properties have to be stored in an object of the implementing class to be used for further operations.

Parameters:

username - a credential string specifying the account to be used to access the Cloud

password - the password

propertyValues - the property values. The keys in the map are the names returned by getProviderProperties()

validateProfile

void validateProfile()
              throws CloudProviderProfileException

Verify if the cloud can be accessed applying the properties set before with setProfileProperties(String, String, Map)

Throws:

CloudProviderProfileException - if the validation fails

getStringResolver

StringResolver getStringResolver()

Returns:

the StringResolver used to translate the provider property IDs to human readable localized labels.

getCloudTemplates

java.util.List<CloudTemplate> getCloudTemplates()
                                         throws CloudProviderProfileException

Retrieve the human readable names of available templates in the cloud which can be selected for a cloud execution server.

Returns:

the human readable names of available templates in the cloud for the cloud provider profile.

Throws:

CloudProviderProfileException

getCloudTemplateProperties

java.util.Map<java.lang.String,java.lang.String> getCloudTemplateProperties(java.lang.String template)
                                                                     throws CloudProviderProfileException

Parameters:

template - the human readable name of the selected cloud template for which to obtain properties.

Returns:

a map containing arbitrary string/value pairs with additional information needed for the plugin to identify a cloud template.

Throws:

CloudProviderProfileException

deployNewInstanceFromTemplate

CloudDeployedInstanceInfo deployNewInstanceFromTemplate(java.util.Map<java.lang.String,java.lang.String> templateProperties)
                                                 throws CloudProviderProfileException

Deploy a new instance in the cloud with the specified template properties. A template can contain one or more virtual machines, therefore there can be multiple IP addresses accessible for the application server.

Parameters:

templateProperties - the template properties returned by getCloudTemplateProperties(String)

Returns:

an instance of CloudDeployedInstanceInfo containing one or multiple external host addresses and arbitrary properties to later identify the deployed instance.

Throws:

CloudProviderProfileException

undeployAndDeleteInstance

void undeployAndDeleteInstance(java.util.Map<java.lang.String,java.lang.String> instanceProperties)
                        throws CloudProviderProfileException

Undeploy and delete the instance identified by the passed instance properties.

Parameters:

instanceProperties - arbitrary name/value pairs describing a deployed instance as having been returned by deployNewInstanceFromTemplate(Map)

Throws:

CloudProviderProfileException

isInstanceRunning

boolean isInstanceRunning(java.util.Map<java.lang.String,java.lang.String> instanceProperties)
                   throws CloudProviderProfileException

Indicate if a specific instance is running

Parameters:

instanceProperties - arbitrary name/value pairs describing a deployed instance as having been returned by deployNewInstanceFromTemplate(Map)

Returns:

true if the instance is running, false otherwise

Throws:

CloudProviderProfileException