org.jboss.as.server.deployment

Class Attachments

java.lang.Object

org.jboss.as.server.deployment.Attachments

public final class Attachments
extends Object

Author:

David M. Lloyd

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Attachments.BundleState The state of an OSGi bundle deployment

Field Summary

Fields

Modifier and Type	Field and Description
static AttachmentKey<AttachmentList<DeploymentUnit>>	ACCESSIBLE_SUB_DEPLOYMENTS Sub deployments that are visible from this deployments module loader, in the order they are accessible.
static AttachmentKey<AttachmentList<org.jboss.modules.ModuleIdentifier>>	ADDITIONAL_ANNOTATION_INDEXES
static AttachmentKey<Map<org.jboss.modules.ModuleIdentifier,CompositeIndex>>	ADDITIONAL_ANNOTATION_INDEXES_BY_MODULE
static AttachmentKey<AttachmentList<AdditionalModuleSpecification>>	ADDITIONAL_MODULES Additional modules attached to the top level deployment
static AttachmentKey<Boolean>	ALLOW_PHASE_RESTART
static AttachmentKey<org.jboss.jandex.Index>	ANNOTATION_INDEX An annotation index for a (@link ResourceRoot).
static AttachmentKey<AttachmentList<org.jboss.msc.service.ServiceName>>	BUNDLE_ACTIVE_DEPENDENCIES Attachment key for services that the BundleActivateService depends on.
static AttachmentKey<Attachments.BundleState>	BUNDLE_STATE_KEY
static AttachmentKey<DeploymentClassIndex>	CLASS_INDEX The class index for the deployment.
static AttachmentKey<AttachmentList<org.jboss.modules.ModuleIdentifier>>	CLASS_PATH_ENTRIES Module identifiers for Class-Path information
static AttachmentKey<AttachmentList<ResourceRoot>>	CLASS_PATH_RESOURCE_ROOTS Resource roots for additional modules referenced via Class-Path.
static AttachmentKey<CompositeIndex>	COMPOSITE_ANNOTATION_INDEX The composite annotation index for this deployment.
static AttachmentKey<Boolean>	COMPUTE_COMPOSITE_ANNOTATION_INDEX Flag to indicate whether to compute the composite annotation index for this deployment.
static AttachmentKey<AtomicInteger>	DEFERRED_ACTIVATION_COUNT
static AttachmentKey<AttachmentList<String>>	DEFERRED_MODULES Flags for deferred module phase handling.
static AttachmentKey<AttachmentList<org.jboss.msc.service.ServiceName>>	DEPLOYMENT_COMPLETE_SERVICES List of services that need to be up before we consider this deployment 'done'.
static AttachmentKey<org.jboss.vfs.VirtualFile>	DEPLOYMENT_CONTENTS The deployment contents
static AttachmentKey<DeploymentOverlayIndex>	DEPLOYMENT_OVERLAY_INDEX
static AttachmentKey<Map<String,MountedDeploymentOverlay>>	DEPLOYMENT_OVERLAY_LOCATIONS
static AttachmentKey<DeploymentResourceSupport>	DEPLOYMENT_RESOURCE_SUPPORT Support for getting and creating resource models on a deployments resource.
static AttachmentKey<ResourceRoot>	DEPLOYMENT_ROOT The primary deployment root.
static AttachmentKey<Set<String>>	EXCLUDED_SUBSYSTEMS A set of subsystem names that should not be processed.
static AttachmentKey<ExtensionInfo>	EXTENSION_INFORMATION Information about extensions in a jar library deployment.
static AttachmentKey<AttachmentList<ExtensionListEntry>>	EXTENSION_LIST_ENTRIES The list of extensions given in the manifest and structure configurations.
static AttachmentKey<ExternalModuleService>	EXTERNAL_MODULE_SERVICE The external module service
static AttachmentKey<AttachmentList<String>>	INDEX_IGNORE_PATHS A list of paths within a root to ignore when indexing.
static AttachmentKey<Boolean>	INDEX_RESOURCE_ROOT An attachment that indicates if a ResourceRoot should be indexed by the AnnotationIndexProcessor.
static AttachmentKey<AttachmentList<org.jboss.msc.service.ServiceName>>	JNDI_DEPENDENCIES JNDI dependencies, only attached to the top level deployment
static AttachmentKey<String>	MANAGEMENT_NAME The name that uniquely identifies the deployment to the management layer across the domain.
static AttachmentKey<Manifest>	MANIFEST The MANIFEST.MF of the deployment unit.
static AttachmentKey<AttachmentList<ModuleDependency>>	MANIFEST_DEPENDENCIES
static AttachmentKey<org.jboss.modules.Module>	MODULE The module of this deployment unit.
static AttachmentKey<org.jboss.modules.ModuleIdentifier>	MODULE_IDENTIFIER The module identifier.
static AttachmentKey<PermissionCollection>	MODULE_PERMISSIONS The module's permission collection
static AttachmentKey<ModuleSpecification>	MODULE_SPECIFICATION Information used to build up the deployments Module
static AttachmentKey<AttachmentList<AttachableDependency>>	NEXT_PHASE_ATTACHABLE_DEPS A list of service dependencies that must be satisfied before the next deployment phase can begin executing.
static AttachmentKey<AttachmentList<org.jboss.msc.service.ServiceName>>	NEXT_PHASE_DEPS A list of service dependencies that must be satisfied before the next deployment phase can begin executing.
static AttachmentKey<Manifest>	OSGI_MANIFEST Available when the deployment contains a valid OSGi manifest
static AttachmentKey<PathManager>	PATH_MANAGER
static AttachmentKey<ProxyMetadataSource>	PROXY_REFLECTION_INDEX The reflection index used to generate jboss-invocation proxies
static AttachmentKey<DeploymentReflectionIndex>	REFLECTION_INDEX The reflection index for the deployment.
static AttachmentKey<AttachmentList<ResourceRoot>>	RESOURCE_ROOTS The additional resource roots of the deployment unit.
static AttachmentKey<String>	RUNTIME_NAME Deprecated. use DeploymentUnit.getName()
static AttachmentKey<DeploymentMountProvider>	SERVER_DEPLOYMENT_REPOSITORY The server deployment repository
static AttachmentKey<ServiceModuleLoader>	SERVICE_MODULE_LOADER The module loader for the deployment
static AttachmentKey<ServiceVerificationHandler>	SERVICE_VERIFICATION_HANDLER Deprecated. the object attached under this key does nothing
static AttachmentKey<ServicesAttachment>	SERVICES An index of ServiceLoader-type services in this deployment unit
static AttachmentKey<AttachmentList<SetupAction>>	SETUP_ACTIONS Setup actions that must be run before running an arquillian test
static AttachmentKey<AttachmentList<DeploymentUnit>>	SUB_DEPLOYMENTS Sub deployment services
static AttachmentKey<AbstractVaultReader>	VAULT_READER_ATTACHMENT_KEY
static AttachmentKey<AttachmentList<org.jboss.msc.service.ServiceName>>	WEB_DEPENDENCIES A list of services that a web deployment should have as dependencies.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NEXT_PHASE_DEPS

