Index (engine-api 2015.6.10 API)

A B C D E F G H I L M O P Q R S T U V

A

abort(String) - Method in interface com.xebialabs.deployit.engine.api.TaskBlockService: Aborts an active task.
abort(String) - Method in interface com.xebialabs.deployit.engine.api.TaskService: Deprecated.

Aborts an active task.
AbstractDto - Class in com.xebialabs.deployit.engine.api.dto
AbstractDto() - Constructor for class com.xebialabs.deployit.engine.api.dto.AbstractDto
add(ConfigurationItem) - Method in class com.xebialabs.deployit.engine.api.dto.Deployment: Adds a ConfigurationItem to the list of deployeds of this deployment.
addAll(List<ConfigurationItem>) - Method in class com.xebialabs.deployit.engine.api.dto.Deployment: Adds a list of ConfigurationItems to the list of deployeds of this deployment.
addPause(String, String) - Method in interface com.xebialabs.deployit.engine.api.TaskBlockService: Add a pause step at the specified position.
addPause(String, int) - Method in interface com.xebialabs.deployit.engine.api.TaskService: Deprecated.

Add a pause step at the specified position.
archive(String) - Method in interface com.xebialabs.deployit.engine.api.TaskBlockService: Archive an executed task.
archive(String) - Method in interface com.xebialabs.deployit.engine.api.TaskService: Deprecated.

Archive an executed task.
ArtifactAndData - Class in com.xebialabs.deployit.engine.api.dto: The parameter object for certain REST API and it represents both the artifact CI and its data.
ArtifactAndData() - Constructor for class com.xebialabs.deployit.engine.api.dto.ArtifactAndData
ArtifactAndData(Artifact, String, InputStream) - Constructor for class com.xebialabs.deployit.engine.api.dto.ArtifactAndData
ArtifactAndData(Artifact, String, byte[]) - Constructor for class com.xebialabs.deployit.engine.api.dto.ArtifactAndData: Deprecated.
Use ArtifactAndData.ArtifactAndData(com.xebialabs.deployit.plugin.api.udm.artifact.Artifact, java.lang.String, java.io.InputStream)
ArtifactAndData(Artifact, InputStream) - Constructor for class com.xebialabs.deployit.engine.api.dto.ArtifactAndData
ArtifactAndData(Artifact, byte[]) - Constructor for class com.xebialabs.deployit.engine.api.dto.ArtifactAndData: Deprecated.
Use ArtifactAndData.ArtifactAndData(com.xebialabs.deployit.plugin.api.udm.artifact.Artifact, java.io.InputStream)
assign(String, String) - Method in interface com.xebialabs.deployit.engine.api.RoleService: Assigns a role to a user or group.
assign(String, String) - Method in interface com.xebialabs.deployit.engine.api.TaskBlockService: Assigns a task to a different user.
assign(String, String) - Method in interface com.xebialabs.deployit.engine.api.TaskService: Deprecated.

Assigns a task to a different user.

B

BlockExecutionState - Enum in com.xebialabs.deployit.engine.api.execution: All possible values for the execution state of a block.
BlockState - Interface in com.xebialabs.deployit.engine.api.execution: Information about a block.

C

cancel(String) - Method in interface com.xebialabs.deployit.engine.api.TaskBlockService: Cancels a stopped task.
cancel(String) - Method in interface com.xebialabs.deployit.engine.api.TaskService: Deprecated.

Cancels a stopped task.
candidateValues(String, String, long, long, ConfigurationItem) - Method in interface com.xebialabs.deployit.engine.api.RepositoryService: Find candidate values for a property of a ConfigurationItem.
com.xebialabs.deployit.engine.api - package com.xebialabs.deployit.engine.api: These are the public REST services exposed by the XL Deploy server.
com.xebialabs.deployit.engine.api.dto - package com.xebialabs.deployit.engine.api.dto: Copyright © 2014-2015 XebiaLabs B.V.
com.xebialabs.deployit.engine.api.execution - package com.xebialabs.deployit.engine.api.execution
com.xebialabs.deployit.engine.api.security - package com.xebialabs.deployit.engine.api.security
com.xebialabs.deployit.engine.api.task - package com.xebialabs.deployit.engine.api.task
com.xebialabs.deployit.engine.api.xml - package com.xebialabs.deployit.engine.api.xml
CompositeBlockState - Interface in com.xebialabs.deployit.engine.api.execution
ConfigurationItemId - Class in com.xebialabs.deployit.engine.api.dto: A reference to a ConfigurationItem, containing the id and type.
ConfigurationItemId() - Constructor for class com.xebialabs.deployit.engine.api.dto.ConfigurationItemId
ConfigurationItemId(String, Type) - Constructor for class com.xebialabs.deployit.engine.api.dto.ConfigurationItemId
Control - Class in com.xebialabs.deployit.engine.api.dto: The parameter object of a control task action.
Control(ConfigurationItem, String) - Constructor for class com.xebialabs.deployit.engine.api.dto.Control
Control(ConfigurationItem, String, Parameters) - Constructor for class com.xebialabs.deployit.engine.api.dto.Control
ControlService - Interface in com.xebialabs.deployit.engine.api: Provides access to control methods defined on CIs.
copy(String, String) - Method in interface com.xebialabs.deployit.engine.api.RepositoryService: Copy a configuration item in the repository.
create(String, ConfigurationItem) - Method in interface com.xebialabs.deployit.engine.api.RepositoryService: Creates a new configuration item.
create(String, ArtifactAndData) - Method in interface com.xebialabs.deployit.engine.api.RepositoryService: Creates a new artifact CI with data.
create(List<ConfigurationItem>) - Method in interface com.xebialabs.deployit.engine.api.RepositoryService: Creates multiple configuration items.
create(String) - Method in interface com.xebialabs.deployit.engine.api.RoleService: Creates a new role.
create(String, User) - Method in interface com.xebialabs.deployit.engine.api.UserService: Creates a new user.
createTask(Control) - Method in interface com.xebialabs.deployit.engine.api.ControlService: Creates the control task
createTask(Deployment) - Method in interface com.xebialabs.deployit.engine.api.DeploymentService: Creates the deployment task.
createTask(Inspection) - Method in interface com.xebialabs.deployit.engine.api.InspectionService: Creates the inspection task
createWithStepBlock(Authentication, String, List<Step>, Map<String, String>) - Method in interface com.xebialabs.deployit.engine.api.task.TaskCreationService: Create and register a task with given steps and metadata.

