Package com.xebialabs.deployit

Contains the core classes, interfaces and annotations for the Deployit plugin API.

See:
Description

Interface Summary

Change<T extends Serializable>	A changes on the repository to either add, modify or delete a configuration item.
ChangePlan	A list of Changes that the user want to apply at the same time.
RunBook	Implements the logic to translate a ChangePlan into a collection of ChangeResolutions.
Step	Atomic executable action which on execution results in actually modifying the real environment.
StepExecutionContext	Defines a set of methods that a step uses to communicate with its execution engine, e.g.
StepExecutionContextListener	Interface that can be implemented by objects stored as step execution context attributes to get notified about the lifecycle of the step execution context.

Class Summary

BaseConfigurationItem	Base class for configuration items that provides convenient default implementations for BaseConfigurationItem.getLabel(), BaseConfigurationItem.setLabel(String), BaseConfigurationItem.hashCode(), BaseConfigurationItem.equals(Object), BaseConfigurationItem.toString().
ChangeResolution	Holds information on what steps to be executed (in the middleware) to make the changes "happen".
StepExecutionContextCallbackHandler	A CommandExecutionCallbackHandler that logs the output to a StepExecutionContext.

Enum Summary

ConfigurationItemProperty.Size

Defines a number of standard sizes for configuration item properties.

Exception Summary

ResolutionException

Thrown when an error occurs when a changeplan is being resolved by a RunBook.

Annotation Types Summary

ConfigurationItem	Specifies that this class is a configuration item.
ConfigurationItemDescription	Specifies the field of a ConfigurationItem that is to be injected with the description.
ConfigurationItemLabel	Specifies the field of a ConfigurationItem that is to be injected with the label.
ConfigurationItemPermissionScheme	Specifies the field of a ConfigurationItem that is to be injected with the PermissionScheme.
ConfigurationItemProperty	Specifies that this field is part of the configuration item.

Package com.xebialabs.deployit Description

Contains the core classes, interfaces and annotations for the Deployit plugin API. It contains the following kind of types:

• A collection of annotations that is used to define new configuration items: ConfigurationItem, ConfigurationItemProperty and friends.
• An interfaces that is used to define a new step, Step
• A number of classes and interfaces that are used to define new runbooks, most importantly RunBook and ChangeResolution.

Please refer to their javadocs for details and the plugin development course material for an overview.

Version:

1.2