com.xebialabs.deployit.cli.api

Class DeployitClient

java.lang.Object

com.xebialabs.deployit.cli.api.DocumentedObject

com.xebialabs.deployit.cli.api.DeployitClient

@CliObject(name="deployit")
public class DeployitClient
extends DocumentedObject

Main API class, exposing calls into XL Deploy.

Constructor Summary

Constructors

Constructor and Description
DeployitClient()
DeployitClient(ProxiesInstance proxies)

Method Summary

Methods

Modifier and Type	Method and Description
void	abortTask(java.lang.String taskId)
void	assignTask(java.lang.String taskId, java.lang.String owner)
void	cancelTask(java.lang.String taskId)
com.xebialabs.deployit.core.api.dto.Comparison	compare(java.lang.String reference, java.util.List<java.lang.String> ids)
java.lang.String	createControlTask(com.xebialabs.deployit.engine.api.dto.Control control)
java.lang.String	createDiscoveryTask(com.xebialabs.deployit.plugin.api.udm.ConfigurationItem ci)
void	describe(java.lang.String typeName)
void	executeControlTask(java.lang.String taskName, com.xebialabs.deployit.plugin.api.udm.ConfigurationItem ci)
com.xebialabs.deployit.plugin.api.udm.ConfigurationItem	importPackage(java.lang.String importablePackageName)
com.xebialabs.deployit.engine.api.dto.ServerInfo	info()
java.util.List<java.lang.String>	listImportablePackages()
com.xebialabs.deployit.engine.api.dto.Control	prepareControlTask(com.xebialabs.deployit.plugin.api.udm.ConfigurationItem ci, java.lang.String taskName)
void	print(java.util.Collection<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem> cis)
void	print(com.xebialabs.deployit.plugin.api.udm.ConfigurationItem ci)
java.util.List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem>	retrieveDiscoveryResults(java.lang.String taskId)
void	runGarbageCollector()
void	shutdown()
void	skipSteps(java.lang.String taskId, java.lang.Integer[] stepIds)
void	skipSteps(java.lang.String taskId, java.util.List<java.lang.Integer> stepIds)
void	startTask(java.lang.String taskId)
protected static void	startTask(java.lang.String taskId, ProxiesInstance proxies)
void	startTaskAndWait(java.lang.String taskId)
protected static void	startTaskAndWait(java.lang.String taskId, ProxiesInstance proxies, boolean cancelIfFailed)
void	stopTask(java.lang.String taskId)
void	waitForTask(java.lang.String taskId)
protected static void	waitForTask(java.lang.String taskId, ProxiesInstance proxies, boolean cancelIfFailed)

Methods inherited from class com.xebialabs.deployit.cli.api.DocumentedObject

help, help

Methods inherited from class java.lang.Object

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

Constructor Detail

DeployitClient

public DeployitClient()

DeployitClient

public DeployitClient(ProxiesInstance proxies)

Method Detail

importPackage

public com.xebialabs.deployit.plugin.api.udm.ConfigurationItem importPackage(java.lang.String importablePackageName)

listImportablePackages

public java.util.List<java.lang.String> listImportablePackages()

stopTask

public void stopTask(java.lang.String taskId)

startTask

public void startTask(java.lang.String taskId)

startTaskAndWait

public void startTaskAndWait(java.lang.String taskId)

waitForTask

public void waitForTask(java.lang.String taskId)

abortTask

public void abortTask(java.lang.String taskId)

cancelTask

public void cancelTask(java.lang.String taskId)

skipSteps

public void skipSteps(java.lang.String taskId,
             java.util.List<java.lang.Integer> stepIds)

skipSteps

public void skipSteps(java.lang.String taskId,
             java.lang.Integer[] stepIds)

assignTask

public void assignTask(java.lang.String taskId,
              java.lang.String owner)

createDiscoveryTask

public java.lang.String createDiscoveryTask(com.xebialabs.deployit.plugin.api.udm.ConfigurationItem ci)

retrieveDiscoveryResults

public java.util.List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem> retrieveDiscoveryResults(java.lang.String taskId)

prepareControlTask

public com.xebialabs.deployit.engine.api.dto.Control prepareControlTask(com.xebialabs.deployit.plugin.api.udm.ConfigurationItem ci,
                                                               java.lang.String taskName)

createControlTask

public java.lang.String createControlTask(com.xebialabs.deployit.engine.api.dto.Control control)

executeControlTask

public void executeControlTask(java.lang.String taskName,
                      com.xebialabs.deployit.plugin.api.udm.ConfigurationItem ci)

describe

public void describe(java.lang.String typeName)

print

public void print(com.xebialabs.deployit.plugin.api.udm.ConfigurationItem ci)

print

public void print(java.util.Collection<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem> cis)

compare

public com.xebialabs.deployit.core.api.dto.Comparison compare(java.lang.String reference,
                                                     java.util.List<java.lang.String> ids)

info

public com.xebialabs.deployit.engine.api.dto.ServerInfo info()

runGarbageCollector

public void runGarbageCollector()

shutdown

public void shutdown()

startTask

protected static void startTask(java.lang.String taskId,
             ProxiesInstance proxies)

startTaskAndWait

protected static void startTaskAndWait(java.lang.String taskId,
                    ProxiesInstance proxies,
                    boolean cancelIfFailed)

waitForTask

protected static void waitForTask(java.lang.String taskId,
               ProxiesInstance proxies,
               boolean cancelIfFailed)