Package de.iip_ecosphere.platform.tools.maven.dependencies

Class BuildPluginClasspathMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.dependency.AbstractDependencyMojo

org.apache.maven.plugins.dependency.fromDependencies.AbstractDependencyFilterMojo

org.apache.maven.plugins.dependency.fromDependencies.BuildClasspathMojo

de.iip_ecosphere.platform.tools.maven.dependencies.BuildClasspathMojo

de.iip_ecosphere.platform.tools.maven.dependencies.BuildPluginClasspathMojo

All Implemented Interfaces:

Comparator<org.apache.maven.artifact.Artifact>, org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="build-plugin-classpath",
      requiresDependencyResolution=TEST,
      defaultPhase=PACKAGE,
      threadSafe=true)
public class BuildPluginClasspathMojo
extends BuildClasspathMojo

Specialized mojo for building plugin classpath files.

Author:

Holger Eichelberger, SSE

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	addTestArtifact
private boolean	asTest
static final String	KEY_PLUGIN_IDS
static final String	KEY_PREFIX
static final String	KEY_SEQUENCE_NR
static final String	KEY_SETUP_DESCRIPTOR
static final String	KEY_UNPACK_MODE
private List<String>	pluginIds
private final String	prefix
private String	setupDescriptor
private File	targetDirectory
private String	unpackMode
private boolean	validateJsl

Fields inherited from class org.apache.maven.plugins.dependency.fromDependencies.AbstractDependencyFilterMojo

classifier, excludeArtifactIds, excludeClassifiers, excludeGroupIds, excludeScope, excludeTransitive, excludeTypes, includeArtifactIds, includeClassifiers, includeGroupIds, includeScope, includeTypes, markersDirectory, overWriteIfNewer, overWriteReleases, overWriteSnapshots, prependGroupId, type

Fields inherited from class org.apache.maven.plugins.dependency.AbstractDependencyMojo

outputAbsoluteArtifactFilename, reactorProjects, session

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

ROLE

Constructor Summary

Constructors

Constructor	Description
BuildPluginClasspathMojo()

Method Summary

Modifier and Type	Method	Description
void	adjustTo(Function<String,String> func)	Adjusts the setup.
private void	composeBefores(Function<String,String> func)	Composes and sets the befores.
private String	composeMyArtifact(String classifier, String extension)	Composes the path for one of the own artifacts.
protected void	doExecute()
private String	getRelTargetDirectory()	Returns the relative target directory.
private void	validateJsl()	Validates whether JSL descriptor files have their counterparts in classes.
private void	validateJsl(File descParent, File... classDir)	Validates whether JSL descriptor files in invalid reference descParent have their counterparts in classes compiled to invalid reference classDir .
private void	validateJsl(File desc, String descClass, List<File> classDirList)	Validates whether a JSL descriptor file in invalid reference descParent has counterparts in classes compiled to invalid reference classDirList .

Methods inherited from class de.iip_ecosphere.platform.tools.maven.dependencies.BuildClasspathMojo

getBefores, newResolveArtifactProjectBuildingRequest, readEntries, readEntriesToList, readEntriesToSet, setBefores, setFileSeparator, setLocalRepoProperty, setOutputFile, setPathSeparator, setPrefix, setPrepends

Methods inherited from class org.apache.maven.plugins.dependency.fromDependencies.BuildClasspathMojo

appendArtifactPath, attachFile, compare, getMarkedArtifactFilter, isStripVersion, readClasspathFile, setOutputProperty, setRegenerateFile, setStripVersion

Methods inherited from class org.apache.maven.plugins.dependency.fromDependencies.AbstractDependencyFilterMojo

filterMarkedDependencies, getArtifactResolver, getClassifierTranslatedDependencies, getDependencyResolver, getDependencySets, getDependencySets, getMarkersDirectory, getRepositoryManager, getResolvedDependencies, isPrependGroupId, resolve, setMarkersDirectory, setPrependGroupId

Methods inherited from class org.apache.maven.plugins.dependency.AbstractDependencyMojo

copyFile, execute, getArchiverManager, getProject, isSilent, isSkip, isUseJvmChmod, newResolvePluginProjectBuildingRequest, setArchiverManager, setSilent, setSkip, setUseJvmChmod, unpack, unpack, unpack

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

Methods inherited from interface java.util.Comparator

equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Field Details

KEY_PREFIX

public static final String KEY_PREFIX

See Also:

• Constant Field Values

KEY_UNPACK_MODE

public static final String KEY_UNPACK_MODE

See Also:

• Constant Field Values

KEY_SETUP_DESCRIPTOR

public static final String KEY_SETUP_DESCRIPTOR

See Also:

• Constant Field Values

KEY_PLUGIN_IDS

public static final String KEY_PLUGIN_IDS

See Also:

• Constant Field Values

KEY_SEQUENCE_NR

public static final String KEY_SEQUENCE_NR

See Also:

• Constant Field Values

prefix

private final String prefix

See Also:

• Constant Field Values

addTestArtifact

@Parameter(property="mdep.addTestArtifact",
           defaultValue="false")
private boolean addTestArtifact

unpackMode

@Parameter(property="mdep.unpackMode",
           defaultValue="jars")
private String unpackMode

setupDescriptor

@Parameter(property="mdep.setupDescriptor",
           defaultValue="FolderClasspath")
private String setupDescriptor

pluginIds

@Parameter(property="mdep.pluginIds",
           defaultValue="")
private List<String> pluginIds

asTest

@Parameter(required=false)
private boolean asTest

targetDirectory

@Parameter(defaultValue="${project.build.directory}",
           readonly=true)
private File targetDirectory

validateJsl

@Parameter(property="mdep.validateJsl",
           defaultValue="true")
private boolean validateJsl

Constructor Details

BuildPluginClasspathMojo

public BuildPluginClasspathMojo()

Method Details

getRelTargetDirectory

private String getRelTargetDirectory()

Returns the relative target directory.

Returns:

the relative target directory

composeMyArtifact

private String composeMyArtifact(String classifier,
 String extension)

Composes the path for one of the own artifacts.

Parameters:

classifier - optional classifier, may be empty or null

extension - optional file extension, defaults to "jar" if empty or null

Returns:

the path to the composed artifact

doExecute

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

Overrides:

doExecute in class BuildClasspathMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

validateJsl

private void validateJsl()

Validates whether JSL descriptor files have their counterparts in classes. Must be executed after class and test class compilation.

validateJsl

private void validateJsl(File descParent,
 File... classDir)

Validates whether JSL descriptor files in

invalid reference

descParent

have their counterparts in classes compiled to

invalid reference

classDir

.

Parameters:

descParent - , usually a resource folder where META-INF/services is located within

classDir - the parent folders to search classes within

validateJsl

private void validateJsl(File desc,
 String descClass,
 List<File> classDirList)

Validates whether a JSL descriptor file in

invalid reference

descParent

has counterparts in classes compiled to

invalid reference

classDirList

.

Parameters:

desc - the descriptor file

descClass - the class name within desc to validate

classDirList - the parent folders to search classes within

adjustTo

public void adjustTo(Function<String,String> func)

Description copied from class: BuildClasspathMojo

Adjusts the setup.

Overrides:

adjustTo in class BuildClasspathMojo

Parameters:

func - the adjustment function

composeBefores

private void composeBefores(Function<String,String> func)

Composes and sets the befores.

Parameters:

func - a path adjustment function, may be null