com.xebialabs.deployit.plugin.cloud.ci

Class BaseHostTemplate

java.lang.Object

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

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

All Implemented Interfaces:

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

@Metadata(description="Base class for instance templates, all instance templates must extend it")
public abstract class BaseHostTemplate
extends com.xebialabs.deployit.plugin.api.udm.base.BaseConfigurationItem

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
BaseHostTemplate()

Method Summary

Methods

Modifier and Type	Method and Description
int	getBootTimeout()
ConnectionType	getConnectionType()
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.lang.String	getMarkerPath()
com.xebialabs.overthere.OperatingSystemFamily	getOs()
java.lang.String	getPassword()
java.lang.String	getPrivateKeyFile()
int	getRetryDelay()
java.lang.String	getUsername()
java.lang.String	getXmlDescriptor()
java.util.List<? extends com.xebialabs.deployit.plugin.api.flow.Step>	instantiate(HostParameters params)
abstract java.util.List<? extends com.xebialabs.deployit.plugin.api.flow.Step>	produceCreateSteps(java.lang.String name, int instanceSeq) Implementations should provide list of steps needed to create instance from template
abstract java.util.List<? extends com.xebialabs.deployit.plugin.api.flow.Step>	produceDestroySteps(com.xebialabs.deployit.plugin.api.udm.ConfigurationItem instance) Implementations should provide list of steps needed to destroy instance
void	setConnectionType(ConnectionType connectionType)
void	setMarkerPath(java.lang.String markerPath)
void	setOs(com.xebialabs.overthere.OperatingSystemFamily os)
void	setPrivateKeyFile(java.lang.String privateKeyFile)
void	setXmlDescriptor(java.lang.String xmlDescriptor)
java.util.List<? extends com.xebialabs.deployit.plugin.api.flow.Step>	validateDescriptor()

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

compareTo, equals, get$token, getId, getName, getProperty, getPropertyDescriptor, getSyntheticProperties, getSyntheticProperty, getType, hashCode, hasProperty, hasSyntheticProperty, putSyntheticProperties, putSyntheticProperty, set$token, setId, setProperty, setSyntheticProperties, setType, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseHostTemplate

public BaseHostTemplate()

Method Detail

validateDescriptor

@ControlTask(label="Validate descriptor",
             description="Validate XML descriptor")
public java.util.List<? extends com.xebialabs.deployit.plugin.api.flow.Step> validateDescriptor()

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)

getXmlDescriptor

public java.lang.String getXmlDescriptor()

setXmlDescriptor

public void setXmlDescriptor(java.lang.String xmlDescriptor)

setPrivateKeyFile

public void setPrivateKeyFile(java.lang.String privateKeyFile)

setMarkerPath

public void setMarkerPath(java.lang.String markerPath)

getPrivateKeyFile

public java.lang.String getPrivateKeyFile()

getOs

public com.xebialabs.overthere.OperatingSystemFamily getOs()

setOs

public void setOs(com.xebialabs.overthere.OperatingSystemFamily os)

getUsername

public java.lang.String getUsername()

getPassword

public java.lang.String getPassword()

getMarkerPath

public java.lang.String getMarkerPath()

getBootTimeout

public int getBootTimeout()

getRetryDelay

public int getRetryDelay()

getConnectionType

public ConnectionType getConnectionType()

setConnectionType

public void setConnectionType(ConnectionType connectionType)

produceCreateSteps

public abstract java.util.List<? extends com.xebialabs.deployit.plugin.api.flow.Step> produceCreateSteps(java.lang.String name,
                                                                                       int instanceSeq)

Implementations should provide list of steps needed to create instance from template

produceDestroySteps

public abstract java.util.List<? extends com.xebialabs.deployit.plugin.api.flow.Step> produceDestroySteps(com.xebialabs.deployit.plugin.api.udm.ConfigurationItem instance)

Implementations should provide list of steps needed to destroy instance

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