D

decorate(Object, OmitXmlPreamble, Class, Annotation[], MediaType) - Method in class com.xebialabs.deployit.engine.api.xml.OmitXmlPreamble.Processor
delete(String) - Method in interface com.xebialabs.deployit.engine.api.RepositoryService: Deletes a configuration item.
delete(String) - Method in interface com.xebialabs.deployit.engine.api.RoleService: Removes a role from the XL Deploy security system.
delete(String) - Method in interface com.xebialabs.deployit.engine.api.UserService: Deletes the user.
deleteList(List<String>) - Method in interface com.xebialabs.deployit.engine.api.RepositoryService: Deletes multiple configuration items from the repository.
Deployment - Class in com.xebialabs.deployit.engine.api.dto: The parameter object of a deployment action.
Deployment() - Constructor for class com.xebialabs.deployit.engine.api.dto.Deployment
Deployment.DeploymentType - Enum in com.xebialabs.deployit.engine.api.dto: The type of deployment: INITIAL, UPDATE or UNDEPLOYMENT.
DeploymentService - Interface in com.xebialabs.deployit.engine.api: Deployment management

E

effectiveDictionary(String, String, String) - Method in interface com.xebialabs.deployit.engine.api.DeploymentService: Get the effective dictionary for an environment, optionally filtered by application and container.
exists(String) - Method in interface com.xebialabs.deployit.engine.api.RepositoryService: Checks if a configuration item exists.
export(LocalDate, LocalDate) - Method in interface com.xebialabs.deployit.engine.api.TaskBlockService: Searches for tasks with detailed step information.
export(LocalDate, LocalDate) - Method in interface com.xebialabs.deployit.engine.api.TaskService: Deprecated.

Searches for tasks with detailed step information.

F

fetch(String) - Method in interface com.xebialabs.deployit.engine.api.PackageService: Deprecated.
Use PackageService.fetch(ImportFromUrlParams)
fetch(ImportFromUrlParams) - Method in interface com.xebialabs.deployit.engine.api.PackageService: Fetches a package from a URL outside of the XL Deploy Server.
FileUpload - Class in com.xebialabs.deployit.engine.api.dto: Base class for handling RESTEasy file uploads.
FileUpload() - Constructor for class com.xebialabs.deployit.engine.api.dto.FileUpload
findDescriptor(Type) - Method in interface com.xebialabs.deployit.engine.api.MetadataService: Gets the Descriptor for a specific type from the XL Deploy Type System.
forName(String) - Static method in class com.xebialabs.deployit.engine.api.security.Role

G

gc() - Method in interface com.xebialabs.deployit.engine.api.ServerService: Runs the garbage collector on the repository.
generateSelectedDeployeds(List<String>, Deployment) - Method in interface com.xebialabs.deployit.engine.api.DeploymentService: Deprecated.
Use DeploymentService.generateSelectedDeployeds(com.xebialabs.deployit.engine.api.dto.SelectedDeployment)
generateSelectedDeployeds(SelectedDeployment) - Method in interface com.xebialabs.deployit.engine.api.DeploymentService: Generates only the deployeds for the given deployables in the deployment.
generateSingleDeployed(String, String, Type, Deployment) - Method in interface com.xebialabs.deployit.engine.api.DeploymentService: Generates a deployed for the given deployable to the given container in the deployment.
get$validationMessages() - Method in class com.xebialabs.deployit.engine.api.dto.ValidatedConfigurationItem: Deprecated.
getActiveBlocks() - Method in interface com.xebialabs.deployit.engine.api.execution.TaskWithBlock: Returns list of block ids which are active at the moment.
getAllCurrentTasks() - Method in interface com.xebialabs.deployit.engine.api.TaskBlockService: Returns all active tasks for all users.
getAllCurrentTasks() - Method in interface com.xebialabs.deployit.engine.api.TaskService: Deprecated.

