Package org.jboss.as.server.deployment.module

Class ModuleIdentifierProcessor

java.lang.Object

org.jboss.as.server.deployment.module.ModuleIdentifierProcessor

All Implemented Interfaces:

DeploymentUnitProcessor

public class ModuleIdentifierProcessor
extends Object
implements DeploymentUnitProcessor

Deployment processor that generates module identifiers for the deployment and attaches it.

Author:

Stuart Douglas

Constructor Summary

Constructors

Constructor	Description
ModuleIdentifierProcessor()

Method Summary

Modifier and Type	Method	Description
static org.jboss.modules.ModuleIdentifier	createModuleIdentifier(String deploymentUnitName, ResourceRoot deploymentRoot, DeploymentUnit topLevelDeployment, org.jboss.vfs.VirtualFile toplevelRoot, boolean topLevel)	Deprecated, for removal: This API element is subject to removal in a future version. Use createModuleIdentifierAsString(String, ResourceRoot, DeploymentUnit, VirtualFile, boolean) instead
static String	createModuleIdentifierAsString(String deploymentUnitName, ResourceRoot deploymentRoot, DeploymentUnit topLevelDeployment, org.jboss.vfs.VirtualFile toplevelRoot, boolean topLevel)	Create a module identifier for the deployment.
void	deploy(DeploymentPhaseContext phaseContext)	Perform a single step in processing the deployment phase.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.as.server.deployment.DeploymentUnitProcessor

undeploy

Constructor Detail

ModuleIdentifierProcessor

public ModuleIdentifierProcessor()

Method Detail

deploy

public void deploy(DeploymentPhaseContext phaseContext)
            throws DeploymentUnitProcessingException

Description copied from interface: DeploymentUnitProcessor

Perform a single step in processing the deployment phase. The resulting state after executing this method should be that either the method completes normally and all changes are made, or an exception is thrown and all changes made in this method are reverted such that the original pre-invocation state is restored.

Data stored on the phase context only exists until the end of the phase. The deployment unit context which is persistent is available via context.getDeploymentUnitContext().

Specified by:

deploy in interface DeploymentUnitProcessor

Parameters:

phaseContext - the deployment unit context

Throws:

DeploymentUnitProcessingException - if an error occurs during processing

createModuleIdentifier

@Deprecated(forRemoval=true,
            since="28.0.0")
public static org.jboss.modules.ModuleIdentifier createModuleIdentifier(String deploymentUnitName,
                                                                        ResourceRoot deploymentRoot,
                                                                        DeploymentUnit topLevelDeployment,
                                                                        org.jboss.vfs.VirtualFile toplevelRoot,
                                                                        boolean topLevel)

Deprecated, for removal: This API element is subject to removal in a future version.

Use createModuleIdentifierAsString(String, ResourceRoot, DeploymentUnit, VirtualFile, boolean) instead

Create a module identifier for the deployment.

Parameters:

deploymentUnitName - The name of the deployment unit

deploymentRoot - The deployment root

topLevelDeployment - The top level deployment

toplevelRoot - The top level root

topLevel - true if the deployment is a top level deployment, false otherwise

Returns:

the module identifier that represents the deployment

createModuleIdentifierAsString

public static String createModuleIdentifierAsString(String deploymentUnitName,
                                                    ResourceRoot deploymentRoot,
                                                    DeploymentUnit topLevelDeployment,
                                                    org.jboss.vfs.VirtualFile toplevelRoot,
                                                    boolean topLevel)

Create a module identifier for the deployment.

Parameters:

deploymentUnitName - The name of the deployment unit

deploymentRoot - The deployment root

topLevelDeployment - The top level deployment

toplevelRoot - The top level root

topLevel - true if the deployment is a top level deployment, false otherwise

Returns:

the module identifier that represents the deployment