org.kie.integration.eap.maven

Class EAPBaseMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.kie.integration.eap.maven.EAPBaseMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

EAPModulesGraphMojo, EAPStaticModulesBuilderMojo

public abstract class EAPBaseMojo
extends org.apache.maven.plugin.AbstractMojo

Field Summary

Fields

Modifier and Type	Field and Description
protected EAPArtifactsHolder	artifactsHolder Collection to store all resources and its modules.
protected EAPConfigurationArtifact	baseModule The maven module that contains all base EAP/AS modules for a given version.
protected EAPLayer	baseModulesLayer The base module layer.
protected EAPModulesScanner	baseModulesScanner The scanner for base modules.
protected EAPContainer	container The target container.
protected EAPStaticLayerDistribution	distribution The modules distribution generated.
protected EAPLayerDistributionManager	distributionManager The scanner for base modules.
protected String	distributionName The name of the JBoss EAP layer distrubtion to geneate.
protected Boolean	failOnMissingDependency The flag that indicates if the build must fail when a dependency to a module resource is not satisfied.
protected Boolean	failOnUnresolvableResource The flag that indicates if the build must fail when a module resource cannot be resolved in current project dependency tree.
protected Boolean	failOnVersionMismatchedResource The flag that indicates if the build must fail when a module version for a resource is not resolvable in current project dependencies.
protected String	graphOutputFile The file to print the generated distribution graph.
protected Boolean	includeOptionalDependencies The flag that indicates if the optional dependencies must be scanned in the current project dependency tree.
protected EAPModulesDependencyBuilder	modulesDependencyBuilder The scanner for base modules.
protected EAPModulesGraphBuilder	modulesGraphBuilder The scanner for base modules.
protected org.apache.maven.project.MavenProject	project The Maven project.
protected List<org.eclipse.aether.repository.RemoteRepository>	remoteRepos The project's remote repositories to use for the resolution of plugins and their dependencies.
protected org.eclipse.aether.RepositorySystemSession	repoSession The current repository/network configuration of Maven.
protected org.eclipse.aether.RepositorySystem	repoSystem The entry point to Aether, i.e. the component doing all the work.
protected List<EAPConfigurationModuleDependency>	staticDependencies The static dependencies for this distribution modules.
protected EAPLayer	staticModulesLayer The static module layer.
protected EAPModulesScanner	staticModulesScanner The scanner for static modules.

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EAPBaseMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkConfiguration()
protected void	checkMissingDependencies()
protected void	checkResources()
protected EAPArtifactsHolder	collectArtifacts(org.eclipse.aether.graph.DependencyNode rootNode)
void	execute()
protected void	generateModulesDependencies(org.eclipse.aether.graph.DependencyNode rootNode) Given the root dependency node for the maven artifacts, runs the modules dependencies resolution.
protected EAPModulesGraph	generateModulesGraph()
protected Collection<EAPLayer>	getAllLayers()
protected Collection<org.eclipse.aether.artifact.Artifact>	getBaseLayerExclusions() Retuns the modules excluded from the maven base layer module definition..
protected org.eclipse.aether.artifact.Artifact	getBaseModulesArtifact() Returns the artifact instance that contains all base modules definitions for a EAP/AS specific version.
protected Collection<EAPStaticDistributionModuleDependency>	getStaticDistributionDependencies()
protected void	initServices()
protected EAPLayer	loadBaseLayer()
protected EAPLayer	loadStaticLayer()

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

project

protected org.apache.maven.project.MavenProject project

The Maven project.

repoSystem

protected org.eclipse.aether.RepositorySystem repoSystem

The entry point to Aether, i.e. the component doing all the work.

repoSession

protected org.eclipse.aether.RepositorySystemSession repoSession

The current repository/network configuration of Maven.

remoteRepos

protected List<org.eclipse.aether.repository.RemoteRepository> remoteRepos

The project's remote repositories to use for the resolution of plugins and their dependencies.

distributionName

protected String distributionName

The name of the JBoss EAP layer distrubtion to geneate.

baseModule

protected EAPConfigurationArtifact baseModule

