All Classes Interface Summary Class Summary Enum Summary Exception Summary Annotation Types Summary 
| Class | 
Description | 
| AbstractBaseRule | 
  | 
| AbstractDictionary | 
  | 
| ApplicableTo | 
  | 
| Application | 
 Conceptually, an Application is a configuration item (CI) representing a real-world application,
 that can be deployed on a specific middleware. 
 | 
| ApplicationDependenciesFormat | 
  | 
| ApplicationDependenciesFormat.Validator | 
  | 
| AppliedProvisioner<D extends Provisioner> | 
 Base for all Deployed counterparts of all Provisioners. 
 | 
| ArchiveArtifact | 
  | 
| Artifact | 
 Artifacts are files containing application resources such as code or images. 
 | 
| BaseAppliedProvisioner | 
 The deployed counterpart of BaseProvisioner. 
 | 
| BaseAppliedProvisionerArtifact | 
 The deployed counterpart of BaseProvisionerArtifact. 
 | 
| BaseConfigurationItem | 
Default implementation of a  ConfigurationItem that provides id, name and type information.  
 | 
| BaseConfigurationItemWithPolicies | 
 | 
| BaseContainer | 
  | 
| BaseDeployable | 
 | 
| BaseDeployableArchiveArtifact | 
  | 
| BaseDeployableArtifact | 
  | 
| BaseDeployableContainer | 
 A Container that is deployable to (provisioned on) a target platform. 
 | 
| BaseDeployableFileArtifact | 
  | 
| BaseDeployableFolderArtifact | 
  | 
| BaseDeployed<D extends Deployable,C extends Container> | 
 | 
| BaseDeployedArtifact<D extends DeployableArtifact,C extends Container> | 
  | 
| BaseDeployedContainer<D extends Deployable,C extends Container> | 
  | 
| BaseDeployedInfrastructureAsCode<D extends DeployableArtifact,C extends Container> | 
  | 
| BaseEmbeddedDeployable | 
  | 
| BaseEmbeddedDeployed<D extends EmbeddedDeployable,C extends EmbeddedDeployedContainer> | 
  | 
| BaseProvisionable | 
  | 
| BaseProvisioned<D extends Provisionable,C extends Container> | 
  | 
| BaseProvisionedContainer<D extends Provisionable,C extends Container> | 
  | 
| BaseProvisioner | 
 Base deployable for all provisioners. 
 | 
| BaseProvisionerArtifact | 
 Base deployable for all provisioners with file artifacts. 
 | 
| CandidateValueFiltersForProvisioning | 
  | 
| CandidateValuesFilter | 
A CandidateValuesFilter can augment the  SearchParameters for a ConfigurationItem search.  
 | 
| Checkpoint | 
 Defines a checkpoint for the execution of a deployment. 
 | 
| CiAttributes | 
 A container for metadata about CI's 
 | 
| CompositePackage | 
Deprecated.
 | 
| Configuration | 
 Contains deployment configuration information. 
 | 
| ConfigurationItem | 
 Base interface of all configuration item types. 
 | 
| ConfigurationItemPostConstructor | 
  | 
| Container | 
Containers are configuration items (CIs) that  Deployable CIs can be deployed to.  
 | 
| Contributor | 
 Annotates methods that contribute to a deployment plan. 
 | 
| ControlTask | 
 A control task is a method that can be invoked on a ConfigurationItem, to perform some action. 
 | 
| CopyStrategyName | 
  | 
| Create | 
Annotates a method on a  Deployed that is called when XL Deploy wants to
  create the Deployed in the middleware.  
 | 
| Creator | 
 A creator is a method that can be invoked when a ConfigurationItem is created. 
 | 
| CreatorContext | 
  | 
| CreatorDescriptor | 
 Encapsulates the metadata about the creator of a type in the XL Deploy type system. 
 | 
| DefaultOrders | 
 A Constant interface with some default named Orders, to make it easier to determine where custom steps need to go. 
 | 
| Delegate | 
A delegate can execute either:
   - a control task on a  ConfigurationItem, to perform some action.  
 | 
| Delegate.Use | 
  | 
| Delta | 
 The Delta specifies what will happen to a Deployed in a Deployment. 
 | 
| Deltas | 
 | 
| DeltaSpecification | 
The specification of what should happen on the target environment in order to deploy this  DeployedApplication 
 | 
| DeltaSpecificationWithDependencies | 
 The specification of what needs to be deployed including application dependencies. 
 | 