Returns all active tasks for all users.
getApplication() - Method in class com.xebialabs.deployit.engine.api.execution.TaskPackageDependency
getArtifact() - Method in class com.xebialabs.deployit.engine.api.dto.ArtifactAndData
getBlock() - Method in interface com.xebialabs.deployit.engine.api.execution.PhaseState
getBlock() - Method in class com.xebialabs.deployit.engine.api.execution.TaskPreviewBlock
getBlock() - Method in interface com.xebialabs.deployit.engine.api.execution.TaskWithBlock: Returns state of the root block
getBlock(String, String) - Method in interface com.xebialabs.deployit.engine.api.TaskBlockService: Returns a block by ID.
getBlocks() - Method in interface com.xebialabs.deployit.engine.api.execution.CompositeBlockState
getBlocks() - Method in interface com.xebialabs.deployit.engine.api.execution.PhaseContainerState
getClasspathEntries() - Method in class com.xebialabs.deployit.engine.api.dto.ServerInfo
getCompletionDate() - Method in interface com.xebialabs.deployit.engine.api.execution.SerializableTask
getCompletionDate() - Method in interface com.xebialabs.deployit.engine.api.execution.StepState
getConfigurationItem() - Method in class com.xebialabs.deployit.engine.api.dto.Control
getConfigurationItem() - Method in class com.xebialabs.deployit.engine.api.dto.Inspection
getContainers() - Method in class com.xebialabs.deployit.engine.api.dto.Deployment
getControlName() - Method in class com.xebialabs.deployit.engine.api.dto.Control
getControlService() - Static method in class com.xebialabs.deployit.engine.api.ServiceHolder
getCurrentMode() - Method in class com.xebialabs.deployit.engine.api.dto.ServerState
getCurrentStep() - Method in interface com.xebialabs.deployit.engine.api.execution.StepBlockState: Returns number of step which is being executed.
getCurrentStepNr() - Method in interface com.xebialabs.deployit.engine.api.execution.TaskState: Deprecated.
Use TaskState.getCurrentStepNrs() instead.
getCurrentStepNrs() - Method in interface com.xebialabs.deployit.engine.api.execution.TaskState: Deprecated.
getData() - Method in class com.xebialabs.deployit.engine.api.dto.ArtifactAndData: Deprecated.
Use com.xebialabs.deployit.engine.api.dto.ArtifactAndData#getDataInputStream()
getDataInputStream() - Method in class com.xebialabs.deployit.engine.api.dto.ArtifactAndData
getDeployables() - Method in class com.xebialabs.deployit.engine.api.dto.Deployment
getDeployedApplication() - Method in class com.xebialabs.deployit.engine.api.dto.Deployment
getDeployeds() - Method in class com.xebialabs.deployit.engine.api.dto.Deployment
getDeployment() - Method in class com.xebialabs.deployit.engine.api.dto.SelectedDeployment
getDeploymentService() - Static method in class com.xebialabs.deployit.engine.api.ServiceHolder
getDeploymentType() - Method in class com.xebialabs.deployit.engine.api.dto.Deployment
getDescription() - Method in interface com.xebialabs.deployit.engine.api.execution.BlockState: Returns description of the block.
getDescription() - Method in interface com.xebialabs.deployit.engine.api.execution.SerializableTask
getDescription() - Method in interface com.xebialabs.deployit.engine.api.execution.StepState
getEnvironment() - Method in class com.xebialabs.deployit.engine.api.dto.Deployment
getFailureCount() - Method in interface com.xebialabs.deployit.engine.api.execution.SerializableTask
getFailureCount() - Method in interface com.xebialabs.deployit.engine.api.execution.StepState
getFileData() - Method in class com.xebialabs.deployit.engine.api.dto.FileUpload
getFilename() - Method in class com.xebialabs.deployit.engine.api.dto.ArtifactAndData
getGrantedPermissions(String) - Method in interface com.xebialabs.deployit.engine.api.PermissionService: Gets all the permissions granted to a role.
getId() - Method in class com.xebialabs.deployit.engine.api.dto.ConfigurationItemId
getId() - Method in class com.xebialabs.deployit.engine.api.dto.Deployment
getId() - Method in class com.xebialabs.deployit.engine.api.dto.ValidatedConfigurationItem: Deprecated.
getId() - Method in interface com.xebialabs.deployit.engine.api.execution.BlockState: Returns id of the block.
getId() - Method in interface com.xebialabs.deployit.engine.api.execution.SerializableTask
getId() - Method in class com.xebialabs.deployit.engine.api.execution.TaskPreview: Deprecated.
getId() - Method in class com.xebialabs.deployit.engine.api.execution.TaskPreviewBlock
getId() - Method in class com.xebialabs.deployit.engine.api.security.Role
getInfo() - Method in interface com.xebialabs.deployit.engine.api.ServerService: Returns information about the configuration of the sever.
getInspectionService() - Static method in class com.xebialabs.deployit.engine.api.ServiceHolder
getLevel() - Method in class com.xebialabs.deployit.engine.api.security.Permission
getLog() - Method in interface com.xebialabs.deployit.engine.api.execution.StepState
getMetadata() - Method in interface com.xebialabs.deployit.engine.api.execution.SerializableTask
getMetadata() - Method in interface com.xebialabs.deployit.engine.api.execution.StepState
getMetadataService() - Static method in class com.xebialabs.deployit.engine.api.ServiceHolder
getMyCurrentTasks() - Method in interface com.xebialabs.deployit.engine.api.TaskBlockService: Returns the active tasks of the logged in user.
getMyCurrentTasks() - Method in interface com.xebialabs.deployit.engine.api.TaskService: Deprecated.

