Package org.apache.maven.plugins.dependency.fromConfiguration

Class AbstractFromConfigurationMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.dependency.AbstractDependencyMojo

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

All Implemented Interfaces:

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

Direct Known Subclasses:

CopyMojo, UnpackMojo

public abstract class AbstractFromConfigurationMojo
extends AbstractDependencyMojo

Abstract parent class used by mojos that get Artifact information from the plugin configuration as an ArrayList of ArtifactItems.

Author:

Brian Fox

See Also:

• ArtifactItem

Field Summary

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

reactorProjects, session

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

ROLE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractFromConfigurationMojo(org.apache.maven.execution.MavenSession session, org.sonatype.plexus.build.incremental.BuildContext buildContext, org.apache.maven.project.MavenProject project, org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager, org.eclipse.aether.RepositorySystem repositorySystem)

Method Summary

Modifier and Type	Method	Description
protected org.apache.maven.artifact.Artifact	getArtifact(ArtifactItem artifactItem)	Resolves the Artifact from the remote repository if necessary.
List<ArtifactItem>	getArtifactItems()
File	getOutputDirectory()
protected List<ArtifactItem>	getProcessedArtifactItems(ProcessArtifactItemsRequest processArtifactItemsRequest)	Preprocesses the list of ArtifactItems.
boolean	isOverWriteIfNewer()
boolean	isOverWriteReleases()
boolean	isOverWriteSnapshots()
void	setArtifact(String artifact)
void	setArtifactItems(List<ArtifactItem> theArtifactItems)
void	setLocalRepositoryDirectory(File localRepositoryDirectory)
void	setOutputDirectory(File theOutputDirectory)
void	setOverWriteIfNewer(boolean theOverWriteIfNewer)
void	setOverWriteReleases(boolean theOverWriteReleases)
void	setOverWriteSnapshots(boolean theOverWriteSnapshots)
protected void	verifyRequirements()	ArtifactItems is filled by either field injection or by setArtifact().

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

doExecute, execute, getProject, isSilent, isSkip, setSilent, setSkip

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

Constructor Details

AbstractFromConfigurationMojo

protected AbstractFromConfigurationMojo(org.apache.maven.execution.MavenSession session,
 org.sonatype.plexus.build.incremental.BuildContext buildContext,
 org.apache.maven.project.MavenProject project,
 org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager,
 org.eclipse.aether.RepositorySystem repositorySystem)

Method Details

verifyRequirements

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

ArtifactItems is filled by either field injection or by setArtifact().

Throws:

org.apache.maven.plugin.MojoFailureException - in case of an error

getProcessedArtifactItems

protected List<ArtifactItem> getProcessedArtifactItems(ProcessArtifactItemsRequest processArtifactItemsRequest)
                                                throws org.apache.maven.plugin.MojoExecutionException

Preprocesses the list of ArtifactItems. This method defaults the outputDirectory if not set and creates the output Directory if it doesn't exist.

Parameters:

processArtifactItemsRequest - preprocessing instructions

Returns:

an ArrayList of preprocessed ArtifactItems

Throws:

org.apache.maven.plugin.MojoExecutionException - with a message if an error occurs

See Also:

• ArtifactItem

getArtifact

protected org.apache.maven.artifact.Artifact getArtifact(ArtifactItem artifactItem)
                                                  throws org.apache.maven.plugin.MojoExecutionException

Resolves the Artifact from the remote repository if necessary. If no version is specified, it will be retrieved from the dependency list or from the DependencyManagement section of the pom.

Parameters:

artifactItem - containing information about artifact from plugin configuration

Returns:

artifact object representing the specified file

Throws:

org.apache.maven.plugin.MojoExecutionException - if the version can't be found in DependencyManagement

getArtifactItems

public List<ArtifactItem> getArtifactItems()

Returns:

returns the artifactItems

setArtifactItems

public void setArtifactItems(List<ArtifactItem> theArtifactItems)

Parameters:

theArtifactItems - the artifactItems to set

getOutputDirectory

public File getOutputDirectory()

Returns:

returns the outputDirectory

setOutputDirectory

public void setOutputDirectory(File theOutputDirectory)

Parameters:

theOutputDirectory - the outputDirectory to set

isOverWriteIfNewer

public boolean isOverWriteIfNewer()

Returns:

returns the overWriteIfNewer

setOverWriteIfNewer

public void setOverWriteIfNewer(boolean theOverWriteIfNewer)

Parameters:

theOverWriteIfNewer - the overWriteIfNewer to set

isOverWriteReleases

public boolean isOverWriteReleases()

Returns:

returns the overWriteReleases

setOverWriteReleases

public void setOverWriteReleases(boolean theOverWriteReleases)

Parameters:

theOverWriteReleases - the overWriteReleases to set

isOverWriteSnapshots

public boolean isOverWriteSnapshots()

Returns:

returns the overWriteSnapshots

setOverWriteSnapshots

public void setOverWriteSnapshots(boolean theOverWriteSnapshots)

Parameters:

theOverWriteSnapshots - the overWriteSnapshots to set

setLocalRepositoryDirectory

public void setLocalRepositoryDirectory(File localRepositoryDirectory)

Parameters:

localRepositoryDirectory - localRepositoryDirectory

setArtifact

public void setArtifact(String artifact)
                 throws org.apache.maven.plugin.MojoFailureException

Parameters:

artifact - the artifact

Throws:

org.apache.maven.plugin.MojoFailureException - in case of an error