| Deployable | 
 | 
| DeployableArtifact | 
  | 
| DeployableContainer | 
  | 
| Deployed<D extends Deployable,C extends Container> | 
Deployeds are configuration items (CIs) that represent  Deployables CIs in their deployed form on
 the target  Container.  
 | 
| DeployedApplication | 
 | 
| DeployedSpecific | 
  | 
| DeploymentExecutionContext | 
Deprecated.  | 
| DeploymentPackage | 
A particular version of an  Application consisting of both artifacts and resource specifications
 (a set of  Deployables) that can be deployed onto a  Container.  
 | 
| DeploymentPackage.DependencyResolution | 
 Indicates how application dependencies will be resolved when deploying an application. 
 | 
| DeploymentPlanningContext | 
 Context that is passed along during the Planning stage of a Deployment. 
 | 
| DeploymentRule | 
  | 
| DeploymentStep | 
Deprecated.
 | 
| Deprecations | 
  | 
| DerivedArtifact<D extends SourceArtifact> | 
  | 
| Descriptor | 
 Encapsulates the metadata about a type in the XL Deploy type system. 
 | 
| DescriptorRegistry | 
 | 
| DescriptorRegistryId | 
 | 
| Destroy | 
Annotates a method on a  Deployed that is called when XL Deploy wants to
  destroy the Deployed in the middleware.  
 | 
| Dictionary | 
A Dictionary is a CI that contains  Environment-specific entries for placeholder resolution.  
 | 
| Directory | 
  | 
| EmbeddedDeployable | 
 Some deployables can have modules, for example an EAR archive can contain some WAR modules inside that can potentially
 be deployed to different containers. 
 | 
| EmbeddedDeployableArtifact | 
  | 
| EmbeddedDeployed<D extends EmbeddedDeployable,C extends EmbeddedDeployedContainer> | 
 Some deployeds can have modules, for example an EAR archive can contain some WAR modules inside that can potentially
 be deployed to different containers. 
 | 
| EmbeddedDeployedArtifact<D extends EmbeddedDeployableArtifact,C extends EmbeddedDeployedContainer> | 
  | 
| EmbeddedDeployedContainer<D extends ConfigurationItem,C extends ConfigurationItem> | 
 | 
| EncryptedDictionary | 
Deprecated.
 | 
| Environment | 
An Environment is a grouping of  Container CIs (such as hosts, servers, clusters, etc.) and  Dictionary items.  
 | 
| ExecutionContext | 
Deprecated. | 
| ExecutionContext | 
  | 
| ExecutionContextListener | 
Deprecated.
 | 
| ExtendedValidationContext | 
  | 
| ExternalProperty | 
 Tagging interface to indicate an external value for a property. 
 | 
| FileArtifact | 
  | 
| FileEncodings | 
  | 
| FileEncodings.Validator | 
  | 
| FolderArtifact | 
  | 
| Host | 
 A machine that runs middleware. 
 | 
| Host.ConnectionOptionsBuilder | 
  | 
| HostContainer | 
  | 
| IDictionary | 
 Provide methods to get a value by key from a storage. 
 | 
| IDictionary.DictionaryContext | 
 Context used when processing dictionaries for a deployment. 
 | 
| IEncryptedDictionary | 
 Provide support for encrypted entries. 
 | 
| IllegalLookupValueProviderKeyException | 
  | 
| InputHint | 
  | 
| InputHint.InputHintBuilder | 
  | 
| InputHintValue | 
  | 
| Inspect | 
  | 
| InspectionContext | 
  | 
| InspectionExecutionContext | 
Deprecated. | 
| InspectionPlanningContext | 
  | 
| InspectionProperty | 
  | 
| InspectionStep | 
Deprecated.
 | 
| IsControlTaskParameters | 
  | 
| IsControlTaskParameters.Validator | 
  | 
| ITask | 
 Expose it to the ExecutionContext to allow a step to retrieve 
 the username and other information from the task object. 
 | 
| LazyConfigurationItem | 
  | 
| Lexer | 
  | 
| LookupValueKey | 
  | 
| LookupValueProvider | 
 CI that can be used to lookup external values. 
 | 
| Metadata | 
 Specifies that this class is a configuration item. 
 | 
| Metadata.ConfigurationItemRoot | 
 The root in the JCR tree. 
 | 
| MethodDescriptor | 
 Encapsulates the metadata about a control task (also named control method) of a type in the XL Deploy type system. 
 | 