Returns the active tasks of the logged in user.
getMyGrantedPermissions() - Method in interface com.xebialabs.deployit.engine.api.PermissionService: Gets all the permissions granted to the logged in user.
getName() - Method in class com.xebialabs.deployit.engine.api.dto.ValidatedConfigurationItem: Deprecated.
getName() - Method in class com.xebialabs.deployit.engine.api.security.Role
getNrSteps() - Method in interface com.xebialabs.deployit.engine.api.execution.TaskState: Deprecated.
getOwner() - Method in interface com.xebialabs.deployit.engine.api.execution.SerializableTask
getPackageDependencies() - Method in interface com.xebialabs.deployit.engine.api.execution.SerializableTask
getPackageService() - Static method in class com.xebialabs.deployit.engine.api.ServiceHolder
getParameters() - Method in class com.xebialabs.deployit.engine.api.dto.Control
getPassword() - Method in class com.xebialabs.deployit.engine.api.dto.ImportFromUrlParams
getPassword() - Method in class com.xebialabs.deployit.engine.api.security.User
getPermissionName() - Method in class com.xebialabs.deployit.engine.api.security.Permission
getPermissionService() - Static method in class com.xebialabs.deployit.engine.api.ServiceHolder
getPlugin() - Method in class com.xebialabs.deployit.engine.api.dto.ServerPluginInfo
getPluginsInfo() - Method in class com.xebialabs.deployit.engine.api.dto.ServerInfo
getProperty(String) - Method in class com.xebialabs.deployit.engine.api.dto.ValidatedConfigurationItem: Deprecated.
getRepositoryService() - Static method in class com.xebialabs.deployit.engine.api.ServiceHolder
getRequiredDeployments() - Method in class com.xebialabs.deployit.engine.api.dto.Deployment
getRoleService() - Static method in class com.xebialabs.deployit.engine.api.ServiceHolder
getRoot() - Method in class com.xebialabs.deployit.engine.api.security.Permission
getScheduledDate() - Method in interface com.xebialabs.deployit.engine.api.execution.SerializableTask
getSelectedDeployableIds() - Method in class com.xebialabs.deployit.engine.api.dto.SelectedDeployment
getServerService() - Static method in class com.xebialabs.deployit.engine.api.ServiceHolder
getStartDate() - Method in interface com.xebialabs.deployit.engine.api.execution.SerializableTask
getStartDate() - Method in interface com.xebialabs.deployit.engine.api.execution.StepState
getState() - Method in interface com.xebialabs.deployit.engine.api.execution.BlockState: Returns an execution state of the block.
getState() - Method in interface com.xebialabs.deployit.engine.api.execution.SerializableTask
getState() - Method in interface com.xebialabs.deployit.engine.api.execution.StepState
getState() - Method in interface com.xebialabs.deployit.engine.api.execution.TaskState: Deprecated.
getState() - Method in interface com.xebialabs.deployit.engine.api.ServerService: Return information about current server state (is it RUNNING or in MAINTENANCE mode).
getStep(int) - Method in interface com.xebialabs.deployit.engine.api.execution.TaskWithSteps: Deprecated.
getStep(String, String, DateTime) - Method in interface com.xebialabs.deployit.engine.api.TaskBlockService: Retrieves information about a step.
getStep(String, int, DateTime) - Method in interface com.xebialabs.deployit.engine.api.TaskService: Deprecated.

Retrieves information about a step.
getSteps() - Method in interface com.xebialabs.deployit.engine.api.execution.StepBlockState: Returns states of all the states included in this block.
getSteps() - Method in class com.xebialabs.deployit.engine.api.execution.TaskPreview: Deprecated.
getSteps() - Method in interface com.xebialabs.deployit.engine.api.execution.TaskWithSteps: Deprecated.
getSteps(String, String) - Method in interface com.xebialabs.deployit.engine.api.TaskBlockService: Returns a block with steps by ID.
getSteps(String) - Method in interface com.xebialabs.deployit.engine.api.TaskService: Deprecated.

Returns a task containing step information.
getTask(String) - Method in interface com.xebialabs.deployit.engine.api.TaskBlockService: Returns a task by ID.
getTask(String) - Method in interface com.xebialabs.deployit.engine.api.TaskService: Deprecated.

Returns a task by ID.
getTaskBlockService() - Static method in class com.xebialabs.deployit.engine.api.ServiceHolder
getTaskCreationService() - Static method in class com.xebialabs.deployit.engine.api.ServiceHolder
getTaskService() - Static method in class com.xebialabs.deployit.engine.api.ServiceHolder
getType() - Method in class com.xebialabs.deployit.engine.api.dto.ConfigurationItemId
getType() - Method in class com.xebialabs.deployit.engine.api.dto.ValidatedConfigurationItem: Deprecated.
getUrl() - Method in class com.xebialabs.deployit.engine.api.dto.ImportFromUrlParams
getUser() - Method in class com.xebialabs.deployit.engine.api.dto.ImportFromUrlParams
getUsername() - Method in class com.xebialabs.deployit.engine.api.security.User
getUserService() - Static method in class com.xebialabs.deployit.engine.api.ServiceHolder
getValidations() - Method in class com.xebialabs.deployit.engine.api.dto.ValidatedConfigurationItem: Deprecated.
getVersion() - Method in class com.xebialabs.deployit.engine.api.dto.Deployment
getVersion() - Method in class com.xebialabs.deployit.engine.api.dto.ServerInfo
getVersion() - Method in class com.xebialabs.deployit.engine.api.dto.ServerPluginInfo
getVersion() - Method in class com.xebialabs.deployit.engine.api.execution.TaskPackageDependency
getWrapped() - Method in class com.xebialabs.deployit.engine.api.dto.ValidatedConfigurationItem: Deprecated.
grant(String, String, String) - Method in interface com.xebialabs.deployit.engine.api.PermissionService: Grants a permission to a role on a CI.

H

hasProperty(String) - Method in class com.xebialabs.deployit.engine.api.dto.ValidatedConfigurationItem: Deprecated.

I

