Class Attachments

java.lang.Object
org.jboss.as.server.deployment.Attachments

public final class Attachments extends Object
Author:
David M. Lloyd
  • Field Details

    • 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.
    • REGISTERED_SUBSYSTEMS

      public static final AttachmentKey<Set<String>> REGISTERED_SUBSYSTEMS
      Set of subsystems who register deployment unit processors to at least run in one deployment phase.
    • 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
    • DEPLOYMENT_UNIT_PHASE_SERVICE_TARGET_TRANSFORMER

      public static final AttachmentKey<UnaryOperator<org.jboss.msc.service.ServiceTarget>> DEPLOYMENT_UNIT_PHASE_SERVICE_TARGET_TRANSFORMER
      An attachment defining a transformer of the ServiceTarget used to install a deployment unit phase.
    • SPEC_DESCRIPTOR_EXPR_EXPAND_FUNCTION

      public static final AttachmentKey<Function<String,String>> SPEC_DESCRIPTOR_EXPR_EXPAND_FUNCTION
      A function which will be used to expand expressions within spec descriptors
    • WFLY_DESCRIPTOR_EXPR_EXPAND_FUNCTION

      public static final AttachmentKey<Function<String,String>> WFLY_DESCRIPTOR_EXPR_EXPAND_FUNCTION
      A function which will be used to expand expressions within JBoss/WildFly (vendor specific) descriptors
    • DEPLOYMENT_EXPRESSION_RESOLVERS

      public static final AttachmentKey<AttachmentList<Function<String,String>>> DEPLOYMENT_EXPRESSION_RESOLVERS
      Functions that can be used to resolve expressions found in deployment resources. Functions that cannot resolve a particular input must return null.
    • 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.
    • 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
    • ANNOTATION_INDEX_SUPPORT

      public static final AttachmentKey<Reference<AnnotationIndexSupport>> ANNOTATION_INDEX_SUPPORT
      A reference to a support utility object for processing annotation indices. This is attached to the DeploymentUnit for a top-level deployment and any subdeployments. A Reference holds the support object so it can be garbage collected once the management operation that created it completes.
    • 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_INDEX_MODULES

      public static final AttachmentKey<AttachmentList<String>> ADDITIONAL_INDEX_MODULES
      A list of modules for which annotation indexes should be prepared (or, in later phases, have been prepared).
    • ADDITIONAL_ANNOTATION_INDEXES_BY_MODULE_NAME

      public static final AttachmentKey<Map<String,CompositeIndex>> ADDITIONAL_ANNOTATION_INDEXES_BY_MODULE_NAME
      Annotation indices, keyed by the canonical name module from which they were obtained.
    • 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 deployment's resource.
    • CAPABILITY_SERVICE_SUPPORT

      public static final AttachmentKey<CapabilityServiceSupport> CAPABILITY_SERVICE_SUPPORT
      Support for integrating with services and other runtime API provided by managed capabilities.
    • EXTERNAL_SERVICE_TARGET

      public static final AttachmentKey<org.jboss.msc.service.ServiceTarget> EXTERNAL_SERVICE_TARGET
      A service target that can be used to install services outside the scope of the deployment.

      These services will not be removed automatically on undeploy, so if this is used some other strategy must be used to handle undeployment.

    • MANIFEST_DEPENDENCIES

      public static final AttachmentKey<AttachmentList<ModuleDependency>> MANIFEST_DEPENDENCIES
    • MODULE_IDENTIFIER

      @Deprecated(forRemoval=true) public static final AttachmentKey<org.jboss.modules.ModuleIdentifier> MODULE_IDENTIFIER
      Deprecated, for removal: This API element is subject to removal in a future version.
      The module identifier.
    • MODULE_NAME

      public static final AttachmentKey<String> MODULE_NAME
      The canonical name of the module.
    • 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<ExternalModule> 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
    • COMPONENT_JNDI_DEPENDENCIES

      public static final AttachmentKey<Map<org.jboss.msc.service.ServiceName,Set<org.jboss.msc.service.ServiceName>>> COMPONENT_JNDI_DEPENDENCIES
      Component JNDI dependencies, only attached to the top level deployment
    • REFLECTION_INDEX

      public static final AttachmentKey<DeploymentReflectionIndex> REFLECTION_INDEX
      The reflection 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
    • 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