public static final AttachmentKey<AttachmentList<org.jboss.msc.service.ServiceName>> NEXT_PHASE_DEPS

A list of service dependencies that must be satisfied before the next deployment phase can begin executing.

NEXT_PHASE_ATTACHABLE_DEPS

public static final AttachmentKey<AttachmentList<AttachableDependency>> NEXT_PHASE_ATTACHABLE_DEPS

A list of service dependencies that must be satisfied before the next deployment phase can begin executing.

EXCLUDED_SUBSYSTEMS

public static final AttachmentKey<Set<String>> EXCLUDED_SUBSYSTEMS

A set of subsystem names that should not be processed. Any subsystem whos name is in this list will not have its deployment unit processors run.

RUNTIME_NAME

@Deprecated
public static final AttachmentKey<String> RUNTIME_NAME

Deprecated. use DeploymentUnit.getName()

The deployments runtime name

MANAGEMENT_NAME

public static final AttachmentKey<String> MANAGEMENT_NAME

The name that uniquely identifies the deployment to the management layer across the domain.

DEPLOYMENT_CONTENTS

public static final AttachmentKey<org.jboss.vfs.VirtualFile> DEPLOYMENT_CONTENTS

The deployment contents

SERVICE_VERIFICATION_HANDLER

@Deprecated
public static final AttachmentKey<ServiceVerificationHandler> SERVICE_VERIFICATION_HANDLER

