All Classes and Interfaces
Class
Description
Conceptually, an Application is a configuration item (CI) representing a real-world application,
that can be deployed on a specific middleware.
Base for all Deployed counterparts of all Provisioners.
Artifacts are files containing application resources such as code or images.
The deployed counterpart of BaseProvisioner.
The deployed counterpart of BaseProvisionerArtifact.
Default implementation of a
ConfigurationItem that provides id, name and type information.Implementation of a
BaseConfigurationItem that provides on success policy.Anything that is deployable to a
ContainerA Container that is deployable to (provisioned on) a target platform.
A
Deployable deployed to a Container.Base deployable for all provisioners.
Base deployable for all provisioners with file artifacts.
A CandidateValuesFilter can augment the
SearchParameters for a ConfigurationItem search.Defines a checkpoint for the execution of a deployment.
A container for metadata about CI's
Deprecated.
Using dependencies and multi-application deployments you can now do what you previously needed udm.CompositePackage s for.
Contains deployment configuration information.
Base interface of all configuration item types.
The annotated element must contain the specified values.
Containers are configuration items (CIs) that
Deployable CIs can be deployed to.Annotates methods that contribute to a deployment plan.
A control task is a method that can be invoked on a ConfigurationItem, to perform some action.
A creator is a method that can be invoked when a ConfigurationItem is created.
Encapsulates the metadata about the creator of a type in the XL Deploy type system.
A Constant interface with some default named Orders, to make it easier to determine where custom steps need to go.
A delegate can execute either:
- a control task on a
ConfigurationItem, to perform some action.The Delta specifies what will happen to a Deployed in a Deployment.
A collection of
DeltasThe specification of what should happen on the target environment in order to deploy this
DeployedApplicationThe specification of what needs to be deployed including application dependencies.
Deployables are
ConfigurationItems (CIs) that can be deployed to a Container.Deployeds are configuration items (CIs) that represent
Deployables CIs in their deployed form on
the target Container.A deployment of an application package (a
Version) on an Environment.Deprecated.
A particular version of an
Application consisting of both artifacts and resource specifications
(a set of Deployables) that can be deployed onto a Container.Indicates how application dependencies will be resolved when deploying an application.
Context that is passed along during the Planning stage of a Deployment.
Deprecated.
Implement
Step instead, to be removed in 3.9Encapsulates the metadata about a type in the XL Deploy type system.
A registry for the
ConfigurationItems the
XL Deploy system should know about.Contract for a
IDescriptorRegistry id.A Dictionary is a CI that contains
Environment-specific entries for placeholder resolution.Some deployables can have modules, for example an EAR archive can contain some WAR modules inside that can potentially
be deployed to different containers.
Some deployeds can have modules, for example an EAR archive can contain some WAR modules inside that can potentially
be deployed to different containers.
A super type for both
Deployeds and EmbeddedDeployeds.Deprecated.
Please use the
Dictionary with encrypted values.An Environment is a grouping of
Container CIs (such as hosts, servers, clusters, etc.) and Dictionary items.Deprecated.
Deprecated.
Please use the ExecutionStateListener in order to get more advanced signals.
Tagging interface to indicate an external value for a property.
A machine that runs middleware.
Provide methods to get a value by key from a storage.
Context used when processing dictionaries for a deployment.
Provide support for encrypted entries.
Deprecated.
Deprecated.
Implement
Step instead, to be removed in 3.9Expose it to the ExecutionContext to allow a step to retrieve
the username and other information from the task object.
CI that can be used to lookup external values.
Specifies that this class is a configuration item.
The root in the JCR tree.
Encapsulates the metadata about a control task (also named control method) of a type in the XL Deploy type system.
The annotated element must not contain the specified values.
Policies used for state transition on "halted execution" tasks (e.g.
Policies used for state transition on EXECUTED tasks
The operation that is being performed on the DeployedApplication or on a single Delta object.
A
ConfigurationItem that can be used as a parameter for ControlTask method.A PostProcessor for a Plan.
The Prefix annotation is used to specify the CI namespace, and it is used from inside a package-info.java file.
A PreProcessor for a Plan.
An preview of the script that a step is going to execute, or of the template that will be copied.
Specifies that this field is part of the configuration item.
Defines a number of standard sizes for configuration item properties.
Encapsulates the metadata about a property of a type in the XL Deploy type system.
Enumeration of all the available values for a property's type.
Base type for all provisioners.
This annotation tells the generator that the class/or interface must be included
as a first-class citizen into the generated API documentation.
This annotation tells the generator that the member must be included
into the generated API documentation.
This annotation tells the generator that the class/or interface must be included
as a reference into the generated API documentation.
Deprecated.
Replaced by
RepositoryMarks a method of
Step to be executed to for post construct actions.If a step can be executed on a Satellite, the step
should implements this interface and code
the access to the targeted Satellite CI.
should implements this interface and code
the access to the targeted Satellite CI.
Please refer to rules manual for explanation of what a scope is.
Declarative query parameters for searching the JCR repository for Configuration Items.
This annotation tells the generator that only only members annotated with @PublicApiMember
must be included into the generated documentation.
The annotated element size must be between the specified boundaries (included).
Deprecated.
Use
StepA Step that can be executed for either Inspection or Deployment.
Deprecated.
Return codes that should be returned from a step during execution.
Context used for post constructing a
Step.String utilities
Encapsulates the metadata about the type of a
ConfigurationItem,
such as: prefix, name, type hierarchy, the source registry etc.A ValidationMessage may be returned for certain operations, related to specific property of a
ConfigurationItem.A Version of an
Application, which can be represented either as a DeploymentPackage or as
a CompositePackage.