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

Class UnpackPluginMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.dependency.AbstractDependencyMojo

org.apache.maven.plugins.dependency.fromConfiguration.AbstractFromConfigurationMojo

org.apache.maven.plugins.dependency.fromConfiguration.UnpackMojo

de.iip_ecosphere.platform.tools.maven.dependencies.CleaningUnpackMojo

de.iip_ecosphere.platform.tools.maven.dependencies.UnpackPluginMojo

All Implemented Interfaces:

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

@Mojo(name="unpack-plugins",
      defaultPhase=TEST_COMPILE,
      requiresProject=false,
      threadSafe=true,
      requiresDependencyResolution=RUNTIME,
      requiresDependencyCollection=RUNTIME)
public class UnpackPluginMojo
extends CleaningUnpackMojo

Extended unpack Mojo for plugins.

Author:

Holger Eichelberger, SSE

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	UnpackPluginMojo.ClasspathFile	Stores classpath file names with additional information for moving in the file system.
private static class	UnpackPluginMojo.JarLocation	Represent a Jar location.
static class	UnpackPluginMojo.PluginItem	Represents a plugin, an extended artifact.
private class	UnpackPluginMojo.RelocatingFileMapper	Used for relocating classpath files, i.e., to rename them with their plugin short (artifactId) name.
private static class	UnpackPluginMojo.Tokenizer	Represents an OS-customized tokenizer.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	always
private List<UnpackPluginMojo.ClasspathFile>	classpathFiles
private boolean	createIndex
private boolean	forceResolve
private static final String	NAME_CLASSPATH_FILE
private Map<String,List<String>>	pluginAppends
private List<UnpackPluginMojo.PluginItem>	plugins
private boolean	relocate
private File	relocateTarget
private List<org.apache.maven.artifact.repository.ArtifactRepository>	remoteArtifactRepositories
private List<org.eclipse.aether.repository.RemoteRepository>	remoteRepositories
private org.eclipse.aether.RepositorySystemSession	repoSession
private org.eclipse.aether.RepositorySystem	repoSystem
private boolean	resolveAndCopy
private String	resolvedFile
private Resolver	resolver
private org.apache.maven.execution.MavenSession	session
private File	targetDirectory
private String	version
private boolean	writeResolved

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

outputAbsoluteArtifactFilename, reactorProjects

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

ROLE

Constructor Summary

Constructors

Constructor	Description
UnpackPluginMojo()

Method Summary

Modifier and Type	Method	Description
void	doExecute()
private static String	extractSuffix(String prefix, String line, String dflt)	Extracts the suffix after removing the prefix.
private int	findArtifactId(String name)	Returns the position of the "." after the groupId in name.
private String	fixPrefix(String prefix, UnpackPluginMojo.Tokenizer tokenizer)	Fixes the prefix by appending a path separator if needed.
private String	getActualVersion(UnpackPluginMojo.PluginItem pl)	Returns the actual (overridden) version of the given plugin item.
private File	getCpFile(String name)	Returns the path to a (more qualified) classpath file based on the output directory for a plugin/classpath file name.
private File	getOutputDir(String name)	Returns the output directory for a plugin/classpath file name.
private void	handleAppends()	Handles the appends.
private void	handleAppends(String name, Set<String> knownTokens, Consumer<String> handler)	Handles appends, if specified, by passing elements that are not yet in knownTokens to handler.
private void	handleSetupDescriptors()	Handles explicit setup descriptors by rewriting the classpath files.
private boolean	isModeResolve(String mode)	Returns whether we are in resolve mode, i.e., either mode indicates "resolve" or forceResolve.
private boolean	isSameFile(File f1, File f2)	Returns whether f1 and f2 seem to be the same file path.
private void	mergeFiles(File src, File tgt)	Merges files from src into tgt by only copying those that do not already exist.
org.apache.maven.project.ProjectBuildingRequest	newResolveArtifactProjectBuildingRequest()
private org.eclipse.aether.artifact.DefaultArtifact	parsePath(String path)	Parses a classpath path back into a maven artifact.
private List<UnpackPluginMojo.JarLocation>	processCpLineNoRelocation(String name, String mode, String line, PrintStream out, UnpackPluginMojo.Tokenizer tokenizer, String prefix)	Processes a classpath line without plugin relocation.
private List<UnpackPluginMojo.JarLocation>	processCpLineRelocation(String name, String mode, PrintStream out, UnpackPluginMojo.Tokenizer tokenizer, String prefix, File jarFolder)	Processes a classpath line while plugin relocation.
private Map<String,Resolver.UnpackMode>	relocate()	Relocates the unpacked files.
private String	resolve(String path, File jarFolder)	Tries to resolve the path.
private String	rewriteToken(String token, String mode, String prefix, File jarFolder, UnpackPluginMojo.Tokenizer tokenizer, List<UnpackPluginMojo.JarLocation> locations)	Rewrites a classpath token.
private void	storeResolved(Map<String,Resolver.UnpackMode> modes)	Stores the resolved plugin dependencies if enabled.
private String	stripPrefix(String prefix, String cpToken)	Strips a prefix from a classpath token.
private org.apache.maven.plugins.dependency.fromConfiguration.ArtifactItem	toArtifactItem(UnpackPluginMojo.PluginItem pl)	Turns a UnpackPluginMojo.PluginItem to a pre-configured ArtifactItem passed on for resolution/download.
private void	writeIndex(List<UnpackPluginMojo.JarLocation> locs, File cpFile)	Writes the (optional) classloader index file.

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