ImportFromUrlParams - Class in com.xebialabs.deployit.engine.api.dto: Base class for handling import URL actions.
ImportFromUrlParams() - Constructor for class com.xebialabs.deployit.engine.api.dto.ImportFromUrlParams
ImportFromUrlParams(String) - Constructor for class com.xebialabs.deployit.engine.api.dto.ImportFromUrlParams
ImportFromUrlParams(String, String, String) - Constructor for class com.xebialabs.deployit.engine.api.dto.ImportFromUrlParams
importPackage(String) - Method in interface com.xebialabs.deployit.engine.api.PackageService: Imports a package that is present in the importablePackages directory on the XL Deploy Server.
Inspection - Class in com.xebialabs.deployit.engine.api.dto: The parameter object of a inspection (discovery) action.
Inspection(ConfigurationItem) - Constructor for class com.xebialabs.deployit.engine.api.dto.Inspection
InspectionService - Interface in com.xebialabs.deployit.engine.api: Inspects middleware.
isActive() - Method in enum com.xebialabs.deployit.engine.api.execution.TaskExecutionState: If the task is in an active state, the task can go into a different state by itself.
isAdmin() - Method in class com.xebialabs.deployit.engine.api.security.User
isDeployed(String, String) - Method in interface com.xebialabs.deployit.engine.api.DeploymentService: Returns whether or not a udm.Version of the udm.Application that is passed in is already deployed to the udm.Environment.
isExecutingSteps() - Method in enum com.xebialabs.deployit.engine.api.execution.TaskExecutionState: Determines if the task is in a state where it is executing steps.
isExecutionHalted() - Method in enum com.xebialabs.deployit.engine.api.execution.TaskExecutionState: Determines if the task has been executing but is halted and can be continued.
isFinal() - Method in enum com.xebialabs.deployit.engine.api.execution.StepExecutionState
isFinal() - Method in enum com.xebialabs.deployit.engine.api.execution.TaskExecutionState: If the task is in a final state, it will never change again to another state.
isFinished() - Method in enum com.xebialabs.deployit.engine.api.execution.BlockExecutionState
isFinished() - Method in enum com.xebialabs.deployit.engine.api.execution.StepExecutionState
isGranted(String, String, String) - Method in interface com.xebialabs.deployit.engine.api.PermissionService: Checks if a permission is granted to a role on a CI.
isGrantedToMe(String, String) - Method in interface com.xebialabs.deployit.engine.api.PermissionService: Checks if the currently logged in user has a certain permission on a CI.
isNotBeenExecuting() - Method in enum com.xebialabs.deployit.engine.api.execution.TaskExecutionState: Determines if the task is never been executing.
isOfType(Deployment.DeploymentType) - Method in class com.xebialabs.deployit.engine.api.dto.Deployment
isParallel() - Method in interface com.xebialabs.deployit.engine.api.execution.CompositeBlockState
isPassive() - Method in enum com.xebialabs.deployit.engine.api.execution.TaskExecutionState: If the task is in a passive state, the task will not go into a different state by itself.
isPassiveAfterExecuting() - Method in enum com.xebialabs.deployit.engine.api.execution.TaskExecutionState: Determines if the task is passive but it has been executing steps.

L

licenseReload() - Method in interface com.xebialabs.deployit.engine.api.ServerService: Reload and validate the license file from disk.
list() - Method in interface com.xebialabs.deployit.engine.api.PackageService: Lists all packages that are present in the importablePackages directory on the XL Deploy Server.
list() - Method in interface com.xebialabs.deployit.engine.api.RoleService: Lists the names of all available roles in the security system.
listDescriptors() - Method in interface com.xebialabs.deployit.engine.api.MetadataService: Lists all the Descriptors of all the types known to the XL Deploy Type System.
listMyRoles() - Method in interface com.xebialabs.deployit.engine.api.RoleService: Lists the roles of the currently logged in user.
listOrchestrators() - Method in interface com.xebialabs.deployit.engine.api.MetadataService: Lists all the Orchestrator names that can be used to orchestrate a Deployment done by the DeploymentService.
listPermissions() - Method in interface com.xebialabs.deployit.engine.api.MetadataService: Lists all the Permissions that can be granted or revoked.
listRoles(String) - Method in interface com.xebialabs.deployit.engine.api.RoleService: Lists the roles of a user.
logout() - Method in interface com.xebialabs.deployit.engine.api.ServerService: Logs out the current user.

M

MetadataService - Interface in com.xebialabs.deployit.engine.api: Provides XL Deploy's metadata: available types, permissions and orchestrators.
modifyPassword(String, User) - Method in interface com.xebialabs.deployit.engine.api.UserService: Changes the password of the indicated user.
move(String, String) - Method in interface com.xebialabs.deployit.engine.api.RepositoryService: Moves a configuration item in the repository.
moveStep(String, int, int) - Method in interface com.xebialabs.deployit.engine.api.TaskService: Deprecated.

Moves a step.

O

OmitXmlPreamble - Annotation Type in com.xebialabs.deployit.engine.api.xml: Ensures that the XML Preamble is removed from the response, this facilitates certain broken Rest clients which need a wrapped XML response.
OmitXmlPreamble.Processor - Class in com.xebialabs.deployit.engine.api.xml: Needs object as generic type, to prevent RESTEASY-701 from appearing.
OmitXmlPreamble.Processor() - Constructor for class com.xebialabs.deployit.engine.api.xml.OmitXmlPreamble.Processor

P