Deprecated. the object attached under this key does nothing

Deprecated. The attached object does nothing; this key is only retained for binary compatiblity. The management layer handles service verification internally, with no need for involvment by deployment processors.

ALLOW_PHASE_RESTART

public static final AttachmentKey<Boolean> ALLOW_PHASE_RESTART

PATH_MANAGER

public static final AttachmentKey<PathManager> PATH_MANAGER

DEPLOYMENT_OVERLAY_INDEX

public static final AttachmentKey<DeploymentOverlayIndex> DEPLOYMENT_OVERLAY_INDEX

DEPLOYMENT_ROOT

public static final AttachmentKey<ResourceRoot> DEPLOYMENT_ROOT

The primary deployment root.

MODULE_SPECIFICATION

public static final AttachmentKey<ModuleSpecification> MODULE_SPECIFICATION

Information used to build up the deployments Module

RESOURCE_ROOTS

public static final AttachmentKey<AttachmentList<ResourceRoot>> RESOURCE_ROOTS

The additional resource roots of the deployment unit.

MANIFEST

public static final AttachmentKey<Manifest> MANIFEST

The MANIFEST.MF of the deployment unit.

OSGI_MANIFEST

public static final AttachmentKey<Manifest> OSGI_MANIFEST

Available when the deployment contains a valid OSGi manifest

CLASS_PATH_ENTRIES

public static final AttachmentKey<AttachmentList<org.jboss.modules.ModuleIdentifier>> CLASS_PATH_ENTRIES

Module identifiers for Class-Path information

CLASS_PATH_RESOURCE_ROOTS

public static final AttachmentKey<AttachmentList<ResourceRoot>> CLASS_PATH_RESOURCE_ROOTS

Resource roots for additional modules referenced via Class-Path. These are attached to the resource root that actually defined the class path entry, and are used to transitively resolve the annotation index for class path items.

EXTENSION_LIST_ENTRIES

public static final AttachmentKey<AttachmentList<ExtensionListEntry>> EXTENSION_LIST_ENTRIES

The list of extensions given in the manifest and structure configurations.

EXTENSION_INFORMATION

public static final AttachmentKey<ExtensionInfo> EXTENSION_INFORMATION

Information about extensions in a jar library deployment.

SERVER_DEPLOYMENT_REPOSITORY

public static final AttachmentKey<DeploymentMountProvider> SERVER_DEPLOYMENT_REPOSITORY

The server deployment repository

ANNOTATION_INDEX

public static final AttachmentKey<org.jboss.jandex.Index> ANNOTATION_INDEX

An annotation index for a (@link ResourceRoot). This is attached to the ResourceRoots of the deployment that contain the annotations

COMPOSITE_ANNOTATION_INDEX

public static final AttachmentKey<CompositeIndex> COMPOSITE_ANNOTATION_INDEX

The composite annotation index for this deployment.

COMPUTE_COMPOSITE_ANNOTATION_INDEX

public static final AttachmentKey<Boolean> COMPUTE_COMPOSITE_ANNOTATION_INDEX

Flag to indicate whether to compute the composite annotation index for this deployment. Absence of this flag will be cause the composite index to be attached.

INDEX_RESOURCE_ROOT

public static final AttachmentKey<Boolean> INDEX_RESOURCE_ROOT

An attachment that indicates if a ResourceRoot should be indexed by the AnnotationIndexProcessor. If this is not present then the resource root is indexed by default.

INDEX_IGNORE_PATHS

public static final AttachmentKey<AttachmentList<String>> INDEX_IGNORE_PATHS

A list of paths within a root to ignore when indexing.

SUB_DEPLOYMENTS

public static final AttachmentKey<AttachmentList<DeploymentUnit>> SUB_DEPLOYMENTS

Sub deployment services

ADDITIONAL_MODULES

public static final AttachmentKey<AttachmentList<AdditionalModuleSpecification>> ADDITIONAL_MODULES

Additional modules attached to the top level deployment

ADDITIONAL_ANNOTATION_INDEXES

public static final AttachmentKey<AttachmentList<org.jboss.modules.ModuleIdentifier>> ADDITIONAL_ANNOTATION_INDEXES

ADDITIONAL_ANNOTATION_INDEXES_BY_MODULE

