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

I am the main API class, exposing calls into the deep innards of the Deployit tool.

Constructor Summary

DeployitClient()

DeployitClient(Proxies proxies)

Method Summary

void	abortTask(java.lang.String taskId)
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)
void	describe(java.lang.String typeName)
com.xebialabs.deployit.core.api.dto.ConfigurationItemDtos	discover(com.xebialabs.deployit.core.api.dto.ConfigurationItemDto ci)
void	executeControlTask(java.lang.String taskName, com.xebialabs.deployit.core.api.dto.ConfigurationItemDto ci)
com.xebialabs.deployit.core.api.dto.RepositoryObject	importPackage(java.lang.String importablePackageName)
com.xebialabs.deployit.core.api.dto.ServerInfo	info()
java.util.List<java.lang.String>	listImportablePackages()
void	print(com.xebialabs.deployit.core.api.dto.RepositoryObject ci)
com.xebialabs.deployit.core.api.dto.TaskInfo	retrieveTaskInfo(java.lang.String taskId)
void	runGarbageCollector()
void	shutdown()
void	skipSteps(java.lang.String taskId, 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(Proxies proxies)

Method Detail

importPackage

public com.xebialabs.deployit.core.api.dto.RepositoryObject importPackage(java.lang.String importablePackageName)

listImportablePackages

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

retrieveTaskInfo

public com.xebialabs.deployit.core.api.dto.TaskInfo retrieveTaskInfo(java.lang.String taskId)

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.lang.Integer[] stepIds)

discover

public com.xebialabs.deployit.core.api.dto.ConfigurationItemDtos discover(com.xebialabs.deployit.core.api.dto.ConfigurationItemDto ci)

executeControlTask

public void executeControlTask(java.lang.String taskName,
                               com.xebialabs.deployit.core.api.dto.ConfigurationItemDto ci)

describe

public void describe(java.lang.String typeName)

print

public void print(com.xebialabs.deployit.core.api.dto.RepositoryObject ci)

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.core.api.dto.ServerInfo info()

runGarbageCollector

public void runGarbageCollector()

shutdown

public void shutdown()