com.xebialabs.deployit.plugin.python
Interface PythonManagingContainer

All Superinterfaces:

com.xebialabs.deployit.plugin.api.udm.ConfigurationItem, com.xebialabs.deployit.plugin.api.udm.Container, java.io.Serializable, com.xebialabs.deployit.plugin.api.udm.Taggable

public interface PythonManagingContainer
extends com.xebialabs.deployit.plugin.api.udm.Container

Interface implemented by containers that manage other containers through Python.

Field Summary

static java.lang.String	CONNECT_FROM_DAEMON Name of the Python function to implement in the container specific runtime that connects to the managing server, when running from the daemon.
static java.lang.String	CONNECT_FROM_STAND_ALONE_SCRIPT Name of the Python function to implement in the container specific runtime that connects to the managing server, when running from a stand alone script.
static java.lang.String	DISCONNECT_FROM_DAEMON Name of the Python function to implement in the container specific runtime that disconnects from the managing server, when running from the daemon.
static java.lang.String	DISCONNECT_FROM_STAND_ALONE_SCRIPT Name of the Python function to implement in the container specific runtime that disconnects from the managing server, when running from a stand alone script.
static java.lang.String	RUN_SCRIPT_FROM_DAEMON Name of the Python function to implement in the container specific runtime that runs a script from the daemon.

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

SYNTHETIC_PROPERTIES_FIELD, TYPE_FIELD

Method Summary

com.xebialabs.deployit.plugin.overthere.Host	getHost() Returns the host on which this container runs.
java.lang.String	getRuntimePath() Returns the name of the directory on the classpath that contains the PowerShell scripts that define the runtime for this container.
com.xebialabs.overthere.CmdLine	getScriptCommandLine(com.xebialabs.overthere.OverthereFile script) Generates the command line that should be used to run a script.
boolean	runWithDaemon() true if the python daemon should be started to manage this container.

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

getTags, setTags

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

getId, getName, getProperty, getSyntheticProperties, getSyntheticProperty, getType, hasProperty, putSyntheticProperty, setId, setProperty

Field Detail

CONNECT_FROM_STAND_ALONE_SCRIPT

static final java.lang.String CONNECT_FROM_STAND_ALONE_SCRIPT

Name of the Python function to implement in the container specific runtime that connects to the managing server, when running from a stand alone script.

See Also:

Constant Field Values

DISCONNECT_FROM_STAND_ALONE_SCRIPT

static final java.lang.String DISCONNECT_FROM_STAND_ALONE_SCRIPT

Name of the Python function to implement in the container specific runtime that disconnects from the managing server, when running from a stand alone script.

See Also:

Constant Field Values

CONNECT_FROM_DAEMON

static final java.lang.String CONNECT_FROM_DAEMON

Name of the Python function to implement in the container specific runtime that connects to the managing server, when running from the daemon.

See Also:

Constant Field Values

RUN_SCRIPT_FROM_DAEMON

static final java.lang.String RUN_SCRIPT_FROM_DAEMON

Name of the Python function to implement in the container specific runtime that runs a script from the daemon.

See Also:

Constant Field Values

DISCONNECT_FROM_DAEMON

static final java.lang.String DISCONNECT_FROM_DAEMON

Name of the Python function to implement in the container specific runtime that disconnects from the managing server, when running from the daemon.

See Also:

Constant Field Values

Method Detail

getHost

com.xebialabs.deployit.plugin.overthere.Host getHost()

Returns the host on which this container runs.

getRuntimePath

java.lang.String getRuntimePath()

Returns the name of the directory on the classpath that contains the PowerShell scripts that define the runtime for this container. Should implement CONNECT_FROM_STAND_ALONE_SCRIPT, DISCONNECT_FROM_STAND_ALONE_SCRIPT, CONNECT_FROM_DAEMON, RUN_SCRIPT_FROM_DAEMON, DISCONNECT_FROM_DAEMON.

runWithDaemon

boolean runWithDaemon()

true if the python daemon should be started to manage this container.

getScriptCommandLine

com.xebialabs.overthere.CmdLine getScriptCommandLine(com.xebialabs.overthere.OverthereFile script)

Generates the command line that should be used to run a script.

Parameters:

script - the script to run

Returns:

the command line to use to run the script.