public static final AttachmentKey<Map<org.jboss.modules.ModuleIdentifier,CompositeIndex>> ADDITIONAL_ANNOTATION_INDEXES_BY_MODULE

DEPLOYMENT_OVERLAY_LOCATIONS

public static final AttachmentKey<Map<String,MountedDeploymentOverlay>> DEPLOYMENT_OVERLAY_LOCATIONS

DEPLOYMENT_RESOURCE_SUPPORT

public static final AttachmentKey<DeploymentResourceSupport> DEPLOYMENT_RESOURCE_SUPPORT

Support for getting and creating resource models on a deployments resource.

VAULT_READER_ATTACHMENT_KEY

public static final AttachmentKey<AbstractVaultReader> VAULT_READER_ATTACHMENT_KEY

BUNDLE_STATE_KEY

public static final AttachmentKey<Attachments.BundleState> BUNDLE_STATE_KEY

MANIFEST_DEPENDENCIES

public static final AttachmentKey<AttachmentList<ModuleDependency>> MANIFEST_DEPENDENCIES

MODULE_IDENTIFIER

public static final AttachmentKey<org.jboss.modules.ModuleIdentifier> MODULE_IDENTIFIER

The module identifier.

DEFERRED_MODULES

public static final AttachmentKey<AttachmentList<String>> DEFERRED_MODULES

Flags for deferred module phase handling.

DEFERRED_ACTIVATION_COUNT

public static final AttachmentKey<AtomicInteger> DEFERRED_ACTIVATION_COUNT

MODULE

public static final AttachmentKey<org.jboss.modules.Module> MODULE

The module of this deployment unit.

SERVICE_MODULE_LOADER

public static final AttachmentKey<ServiceModuleLoader> SERVICE_MODULE_LOADER

The module loader for the deployment

EXTERNAL_MODULE_SERVICE

public static final AttachmentKey<ExternalModuleService> EXTERNAL_MODULE_SERVICE

The external module service

SERVICES

public static final AttachmentKey<ServicesAttachment> SERVICES

An index of ServiceLoader-type services in this deployment unit

ACCESSIBLE_SUB_DEPLOYMENTS

public static final AttachmentKey<AttachmentList<DeploymentUnit>> ACCESSIBLE_SUB_DEPLOYMENTS

Sub deployments that are visible from this deployments module loader, in the order they are accessible. This list includes the current deployment, which under normal circumstances will be the first item in the list

MODULE_PERMISSIONS

public static final AttachmentKey<PermissionCollection> MODULE_PERMISSIONS

The module's permission collection

WEB_DEPENDENCIES

public static final AttachmentKey<AttachmentList<org.jboss.msc.service.ServiceName>> WEB_DEPENDENCIES

A list of services that a web deployment should have as dependencies.

JNDI_DEPENDENCIES

public static final AttachmentKey<AttachmentList<org.jboss.msc.service.ServiceName>> JNDI_DEPENDENCIES

JNDI dependencies, only attached to the top level deployment

REFLECTION_INDEX

public static final AttachmentKey<DeploymentReflectionIndex> REFLECTION_INDEX

The reflection index for the deployment.

CLASS_INDEX

public static final AttachmentKey<DeploymentClassIndex> CLASS_INDEX

The class index for the deployment.

PROXY_REFLECTION_INDEX

public static final AttachmentKey<ProxyMetadataSource> PROXY_REFLECTION_INDEX

The reflection index used to generate jboss-invocation proxies

SETUP_ACTIONS

public static final AttachmentKey<AttachmentList<SetupAction>> SETUP_ACTIONS

Setup actions that must be run before running an arquillian test

BUNDLE_ACTIVE_DEPENDENCIES

public static final AttachmentKey<AttachmentList<org.jboss.msc.service.ServiceName>> BUNDLE_ACTIVE_DEPENDENCIES

Attachment key for services that the BundleActivateService depends on.

DEPLOYMENT_COMPLETE_SERVICES

public static final AttachmentKey<AttachmentList<org.jboss.msc.service.ServiceName>> DEPLOYMENT_COMPLETE_SERVICES

List of services that need to be up before we consider this deployment 'done'. This is used to manage initialize-in-order, and inter deployment dependencies. It would better if this could be handled by MSC without needing to add all these into a list manually