getCleanupLog, getInitiallyAllowed, matches, setCleanup, setForce, setForceCleanup, setLogCleanup, setSkipIfExists, skipIfExists

Methods inherited from class org.apache.maven.plugins.dependency.fromConfiguration.UnpackMojo

getExcludes, getFileMappers, getIncludes, getMarkersDirectory, getProcessedArtifactItems, setExcludes, setFileMappers, setIncludes, setMarkersDirectory

Methods inherited from class org.apache.maven.plugins.dependency.fromConfiguration.AbstractFromConfigurationMojo

getArtifact, getArtifactItems, getOutputDirectory, getProcessedArtifactItems, isOverWriteIfNewer, isOverWriteReleases, isOverWriteSnapshots, setArtifact, setArtifactItems, setLocalRepositoryDirectory, setOutputDirectory, setOverWriteIfNewer, setOverWriteReleases, setOverWriteSnapshots, verifyRequirements

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

Field Details

NAME_CLASSPATH_FILE

private static final String NAME_CLASSPATH_FILE

See Also:

• Constant Field Values

plugins

@Parameter(property="unpack.plugins",
           required=false)
private List<UnpackPluginMojo.PluginItem> plugins

version

@Parameter(property="unpack.version",
           required=false,
           defaultValue="")
private String version

relocate

@Parameter(property="unpack.relocate",
           required=false,
           defaultValue="false")
private boolean relocate

always

@Parameter(property="unpack.always",
           required=false,
           defaultValue="false")
private boolean always

relocateTarget

@Parameter(property="unpack.relocateTarget",
           required=false,
           defaultValue="jars")
private File relocateTarget

forceResolve

@Parameter(property="unpack.forceResolve",
           required=false,
           defaultValue="false")
private boolean forceResolve

resolveAndCopy

@Parameter(property="unpack.resolveAndCopy",
           required=false,
           defaultValue="false")
private boolean resolveAndCopy

targetDirectory

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

writeResolved

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

resolvedFile

@Parameter(property="mdep.resolvedFile",
           defaultValue="*")
private String resolvedFile

createIndex

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

classpathFiles

private List<UnpackPluginMojo.ClasspathFile> classpathFiles

remoteArtifactRepositories

@Parameter(defaultValue="${project.remoteArtifactRepositories}",
           readonly=true,
           required=true)
private List<org.apache.maven.artifact.repository.ArtifactRepository> remoteArtifactRepositories

remoteRepositories

@Parameter(defaultValue="${project.remoteProjectRepositories}",
           readonly=true)
private List<org.eclipse.aether.repository.RemoteRepository> remoteRepositories

repoSession

@Parameter(defaultValue="${repositorySystemSession}",
           readonly=true)
private org.eclipse.aether.RepositorySystemSession repoSession

session

@Parameter(defaultValue="${session}",
           readonly=true,
           required=true)
private org.apache.maven.execution.MavenSession session

repoSystem

@Component
private org.eclipse.aether.RepositorySystem repoSystem

pluginAppends

private Map<String,List<String>> pluginAppends

resolver

private Resolver resolver

Constructor Details

UnpackPluginMojo

public UnpackPluginMojo()

Method Details

doExecute

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

Overrides:

doExecute in class CleaningUnpackMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getActualVersion

private String getActualVersion(UnpackPluginMojo.PluginItem pl)

Returns the actual (overridden) version of the given plugin item.

Parameters:

pl - the plugin item

Returns:

the version

toArtifactItem

private org.apache.maven.plugins.dependency.fromConfiguration.ArtifactItem toArtifactItem(UnpackPluginMojo.PluginItem pl)

Turns a UnpackPluginMojo.PluginItem to a pre-configured ArtifactItem passed on for resolution/download.

Parameters:

pl - the plugin item to convert

Returns:

the converted artifact item

storeResolved

private void storeResolved(Map<String,Resolver.UnpackMode> modes)
                    throws org.apache.maven.plugin.MojoExecutionException

Stores the resolved plugin dependencies if enabled.

Parameters:

modes - the unpack modes as classpathfile/plugin name-unpack mode map

Throws:

org.apache.maven.plugin.MojoExecutionException - if obtaining the dependencies fails

getOutputDir

private File getOutputDir(String name)

Returns the output directory for a plugin/classpath file name.

Parameters:

name - the name, may be null or empty for none/base dir/independent of name

Returns:

the output directory

getCpFile

private File getCpFile(String name)

Returns the path to a (more qualified) classpath file based on the output directory for a plugin/classpath file name.

Parameters:

name - the name

Returns:

the output directory

handleAppends

private void handleAppends()

Handles the appends.

handleSetupDescriptors

private void handleSetupDescriptors()

Handles explicit setup descriptors by rewriting the classpath files.