| MethodVerification | 
  | 
| Modify | 
Annotates a method on a  Deployed that is called when XL Deploy wants to
  modify the Deployed in the middleware.  
 | 
| Noop | 
Annotates a method on a  Deployed that is called when XL Deploy wants to
  noop the Deployed in the middleware.  
 | 
| NoSelfReference | 
  | 
| NoSelfReference.Validator | 
  | 
| NotEmpty | 
  | 
| NotEmpty.Validator | 
  | 
| OnTaskFailurePolicy | 
 Policies used for state transition on "halted execution" tasks (e.g. 
 | 
| OnTaskSuccessPolicy | 
 Policies used for state transition on EXECUTED tasks 
 | 
| Operation | 
 The operation that is being performed on the DeployedApplication or on a single Delta object. 
 | 
| Parameters | 
 | 
| PatternValidator<Object> | 
  | 
| Placeholders | 
  | 
| Placeholders.Validator | 
  | 
| PostPlanProcessor | 
 A PostProcessor for a Plan. 
 | 
| Prefix | 
 The Prefix annotation is used to specify the CI namespace, and it is used from inside a package-info.java file. 
 | 
| PrePlanProcessor | 
 A PreProcessor for a Plan. 
 | 
| Preview | 
 An preview of the script that a step is going to execute, or of the template that will be copied. 
 | 
| PreviewStep | 
  | 
| Process | 
  | 
| Property | 
 Specifies that this field is part of the configuration item. 
 | 
| Property.Size | 
 Defines a number of standard sizes for configuration item properties. 
 | 
| PropertyDescriptor | 
 Encapsulates the metadata about a property of a type in the XL Deploy type system. 
 | 
| PropertyKind | 
 Enumeration of all the available values for a property's type. 
 | 
| Provisionable | 
  | 
| Provisioned<D extends Provisionable,C extends Container> | 
  | 
| Provisioner | 
 Base type for all provisioners. 
 | 
| ProvisioningPackage | 
  | 
| ProxyServerType | 
  | 
| PublicApi | 
 This annotation tells the generator that the class/or interface must be included
 as a first-class citizen into the generated API documentation. 
 | 
| PublicApiRef | 
 This annotation tells the generator that the class/or interface must be included
 as a reference into the generated API documentation. 
 | 
| Range | 
  | 
| Range.Validator | 
  | 
| ReadOnlyRepository | 
Deprecated.
 | 
| Regex | 
  | 
| Regex.Validator | 
  | 
| Repository | 
  | 
| RetryableStep | 
  | 
| Rule | 
  | 
| RulePostConstruct | 
Marks a method of  Step to be executed to for post construct actions.  
 | 
| SatelliteAware | 
 If a step can be executed on a Satellite, the step
  should implements this interface and code
  the access to the targeted Satellite CI. 
 | 
| Scope | 
 Please refer to rules manual for explanation of what a scope is. 
 | 
| SearchParameters | 
 Declarative query parameters for searching the JCR repository for Configuration Items. 
 | 
| SimpleLookupValueProvider | 
  | 
| SourceArtifact | 
  | 
| StageableStep | 
  | 
| StagedFile | 
  | 
| StagingContext | 
  | 
| StagingTarget | 
  | 
| Step<C extends ExecutionContext> | 
Deprecated.
 | 
| Step | 
 A Step that can be executed for either Inspection or Deployment. 
 | 
| Step.Result | 
Deprecated. | 
| StepExitCode | 
 Return codes that should be returned from a step during execution. 
 | 
| StepMetadata | 
  | 
| StepParameter | 
  | 
| StepPostConstructContext | 
Context used for post constructing a  Step.  
 | 
| Strings | 
 String utilities 
 | 
| Taggable | 
  | 
| Template | 
  | 
| TemplateHostValidator | 
  | 
| TemplateHostValidator.Validator | 
  | 
| Type | 
Encapsulates the metadata about the type of a  ConfigurationItem,
 such as: prefix, name, type hierarchy, the source registry etc.  
 | 
| TypeIcon | 
  | 
| TypeVerification | 
  | 
| ValidationContext | 
  | 
| ValidationMessage | 
A ValidationMessage may be returned for certain operations, related to specific property of a  ConfigurationItem.  
 | 
| ValidationMessage.Level | 
  | 
| Validator<T> | 
  | 
| Verification | 
  | 
| VerificationContext | 
  | 
| Verify | 
  | 
| Version | 
 | 
| VersionRange | 
  |