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 Deployit.

Constructor Summary

DeployitClient()

DeployitClient(ProxiesInstance proxies)

Method Summary

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	createDiscoveryTask(com.xebialabs.deployit.plugin.api.udm.ConfigurationItem ci)
void	describe(java.lang.String typeName)
java.util.List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem>	discover(com.xebialabs.deployit.plugin.api.udm.ConfigurationItem ci)
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<TaskInfo>	listAllUnfinishedTasks()
java.util.List<java.lang.String>	listImportablePackages()
java.util.List<TaskInfo>	listUnfinishedTasks()
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)
TaskInfo	retrieveTaskInfo(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)
void	startTaskAndWait(java.lang.String taskId)
void	stopTask(java.lang.String taskId)

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)

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)

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

retrieveTaskInfo

public TaskInfo retrieveTaskInfo(java.lang.String taskId)

listUnfinishedTasks

public java.util.List<TaskInfo> listUnfinishedTasks()

listAllUnfinishedTasks

public java.util.List<TaskInfo> listAllUnfinishedTasks()

discover

public java.util.List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem> discover(com.xebialabs.deployit.plugin.api.udm.ConfigurationItem ci)