PackageService - Interface in com.xebialabs.deployit.engine.api: Manages Deployment Packages.
Permission - Class in com.xebialabs.deployit.engine.api.security: XL Deploy supports a role-based access control scheme to ensure the security of your middleware and deployments.
Permission() - Constructor for class com.xebialabs.deployit.engine.api.security.Permission
Permission(String, String, String) - Constructor for class com.xebialabs.deployit.engine.api.security.Permission
PermissionService - Interface in com.xebialabs.deployit.engine.api: Manages permissions in XL Deploy.
PhaseContainerState - Interface in com.xebialabs.deployit.engine.api.execution
PhaseState - Interface in com.xebialabs.deployit.engine.api.execution
prepare(String, String) - Method in interface com.xebialabs.deployit.engine.api.ControlService: Returns a parameter object for the task that will execute the control task method.
prepare(ConfigurationItem) - Method in interface com.xebialabs.deployit.engine.api.InspectionService: Initializes the task parameter object for inspection on a CI.
prepare(String) - Method in interface com.xebialabs.deployit.engine.api.InspectionService: Initializes the task parameter object for inspection on a CI.
prepareAutoDeployeds(Deployment) - Method in interface com.xebialabs.deployit.engine.api.DeploymentService: Prepares all the deployeds for the given deployment.
prepareInitial(String, String) - Method in interface com.xebialabs.deployit.engine.api.DeploymentService: Prepares an initial deployment.
prepareUndeploy(String) - Method in interface com.xebialabs.deployit.engine.api.DeploymentService: Prepares an undeployment.
prepareUpdate(String, String) - Method in interface com.xebialabs.deployit.engine.api.DeploymentService: Prepares an update deployment.

Q

query(Type, String, String, String, DateTime, DateTime, long, long) - Method in interface com.xebialabs.deployit.engine.api.RepositoryService: Retrieves configuration items by way of a query.
query(LocalDate, LocalDate) - Method in interface com.xebialabs.deployit.engine.api.TaskBlockService: Searches for archived tasks without step information.
query(LocalDate, LocalDate) - Method in interface com.xebialabs.deployit.engine.api.TaskService: Deprecated.

Searches for archived tasks without step information.

R

read(String) - Method in interface com.xebialabs.deployit.engine.api.RepositoryService: Reads a configuration item from the repository.
read(List<String>) - Method in interface com.xebialabs.deployit.engine.api.RepositoryService: Reads multiple configuration items from the repository.
read(String) - Method in interface com.xebialabs.deployit.engine.api.UserService: Returns the user details without the password.
rename(String, String) - Method in interface com.xebialabs.deployit.engine.api.RepositoryService: Changes the name of a configuration item in the repository.
rename(String, String) - Method in interface com.xebialabs.deployit.engine.api.RoleService: Renames a role.
RepositoryService - Interface in com.xebialabs.deployit.engine.api: Provides access to the XL Deploy repository.
retrieveInspectionResults(String) - Method in interface com.xebialabs.deployit.engine.api.InspectionService: Retrieved the inspection results
revoke(String, String, String) - Method in interface com.xebialabs.deployit.engine.api.PermissionService: Revokes the permission of a role on a CI.
Role - Class in com.xebialabs.deployit.engine.api.security
Role() - Constructor for class com.xebialabs.deployit.engine.api.security.Role
Role(Integer, String) - Constructor for class com.xebialabs.deployit.engine.api.security.Role
RoleService - Interface in com.xebialabs.deployit.engine.api: Manages the roles in XL Deploy's security system.
rollback(String) - Method in interface com.xebialabs.deployit.engine.api.DeploymentService: Rollback a STOPPED or EXECUTED task.

S

schedule(String, DateTime) - Method in interface com.xebialabs.deployit.engine.api.TaskBlockService: Schedules a task.
schedule(String, DateTime) - Method in interface com.xebialabs.deployit.engine.api.TaskService: Deprecated.