The maven module that contains all base EAP/AS modules for a given version.

staticDependencies

protected List<EAPConfigurationModuleDependency> staticDependencies

The static dependencies for this distribution modules.

graphOutputFile

protected String graphOutputFile

The file to print the generated distribution graph.

failOnMissingDependency

protected Boolean failOnMissingDependency

The flag that indicates if the build must fail when a dependency to a module resource is not satisfied.

failOnUnresolvableResource

protected Boolean failOnUnresolvableResource

The flag that indicates if the build must fail when a module resource cannot be resolved in current project dependency tree.

failOnVersionMismatchedResource

protected Boolean failOnVersionMismatchedResource

The flag that indicates if the build must fail when a module version for a resource is not resolvable in current project dependencies.

includeOptionalDependencies

protected Boolean includeOptionalDependencies

The flag that indicates if the optional dependencies must be scanned in the current project dependency tree.

staticModulesScanner

protected EAPModulesScanner staticModulesScanner

The scanner for static modules.

baseModulesScanner

protected EAPModulesScanner baseModulesScanner

The scanner for base modules.

modulesDependencyBuilder

protected EAPModulesDependencyBuilder modulesDependencyBuilder

The scanner for base modules.

modulesGraphBuilder

protected EAPModulesGraphBuilder modulesGraphBuilder

The scanner for base modules.

distributionManager

protected EAPLayerDistributionManager distributionManager

The scanner for base modules.

artifactsHolder

protected transient EAPArtifactsHolder artifactsHolder

Collection to store all resources and its modules. Usefull to check if a resource has been duplicated.

staticModulesLayer

protected EAPLayer staticModulesLayer

The static module layer.

baseModulesLayer

protected EAPLayer baseModulesLayer

The base module layer.

container

protected EAPContainer container

The target container.

distribution

protected EAPStaticLayerDistribution distribution

The modules distribution generated.

Constructor Detail

EAPBaseMojo

protected EAPBaseMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

checkResources

protected void checkResources()
                       throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

checkMissingDependencies

protected void checkMissingDependencies()
                                 throws EAPModulesDependencyBuilderException

Throws:

EAPModulesDependencyBuilderException

checkConfiguration

protected void checkConfiguration()
                           throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

initServices

protected void initServices()

getBaseLayerExclusions

protected Collection<org.eclipse.aether.artifact.Artifact> getBaseLayerExclusions()

Retuns the modules excluded from the maven base layer module definition.. This artifact is defined in plugin configuration.

Returns:

The exclusions.

getBaseModulesArtifact

protected org.eclipse.aether.artifact.Artifact getBaseModulesArtifact()

Returns the artifact instance that contains all base modules definitions for a EAP/AS specific version. This artifact is defined in plugin configuration.

Returns:

The base modules artifact.

getStaticDistributionDependencies

protected Collection<EAPStaticDistributionModuleDependency> getStaticDistributionDependencies()
                                                                                       throws EAPModuleDefinitionException

Throws:

EAPModuleDefinitionException

collectArtifacts

protected EAPArtifactsHolder collectArtifacts(org.eclipse.aether.graph.DependencyNode rootNode)

loadStaticLayer

protected EAPLayer loadStaticLayer()
                            throws EAPModulesDefinitionException,
                                   EAPModuleDefinitionException

Throws:

EAPModulesDefinitionException

EAPModuleDefinitionException

loadBaseLayer

protected EAPLayer loadBaseLayer()
                          throws EAPModulesDefinitionException,
                                 EAPModuleDefinitionException

Throws:

EAPModulesDefinitionException

EAPModuleDefinitionException

generateModulesDependencies

protected void generateModulesDependencies(org.eclipse.aether.graph.DependencyNode rootNode)
                                    throws EAPModulesDependencyBuilderException

Given the root dependency node for the maven artifacts, runs the modules dependencies resolution.

Throws:

EAPModulesDependencyBuilderException

generateModulesGraph

protected EAPModulesGraph generateModulesGraph()

getAllLayers

protected Collection<EAPLayer> getAllLayers()