mergeFiles

private void mergeFiles(File src,
 File tgt)
                 throws IOException

Merges files from src into tgt by only copying those that do not already exist.

Parameters:

src - the source folder

tgt - the target folder

Throws:

IOException - if copying fails

extractSuffix

private static String extractSuffix(String prefix,
 String line,
 String dflt)

Extracts the suffix after removing the prefix.

Parameters:

prefix - the prefix to look for, may be null

line - the line to extract the suffix from

dflt - the default value if there is no prefix, usually line

Returns:

line or the line without the prefix

fixPrefix

private String fixPrefix(String prefix,
 UnpackPluginMojo.Tokenizer tokenizer)

Fixes the prefix by appending a path separator if needed.

Parameters:

prefix - the prefix

tokenizer - the tokenizer determining the path separator

Returns:

the fixed prefix

stripPrefix

private String stripPrefix(String prefix,
 String cpToken)

Strips a prefix from a classpath token.

Parameters:

prefix - the prefix

cpToken - the classpath token

Returns:

the stripped cpToken if there is something to strip

relocate

private Map<String,Resolver.UnpackMode> relocate()
                                          throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException

Relocates the unpacked files.

Returns:

the unpack modes as classpathfile/plugin name-unpack mode map

Throws:

org.apache.maven.plugin.MojoExecutionException - if the execution fails

org.apache.maven.plugin.MojoFailureException - if a remarkable processing failure occurred

writeIndex

private void writeIndex(List<UnpackPluginMojo.JarLocation> locs,
 File cpFile)

Writes the (optional) classloader index file.

Parameters:

locs - the Jar locations to be turned into the index file

cpFile - the associated classpath file to create the index for

isSameFile

private boolean isSameFile(File f1,
 File f2)

Returns whether f1 and f2 seem to be the same file path.

Parameters:

f1 - the first file

f2 - the second file

Returns:

true for the same, false else

processCpLineRelocation

private List<UnpackPluginMojo.JarLocation> processCpLineRelocation(String name,
 String mode,
 PrintStream out,
 UnpackPluginMojo.Tokenizer tokenizer,
 String prefix,
 File jarFolder)

Processes a classpath line while plugin relocation.

Parameters:

name - the name of the plugin

mode - the unpack mode, may be null

out - the output stream for the rewritten classpath file

tokenizer - the tokenizer

prefix - the classpath token prefix

jarFolder - the folder where to copy the jars to

Returns:

list of paths of actual classpath entries

processCpLineNoRelocation

private List<UnpackPluginMojo.JarLocation> processCpLineNoRelocation(String name,
 String mode,
 String line,
 PrintStream out,
 UnpackPluginMojo.Tokenizer tokenizer,
 String prefix)

Processes a classpath line without plugin relocation.

Parameters:

name - the name of the plugin

mode - the unpack mode, may be null

line - the classpath line

out - the output stream for the rewritten classpath file

tokenizer - the tokenizer

prefix - the classpath token prefix (for forceResolve)

Returns:

list of paths of actual classpath entries

rewriteToken

private String rewriteToken(String token,
 String mode,
 String prefix,
 File jarFolder,
 UnpackPluginMojo.Tokenizer tokenizer,
 List<UnpackPluginMojo.JarLocation> locations)

Rewrites a classpath token.

Parameters:

token - the token

mode - the unpack mode, may be null

prefix - the classpath token prefix (for forceResolve)

jarFolder - the folder where to copy the jars to (considerd only for resolveAndCopy, may be null considered as if resolveAndCopy is false)

tokenizer - the tokenizer

locations - Jar locations (modified per token)

Returns:

token or the rewritten token

isModeResolve

private boolean isModeResolve(String mode)

Returns whether we are in resolve mode, i.e., either mode indicates "resolve" or forceResolve.

Parameters:

mode - the unpack mode, may be null

Returns:

true for resolve, false else

handleAppends

private void handleAppends(String name,
 Set<String> knownTokens,
 Consumer<String> handler)

Handles appends, if specified, by passing elements that are not yet in knownTokens to handler.

Parameters:

name - the name of the plugin

knownTokens - the tokens known so far (classpath entries), modified as a side effect

handler - the handler to be called

parsePath

private org.eclipse.aether.artifact.DefaultArtifact parsePath(String path)

Parses a classpath path back into a maven artifact.

Parameters:

path - the path

Returns:

the artifact

findArtifactId

private int findArtifactId(String name)

Returns the position of the "." after the groupId in name.

Parameters:

name - the name to analyze

Returns:

the position

resolve

private String resolve(String path,
 File jarFolder)

Tries to resolve the path.

Parameters:

path - the given classpath path

jarFolder - the folder where to copy the jars to (considerd only for resolveAndCopy, may be null considered as if resolveAndCopy is false)

Returns:

path or the resolved path (in the local maven repo)

newResolveArtifactProjectBuildingRequest

public org.apache.maven.project.ProjectBuildingRequest newResolveArtifactProjectBuildingRequest()

Overrides:

newResolveArtifactProjectBuildingRequest in class org.apache.maven.plugins.dependency.AbstractDependencyMojo