# Package com.xebialabs.deployit.plugin.api.udm

Copyright 2014-2019 XebiaLabs Inc. and its affiliates. Use is subject to terms of the enclosed Legal Notice.

- Interface Summary
  Interface | Description
  --- | ---
  AppliedProvisioner<D extends Provisioner> | Base for all Deployed counterparts of all Provisioners.
  ConfigurationItem | Base interface of all configuration item types.
  Container | Containers are configuration items (CIs) that `Deployable` CIs can be deployed to.
  Deployable | Deployables are `ConfigurationItem`s (CIs) that can be deployed to a `Container`.
  DeployableArtifact |
  DeployableContainer |
  Deployed<D extends Deployable,​C extends Container> | Deployeds are configuration items (CIs) that represent `Deployable`s CIs in their deployed form on the target `Container`.
  DeploymentPackage.DependencyResolution | Indicates how application dependencies will be resolved when deploying an application.
  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.
  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.
  EmbeddedDeployedContainer<D extends ConfigurationItem,​C extends ConfigurationItem> | A super type for both `Deployed`s and `EmbeddedDeployed`s.
  ExternalProperty | Tagging interface to indicate an external value for a property.
  IDictionary | Provide methods to get a value by key from a storage.
  IEncryptedDictionary | Provide support for encrypted entries.
  LazyConfigurationItem |
  Provisionable |
  Provisioned<D extends Provisionable,​C extends Container> |
  Provisioner | Base type for all provisioners.
  Taggable |

- Class Summary
  Class | Description
  --- | ---
  AbstractDictionary |
  Application | Conceptually, an Application is a configuration item (CI) representing a real-world application, that can be deployed on a specific middleware.
  BaseAppliedProvisioner | The deployed counterpart of BaseProvisioner.
  BaseAppliedProvisionerArtifact | The deployed counterpart of BaseProvisionerArtifact.
  BaseDeployableContainer | A Container that is deployable to (provisioned on) a target platform.
  BaseDeployedContainer<D extends Deployable,​C extends Container> |
  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 |
  CiAttributes | A container for metadata about CI's
  CompositePackage | Deprecated. Using dependencies and multi-application deployments you can now do what you previously needed udm.CompositePackage s for.
  Configuration | Contains deployment configuration information.
  DeployedApplication | A deployment of an application package (a `Version`) on an `Environment`.
  DeploymentPackage | A particular version of an `Application` consisting of both artifacts and resource specifications (a set of `Deployable`s) that can be deployed onto a `Container`.
  Dictionary | A Dictionary is a CI that contains `Environment`-specific entries for placeholder resolution.
  EncryptedDictionary | Deprecated. Please use the `Dictionary` with encrypted values.
  Environment | An Environment is a grouping of `Container` CIs (such as hosts, servers, clusters, etc.) and `Dictionary` items.
  IDictionary.DictionaryContext | Context used when processing dictionaries for a deployment.
  Parameters | A `ConfigurationItem` that can be used as a parameter for `ControlTask` method.
  ProvisioningPackage |
  Template |
  TemplateHostValidator.Validator |
  Version | A Version of an `Application`, which can be represented either as a `DeploymentPackage` or as a `CompositePackage`.

- Enum Summary
  Enum | Description
  --- | ---
  Delegate.Use |
  Metadata.ConfigurationItemRoot | The root in the JCR tree.
  OnTaskFailurePolicy | Policies used for state transition on "halted execution" tasks (e.g.
  OnTaskSuccessPolicy | Policies used for state transition on EXECUTED tasks
  Property.Size | Defines a number of standard sizes for configuration item properties.

- Annotation Types Summary
  Annotation Type | Description
  --- | ---
  CandidateValuesFilter | A CandidateValuesFilter can augment the `SearchParameters` for a ConfigurationItem search.
  ControlTask | A control task is a method that can be invoked on a ConfigurationItem, to perform some action.
  Creator | A creator is a method that can be invoked when a ConfigurationItem is created.
  Delegate | A delegate can execute either: - a control task on a `ConfigurationItem`, to perform some action.
  DeployedSpecific |
  Metadata | Specifies that this class is a configuration item.
  Prefix | The Prefix annotation is used to specify the CI namespace, and it is used from inside a package-info.java file.
  Property | Specifies that this field is part of the configuration item.
  TemplateHostValidator |
  TypeIcon |