Schedules a task.
SelectedDeployment - Class in com.xebialabs.deployit.engine.api.dto: The parameter object of a selected deployment action.
SelectedDeployment(List<String>, Deployment) - Constructor for class com.xebialabs.deployit.engine.api.dto.SelectedDeployment
SelectedDeployment() - Constructor for class com.xebialabs.deployit.engine.api.dto.SelectedDeployment
SerializableTask - Interface in com.xebialabs.deployit.engine.api.execution: Represents a task.
ServerInfo - Class in com.xebialabs.deployit.engine.api.dto: Contains information about a server instance.
ServerInfo() - Constructor for class com.xebialabs.deployit.engine.api.dto.ServerInfo
ServerPluginInfo - Class in com.xebialabs.deployit.engine.api.dto: Contains information about a server plugin, as specified in plugin-version.properties file.
ServerPluginInfo() - Constructor for class com.xebialabs.deployit.engine.api.dto.ServerPluginInfo
ServerPluginInfo(String, String) - Constructor for class com.xebialabs.deployit.engine.api.dto.ServerPluginInfo
ServerService - Interface in com.xebialabs.deployit.engine.api: Services related to the operation of the XL Deploy server process.
ServerState - Class in com.xebialabs.deployit.engine.api.dto: Contains information about server state.
ServerState() - Constructor for class com.xebialabs.deployit.engine.api.dto.ServerState
ServiceHolder - Class in com.xebialabs.deployit.engine.api
ServiceHolder(ControlService, DeploymentService, InspectionService, MetadataService, PackageService, PermissionService, RepositoryService, RoleService, ServerService, TaskService, TaskBlockService, UserService, TaskCreationService) - Constructor for class com.xebialabs.deployit.engine.api.ServiceHolder
ServiceHolder() - Constructor for class com.xebialabs.deployit.engine.api.ServiceHolder
setAdmin(boolean) - Method in class com.xebialabs.deployit.engine.api.security.User
setArtifact(Artifact) - Method in class com.xebialabs.deployit.engine.api.dto.ArtifactAndData
setBlock(BlockState) - Method in class com.xebialabs.deployit.engine.api.execution.TaskPreviewBlock
setClasspathEntries(List<String>) - Method in class com.xebialabs.deployit.engine.api.dto.ServerInfo
setContainers(List<ConfigurationItemId>) - Method in class com.xebialabs.deployit.engine.api.dto.Deployment
setCurrentMode(String) - Method in class com.xebialabs.deployit.engine.api.dto.ServerState
setData(byte[]) - Method in class com.xebialabs.deployit.engine.api.dto.ArtifactAndData: Deprecated.
Use com.xebialabs.deployit.engine.api.dto.ArtifactAndData#setDataInputStream(java.io.InputStream)
setDataInputStream(InputStream) - Method in class com.xebialabs.deployit.engine.api.dto.ArtifactAndData
setDeployables(List<ConfigurationItemId>) - Method in class com.xebialabs.deployit.engine.api.dto.Deployment
setDeployedApplication(ConfigurationItem) - Method in class com.xebialabs.deployit.engine.api.dto.Deployment
setDeployeds(List<ConfigurationItem>) - Method in class com.xebialabs.deployit.engine.api.dto.Deployment
setDeployment(Deployment) - Method in class com.xebialabs.deployit.engine.api.dto.SelectedDeployment
setDeploymentType(Deployment.DeploymentType) - Method in class com.xebialabs.deployit.engine.api.dto.Deployment
setFileData(InputStream) - Method in class com.xebialabs.deployit.engine.api.dto.FileUpload
setFilename(String) - Method in class com.xebialabs.deployit.engine.api.dto.ArtifactAndData
setId(String) - Method in class com.xebialabs.deployit.engine.api.dto.ConfigurationItemId
setId(String) - Method in class com.xebialabs.deployit.engine.api.dto.Deployment
setId(String) - Method in class com.xebialabs.deployit.engine.api.dto.ValidatedConfigurationItem: Deprecated.
setId(String) - Method in class com.xebialabs.deployit.engine.api.execution.TaskPreview: Deprecated.
setId(String) - Method in class com.xebialabs.deployit.engine.api.execution.TaskPreviewBlock
setId(Integer) - Method in class com.xebialabs.deployit.engine.api.security.Role
setLevel(String) - Method in class com.xebialabs.deployit.engine.api.security.Permission
setName(String) - Method in class com.xebialabs.deployit.engine.api.security.Role
setPassword(String) - Method in class com.xebialabs.deployit.engine.api.dto.ImportFromUrlParams
setPassword(String) - Method in class com.xebialabs.deployit.engine.api.security.User
setPermissionName(String) - Method in class com.xebialabs.deployit.engine.api.security.Permission
setPlugin(String) - Method in class com.xebialabs.deployit.engine.api.dto.ServerPluginInfo
setPluginsInfo(List<ServerPluginInfo>) - Method in class com.xebialabs.deployit.engine.api.dto.ServerInfo
setProperty(String, T) - Method in class com.xebialabs.deployit.engine.api.dto.ValidatedConfigurationItem: Deprecated.
setRequiredDeployments(List<Deployment>) - Method in class com.xebialabs.deployit.engine.api.dto.Deployment
setRoot(String) - Method in class com.xebialabs.deployit.engine.api.security.Permission
setSelectedDeployableIds(List<String>) - Method in class com.xebialabs.deployit.engine.api.dto.SelectedDeployment
setSteps(List<StepState>) - Method in class com.xebialabs.deployit.engine.api.execution.TaskPreview: Deprecated.
setType(Type) - Method in class com.xebialabs.deployit.engine.api.dto.ConfigurationItemId
setUrl(String) - Method in class com.xebialabs.deployit.engine.api.dto.ImportFromUrlParams
setUser(String) - Method in class com.xebialabs.deployit.engine.api.dto.ImportFromUrlParams
setUsername(String) - Method in class com.xebialabs.deployit.engine.api.security.User
setValidations(List<ValidationMessage>) - Method in class com.xebialabs.deployit.engine.api.dto.ValidatedConfigurationItem: Deprecated.
setVersion(String) - Method in class com.xebialabs.deployit.engine.api.dto.ServerInfo
setVersion(String) - Method in class com.xebialabs.deployit.engine.api.dto.ServerPluginInfo
shutdown() - Method in interface com.xebialabs.deployit.engine.api.ServerService: Stops the server process in a graceful manner.
skip(String, List<String>) - Method in interface com.xebialabs.deployit.engine.api.TaskBlockService: Indicates that one or more steps should be skipped.
skip(String, List<Integer>) - Method in interface com.xebialabs.deployit.engine.api.TaskService: Deprecated.

Indicates that one or more steps should be skipped.
start(String) - Method in interface com.xebialabs.deployit.engine.api.TaskBlockService: Starts a task.
start(String) - Method in interface com.xebialabs.deployit.engine.api.TaskService: Deprecated.

Starts a task.
startMaintenance() - Method in interface com.xebialabs.deployit.engine.api.ServerService: Put server into MAINTENANCE mode (prepare for shutdown).
StepBlockState - Interface in com.xebialabs.deployit.engine.api.execution: Information about a step block.
StepExecutionState - Enum in com.xebialabs.deployit.engine.api.execution: All possible values for the state of a step execution.
StepState - Interface in com.xebialabs.deployit.engine.api.execution: Information about a step.
StepStateLight - Interface in com.xebialabs.deployit.engine.api.execution
stop(String) - Method in interface com.xebialabs.deployit.engine.api.TaskBlockService: Gracefully stops an active task.
stop(String) - Method in interface com.xebialabs.deployit.engine.api.TaskService: Deprecated.

Gracefully stops an active task.
stopMaintenance() - Method in interface com.xebialabs.deployit.engine.api.ServerService: Put server into RUNNING mode.

T

takeover(String, String) - Method in interface com.xebialabs.deployit.engine.api.TaskBlockService: Takeover a task from the owner.
takeover(String, String) - Method in interface com.xebialabs.deployit.engine.api.TaskService: Deprecated.

