Package org.jboss.as.server.deployment

The JBossAS domain deployment subsystem classes.

See: Description

Interface Summary

Interface	Description
Attachable	An entity which can contain attachments.
DeploymentMountProvider	Provides VFS mounts of deployment content.
DeploymentPhaseContext	The deployment unit processor context.
DeploymentUnit	The deployment unit.
DeploymentUnitPhaseBuilder	Strategy for building a deployment unit phase.
DeploymentUnitPhaseDependency	Encapsulates a dependency of a DeploymentUnitPhaseService.
DeploymentUnitProcessor	A deployment processor.
SetupAction	An action that sets up and tears down some form of context (e.g.

Class Summary

Class	Description
AbstractDeploymentUnitService	Abstract service responsible for managing the life-cycle of a DeploymentUnit.
AbstractDeploymentUploadHandler	Base class for operation handlers that can handle the upload of deployment content.
AttachableDependency	Represents a phase dependency that gets attached to the phase context or the deployment unit.
AttachmentKey<T>	An immutable, type-safe object attachment key.
AttachmentList<E>	A List meant for use with an Attachable object.
Attachments
ContentCleanerService	Service in charge with cleaning left over contents from the content repository.
DeferredDeploymentOverlayDeploymentUnitProcessor	Deployment unit processor that adds content overrides to the VFS filesystem for overlays that could not be initially resolved.
DelegatingSupplier<T>	A supplier which delegates to other supplier if it is configured.
DeployerChainsService	Service wrapper for DeployerChains.
DeploymentAddHandler	Handles addition of a deployment to the model.
DeploymentCompleteServiceProcessor
DeploymentDeployHandler	Handles deployment into the runtime.
DeploymentExplodeHandler	Handler for the "explode" operation that can be performed against zipped managed content.
DeploymentFullReplaceHandler	Handles replacement in the runtime of one deployment by another.
DeploymentHandlerUtil	Utility methods used by operation handlers involved with deployment.
DeploymentHandlerUtils
DeploymentListModulesHandler	Handles listing module dependencies of a deployment and sub-deployment.
DeploymentModelUtils	Deprecated Use DeploymentResourceSupport from an attachment on the DeploymentUnit
DeploymentMountProvider.Factory
DeploymentOverlayDeploymentUnitProcessor	Deployment unit processor that adds content overrides to the VFS filesystem.
DeploymentRedeployHandler	Handles redeployment in the runtime.
DeploymentRemoveHandler	Handles removal of a deployment from the model.
DeploymentReplaceHandler	Handles replacement in the runtime of one deployment by another.
DeploymentResourceSupport	Support for creation of resources on deployments or retrieving the model of a resource on deployments.
DeploymentStatusHandler
DeploymentUndeployHandler	Handles undeployment from the runtime.
DeploymentUploadBytesHandler	Handler for the upload-deployment-bytes operation.
DeploymentUploadStreamAttachmentHandler	Handler for the upload-deployment-stream operation.
DeploymentUploadURLHandler	Handler for the upload-deployment-url operation.
DeploymentUtils	Helper class with static methods related to deployment TODO: this should probably be somewhere else
EjbDeploymentMarker	Marks a DeploymentUnit as an EJB deployment.
ExplodedDeploymentAddContentHandler	Handler for the "add-content" operation over an exploded managed deployment.
ExplodedDeploymentMarker	Marker that can be used to determine if a deployment is an exploded deployment or not
ExplodedDeploymentRemoveContentHandler	Handler for the "remove-content" operation over an exploded managed deployment.
FunctionalVoidService	Generic Service that provides no value, and delegates its start/stop to consumers.
JPADeploymentMarker	JPA Deployment marker
ManagedDeploymentBrowseContentHandler	Handler for the "browse-content" operation over an exploded managed deployment.
ManagedDeploymentReadContentHandler	Handler for the "read-content" operation over an exploded managed deployment.
ManifestHelper	Manifest helper methods
ModelContentReference	ContentReference built from the Management Model.
ModuleClassFactory
MountedDeploymentOverlay
MountExplodedMarker
PrivateSubDeploymentMarker	Marker for sub deployments that are not globally accessible, such as war's.
RegisteredDeploymentUnitProcessor
ServiceLoaderProcessor	A processor which creates a service loader index.
Services
ServicesAttachment	An attachment holding the names of services detected in the deployment unit.
SimpleAttachable	A simple implementation of Attachable which may be used as a base class or on a standalone basis.
SubDeploymentMarker	Marker for sub deployments
SubDeploymentProcessor	Deployment processor responsible to creating deployment unit services for sub-deployment.
SubDeploymentUnitService	Service responsible for installing the correct services to install a DeploymentUnit.
SubExplodedDeploymentMarker	Marker for sub deployments which will be mounted exploded

Enum Summary

Enum	Description
AbstractDeploymentUnitService.DeploymentStatus
Attachments.BundleState	Deprecated the object attached under this key does nothing - it was used for OSGi integration
MountType
Phase	An enumeration of the phases of a deployment unit's processing cycle.

Exception Summary

Exception	Description
DeploymentException	A general/parent exception for all deployment related exceptions.
DeploymentUnitProcessingException	An exception which is thrown when deployment unit processing fails.

Package org.jboss.as.server.deployment Description

The JBossAS domain deployment subsystem classes.

Deployment of a unit (typically an archive) has a number of distinct phases.

1. Phase 0: Domain Controller. This phase runs on the domain controller to perform a first-pass validation of all descriptors and other meta-information in the deployment unit.
   1. Deployment Type Identification. The type of deployment is identified, so that the proper validation sequence and deployer chain can be selected.
   2. Descriptor Validation. All descriptors in the deployment are initially validated. This typically will entail a simple XSD validation, plus a limited degree of structural validation.
   3. Domain Deployment. This phase runs on the domain controller to install the validated deployment unit into the domain model itself, and coordinate the distribution of the domain update to the relevant servers, using the deployment plan to coordinate distribution appropriately.
2. Phase 1: Server Deployment Preprocessing. This phase runs on the individual server to prepare a deployment unit for execution. After this phase, the "parent" service for the deployment item and the service corresponding to the virtual file mount are available.
   1. Deployment Type Check. If the deployment type corresponds to a subsystem that is not present in the current profile, log a message and do no further processing.
   2. Deployment Mount. Mount the deployment unit into the Virtual File System.
3. Phase 2: Server Deployment Unit Processing. This phase runs on the individual server to process the deployment unit into actual deployment items. No service batch is active during this phase.
   1. Deployment Processing. In this phase, the chain of DeploymentUnitProcessors which is associated with the deployment unit type are executed over the deployment unit to parse any descriptors, add them to the DeploymentUnit, transform them, and/or convert them into DeploymentItems. These DeploymentItems represent the deployed state of the deployment unit.
4. Phase 3: Installation. In this phase the deployment items are actually executed and added to a service batch, causing their corresponding services to be resolved and started up.

The deployment items corresponding to a deployment unit are started, stopped, and removed by way of a unit-wide dependency service.