com.xebialabs.deployit.plugin.cloud.ci

Class InstantiatableHostTemplate

java.lang.Object

com.xebialabs.deployit.plugin.api.udm.base.BaseConfigurationItem

com.xebialabs.deployit.plugin.cloud.ci.BaseHostTemplate

com.xebialabs.deployit.plugin.cloud.ci.InstantiatableHostTemplate

All Implemented Interfaces:

com.xebialabs.deployit.plugin.api.udm.ConfigurationItem, InstantiatableCloudTemplate, java.io.Serializable, java.lang.Comparable<com.xebialabs.deployit.plugin.api.udm.base.BaseConfigurationItem>

@Metadata(virtual=true,
          description="Base class for host instance templates, all independently instantiatable host instance templates must extend it")
public abstract class InstantiatableHostTemplate
extends BaseHostTemplate
implements InstantiatableCloudTemplate

See Also:

Serialized Form

Field Summary

Fields inherited from class com.xebialabs.deployit.plugin.api.udm.base.BaseConfigurationItem

id, syntheticProperties, type

Fields inherited from interface com.xebialabs.deployit.plugin.api.udm.ConfigurationItem

SYNTHETIC_PROPERTIES_FIELD, TYPE_FIELD

Constructor Summary

Constructors

Constructor and Description
InstantiatableHostTemplate()

Method Summary

Methods

Modifier and Type	Method and Description
abstract java.lang.String	getInstanceIpAddress(java.lang.String cloudId) Should return instance public IP address *and* wait until instance is considered running according to hypervisor
java.util.List<? extends com.xebialabs.deployit.plugin.api.flow.Step>	instantiate(HostParameters params)
java.util.List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem>	produceInstanceCIs(java.lang.String cloudId, com.xebialabs.deployit.plugin.api.services.Repository repository, java.lang.String hostsPath) Produce ConfigurationItems that belong to the given instance.
java.util.List<? extends com.xebialabs.deployit.plugin.api.flow.Step>	produceValidationSteps() Produce Steps to validate this template, typically verifying its XML descriptor (if present).
void	waitForAvailability(com.xebialabs.deployit.plugin.api.flow.ExecutionContext ctx, java.lang.String cloudId) Waits until the instance is available, i.e.

Methods inherited from class com.xebialabs.deployit.plugin.cloud.ci.BaseHostTemplate

getBootTimeout, getConnectionType, getMarkerPath, getOs, getPassword, getPrivateKeyFile, getRetryDelay, getUsername, getXmlDescriptor, produceInstanceCIs, produceInstanceCIs, setConnectionType, setMarkerPath, setOs, setPrivateKeyFile, setXmlDescriptor, validateDescriptor

Methods inherited from class com.xebialabs.deployit.plugin.api.udm.base.BaseConfigurationItem

compareTo, equals, get$ciAttributes, get$token, get$validationMessages, getId, getName, getProperty, getPropertyDescriptor, getType, hashCode, hasProperty, set$ciAttributes, set$token, set$validationMessages, setId, setProperty, setType, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.xebialabs.deployit.plugin.cloud.ci.InstantiatableCloudTemplate

produceCreateSteps, produceDestroySteps

Methods inherited from interface com.xebialabs.deployit.plugin.api.udm.ConfigurationItem

get$validationMessages, getId, getName, getProperty, getType, hasProperty, setId, setProperty

Constructor Detail

InstantiatableHostTemplate

public InstantiatableHostTemplate()

Method Detail

produceValidationSteps

public java.util.List<? extends com.xebialabs.deployit.plugin.api.flow.Step> produceValidationSteps()

Description copied from interface: InstantiatableCloudTemplate

Produce Steps to validate this template, typically verifying its XML descriptor (if present).

Specified by:

produceValidationSteps in interface InstantiatableCloudTemplate

Returns:

the validation Steps

instantiate

@ControlTask(label="Instantiate",
             description="Create instance from template",
             parameterType="cloud.HostParameters")
public java.util.List<? extends com.xebialabs.deployit.plugin.api.flow.Step> instantiate(HostParameters params)

produceInstanceCIs

public java.util.List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem> produceInstanceCIs(java.lang.String cloudId,
                                                                                         com.xebialabs.deployit.plugin.api.services.Repository repository,
                                                                                         java.lang.String hostsPath)
                                                                                           throws java.util.concurrent.TimeoutException

Description copied from interface: InstantiatableCloudTemplate

Produce ConfigurationItems that belong to the given instance.

Specified by:

produceInstanceCIs in interface InstantiatableCloudTemplate

Parameters:

cloudId - identifier of instance for which to return its CIs

repository - the CI repository

Returns:

the CIs related to this instance.

Throws:

java.util.concurrent.TimeoutException - if retrieval of necessary data for instance CIs takes too long

getInstanceIpAddress

public abstract java.lang.String getInstanceIpAddress(java.lang.String cloudId)
                                               throws java.util.concurrent.TimeoutException

Should return instance public IP address *and* wait until instance is considered running according to hypervisor

Throws:

java.util.concurrent.TimeoutException

waitForAvailability

public void waitForAvailability(com.xebialabs.deployit.plugin.api.flow.ExecutionContext ctx,
                       java.lang.String cloudId)
                         throws java.util.concurrent.TimeoutException

Description copied from interface: InstantiatableCloudTemplate

Waits until the instance is available, i.e. is completely booted, provisioned, etc.

Specified by:

waitForAvailability in interface InstantiatableCloudTemplate

cloudId - the id of the instance

Throws:

java.util.concurrent.TimeoutException