Takeover a task from the owner.
TaskBlockService - Interface in com.xebialabs.deployit.engine.api: Manages tasks with blocks on the XL Deploy Server.
TaskCreationService - Interface in com.xebialabs.deployit.engine.api.task: Service which allows you to create tasks in the standard task execution context of the server.
TaskExecutionState - Enum in com.xebialabs.deployit.engine.api.execution: All possible values for the execution state of a task.
TaskPackageDependency - Class in com.xebialabs.deployit.engine.api.execution
TaskPackageDependency(String, String) - Constructor for class com.xebialabs.deployit.engine.api.execution.TaskPackageDependency
TaskPreview - Class in com.xebialabs.deployit.engine.api.execution: Deprecated.
Replaced by TaskPreviewBlock.
TaskPreview() - Constructor for class com.xebialabs.deployit.engine.api.execution.TaskPreview: Deprecated.
TaskPreview(String, List<StepState>) - Constructor for class com.xebialabs.deployit.engine.api.execution.TaskPreview: Deprecated.
taskPreviewBlock(Deployment) - Method in interface com.xebialabs.deployit.engine.api.DeploymentService: Calculate the plan that XL Deploy will execute for the given deployment.
taskPreviewBlock(Deployment, String, int) - Method in interface com.xebialabs.deployit.engine.api.DeploymentService: Get details on a step in a step block.
TaskPreviewBlock - Class in com.xebialabs.deployit.engine.api.execution: Contains the information about the generated block.
TaskPreviewBlock() - Constructor for class com.xebialabs.deployit.engine.api.execution.TaskPreviewBlock
TaskPreviewBlock(String) - Constructor for class com.xebialabs.deployit.engine.api.execution.TaskPreviewBlock
TaskPreviewBlock(String, BlockState) - Constructor for class com.xebialabs.deployit.engine.api.execution.TaskPreviewBlock
TaskService - Interface in com.xebialabs.deployit.engine.api: Deprecated.
Use TaskBlockService instead.
TaskState - Interface in com.xebialabs.deployit.engine.api.execution: Deprecated.
Use TaskWithBlock instead.
TaskWithBlock - Interface in com.xebialabs.deployit.engine.api.execution: Information about task exposed via its root block.
TaskWithSteps - Interface in com.xebialabs.deployit.engine.api.execution: Deprecated.
Use StepBlockState instead.
toString() - Method in class com.xebialabs.deployit.engine.api.dto.AbstractDto
toString() - Method in class com.xebialabs.deployit.engine.api.dto.ConfigurationItemId
toString() - Method in class com.xebialabs.deployit.engine.api.dto.ValidatedConfigurationItem: Deprecated.
toString() - Method in class com.xebialabs.deployit.engine.api.security.Role

U

unassign(String, String) - Method in interface com.xebialabs.deployit.engine.api.RoleService: Removes a role from a user or group.
unskip(String, List<String>) - Method in interface com.xebialabs.deployit.engine.api.TaskBlockService: Indicates that one or more steps should no longer be skipped, but executed.
unskip(String, List<Integer>) - Method in interface com.xebialabs.deployit.engine.api.TaskService: Deprecated.

Indicates that one or more steps should no longer be skipped, but executed.
update(String, ConfigurationItem) - Method in interface com.xebialabs.deployit.engine.api.RepositoryService: Modifies a configuration item and returns the updated CI if the the update was successful
update(String, ArtifactAndData) - Method in interface com.xebialabs.deployit.engine.api.RepositoryService: Modifies an artifact (upload new data) and returns the updated artifact if the the update was successful
update(List<ConfigurationItem>) - Method in interface com.xebialabs.deployit.engine.api.RepositoryService: Modifies multiple configuration items.
upload(String, FileUpload) - Method in interface com.xebialabs.deployit.engine.api.PackageService: Uploads a package to the XL Deploy Server.
User - Class in com.xebialabs.deployit.engine.api.security: Representation of XL Deploy user
User() - Constructor for class com.xebialabs.deployit.engine.api.security.User
User(String, boolean) - Constructor for class com.xebialabs.deployit.engine.api.security.User
UserService - Interface in com.xebialabs.deployit.engine.api: Manages users in XL Deploy's internal user repository.

V

validate(Deployment) - Method in interface com.xebialabs.deployit.engine.api.DeploymentService: Validates the generated deployment.
validate(List<ConfigurationItem>) - Method in interface com.xebialabs.deployit.engine.api.RepositoryService: Validate the configuration items, returning any validation errors found.
ValidatedConfigurationItem - Class in com.xebialabs.deployit.engine.api.dto: Deprecated.
ValidatedConfigurationItem(ConfigurationItem) - Constructor for class com.xebialabs.deployit.engine.api.dto.ValidatedConfigurationItem: Deprecated.
valueOf(String) - Static method in enum com.xebialabs.deployit.engine.api.dto.Deployment.DeploymentType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.xebialabs.deployit.engine.api.execution.BlockExecutionState: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.xebialabs.deployit.engine.api.execution.StepExecutionState: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.xebialabs.deployit.engine.api.execution.TaskExecutionState: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in class com.xebialabs.deployit.engine.api.security.Role
values() - Static method in enum com.xebialabs.deployit.engine.api.dto.Deployment.DeploymentType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.xebialabs.deployit.engine.api.execution.BlockExecutionState: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.xebialabs.deployit.engine.api.execution.StepExecutionState: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.xebialabs.deployit.engine.api.execution.TaskExecutionState: Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G H I L M O P Q R S T U V