com.universalmediaserver.external

Class AbstractExternalDependencyMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugin.install.AbstractInstallMojo

com.universalmediaserver.external.AbstractExternalDependencyMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

CleanExternalDependencyMojo, DeployExternalDependencyMojo, InstallExternalDependencyMojo, LocalInstallExternalDependencyMojo, ResolveExternalDependencyMojo

public abstract class AbstractExternalDependencyMojo
extends org.apache.maven.plugin.install.AbstractInstallMojo

Base class for all goals in this plugin.

Mojo is thread safe:

true

Field Summary

Fields

Modifier and Type	Field and Description
protected org.codehaus.plexus.archiver.manager.ArchiverManager	archiverManager Maven ArchieverManager.
protected ArrayList<ArtifactItem>	artifactItems Collection of ArtifactItems to work on.
protected org.apache.maven.artifact.resolver.ArtifactResolver	artifactResolver Used to look up Artifacts in the remote repository.
protected boolean	centralChecksumVerification If this property is set to true, the downloaded file's checksum will be verified with a query against Maven Central Repository to make sure the artifact isn't already there.
protected boolean	createChecksum Flag that indicates whether to create checksums (MD5, SHA-1) or not.
protected boolean	disableSSLValidation Flag that indicates whether to disable Java's SSL certificate and host validation.
protected boolean	force Forces a download, maven install, maven deploy
protected String	globalSettings Path to global settings.xml
protected org.apache.maven.artifact.installer.ArtifactInstaller	installer Used to install Artifact in the local repository.
protected org.apache.maven.artifact.repository.ArtifactRepository	localRepository Maven local repository
protected String	NEWLINE Newline constant
protected org.apache.maven.project.MavenProject	project Maven project
protected List<org.apache.maven.artifact.repository.ArtifactRepository>	remoteRepositories List of Remote Repositories used by the resolver
protected org.apache.maven.repository.RepositorySystem	repositorySystem Used to look up Artifacts in the remote repository.
protected String	stagingDirectory Staging directory for external dependencies
protected String	userSettings Path to user settings.xml
protected org.apache.maven.artifact.manager.WagonManager	wagonManager Maven WagonManager

Fields inherited from class org.apache.maven.plugin.install.AbstractInstallMojo

artifactFactory, digester, updateReleaseInfo

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractExternalDependencyMojo()

Method Summary

Modifier and Type	Method and Description
protected org.apache.maven.artifact.Artifact	createArtifact(ArtifactItem item) Create Maven Artifact object from ArtifactItem configuration descriptor.
protected void	downloadArtifact(ArtifactItem artifactItem, org.apache.maven.artifact.Artifact artifact, File artifactFile, Map<URL,File> cachedDownloads) Download an artifact.
void	execute()
protected org.apache.maven.model.Model	generateModel(ArtifactItem artifact) Generates a minimal model from the user-supplied artifact information.
protected File	generatePomFile(ArtifactItem artifact) Generates a (temporary) POM file from the plugin configuration.
protected String	getExtension(URL downloadURL) Gets the file extension.
protected File	getFullyQualifiedArtifactFilePath(ArtifactItem artifactItem) Resolves the file path and returns a file object instance for an artifact item.
protected org.apache.maven.wagon.proxy.ProxyInfo	getProxyInfo() Looks up ProxyInfo from Maven settings.
org.apache.maven.settings.building.SettingsBuilder	getSettingsBuilder() Generates a default settings builder.
org.apache.maven.settings.building.SettingsBuildingRequest	getSettingsBuildingRequest() Generates a settings builder request from parameters.
protected void	installArtifact(ArtifactItem artifactItem, org.apache.maven.artifact.Artifact artifact, File stagedArtifactFile) Install an artifact into the local repository
protected boolean	resolveArtifactItem(org.apache.maven.artifact.Artifact artifact) resolve the artifact in local or remote repository
protected void	verifyArtifact(ArtifactItem artifactItem, File stagedArtifactFile) Verify artifact.
protected void	verifyArtifactItemChecksum(ArtifactItem artifactItem, File targetFile) Validate artifact configured checksum against specified file.
protected void	verifyArtifactItemChecksumByCentralLookup(ArtifactItem artifactItem, File targetFile) Validate downloaded file artifact checksum does not match another artifact's checksum that already exists in the central Maven repository.
protected void	verifyArtifactItemExtractFileChecksum(ArtifactItem artifactItem, File targetFile) Validate artifact configured extracted file checksum against specified file.
protected boolean	verifyChecksum(File targetFile, org.codehaus.plexus.digest.Digester digester, String checksum) Verifies a checksum for the specified file.

Methods inherited from class org.apache.maven.plugin.install.AbstractInstallMojo

addMetaDataFilesForArtifact, getLocalRepoFile, getLocalRepoFile, installChecksums, installChecksums

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

repositorySystem

protected org.apache.maven.repository.RepositorySystem repositorySystem

Used to look up Artifacts in the remote repository.

Is a Plexus component defined by:

artifactItems

protected ArrayList<ArtifactItem> artifactItems

Collection of ArtifactItems to work on. (ArtifactItem contains groupId, artifactId, version, type, classifier, location, destFile, markerFile and overwrite.) See "Usage" and "Javadoc" for details.

Is defined by:

Is required.

artifactResolver

protected org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver

Used to look up Artifacts in the remote repository.

Is a Plexus component defined by:

installer

protected org.apache.maven.artifact.installer.ArtifactInstaller installer

Used to install Artifact in the local repository.

Is a Plexus component defined by:

remoteRepositories

protected List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepositories

List of Remote Repositories used by the resolver

Is defined by:

default-value:

${project.remoteArtifactRepositories}

Is readonly.

wagonManager

protected org.apache.maven.artifact.manager.WagonManager wagonManager

Maven WagonManager

Is a Plexus component defined by:

role:

org.apache.maven.artifact.manager.WagonManager

Is readonly.

Is required.

archiverManager

protected org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager

Maven ArchieverManager.

Is a Plexus component defined by:

Is readonly.

project

protected org.apache.maven.project.MavenProject project

Maven project

Is defined by:

default-value:

${project}

Is readonly.

Is required.

userSettings

protected String userSettings

Path to user settings.xml

Is defined by:

default-value:

${user.home}/.m2/settings.xml

Is required.

globalSettings

protected String globalSettings

Path to global settings.xml

Is defined by:

default-value:

${env.M2_HOME}/conf/settings.xml

Is required.

localRepository

protected org.apache.maven.artifact.repository.ArtifactRepository localRepository

Maven local repository

Is defined by:

default-value:

${localRepository}

Is readonly.

Is required.

stagingDirectory

protected String stagingDirectory

Staging directory for external dependencies

Is defined by:

default-value:

${project.build.directory}/external-dependencies

force

protected boolean force

Forces a download, maven install, maven deploy

Is defined by:

default-value:

false

centralChecksumVerification

protected boolean centralChecksumVerification

If this property is set to true, the downloaded file's checksum will be verified with a query against Maven Central Repository to make sure the artifact isn't already there.

Is defined by:

default-value:

false

createChecksum

protected boolean createChecksum

Flag that indicates whether to create checksums (MD5, SHA-1) or not.

Is defined by:

property:

createChecksum

default-value:

true

Is required.

disableSSLValidation

protected boolean disableSSLValidation

Flag that indicates whether to disable Java's SSL certificate and host validation.

Is defined by:

property:

disableSSLValidation

default-value:

false

NEWLINE

protected final String NEWLINE

Newline constant

Constructor Detail

AbstractExternalDependencyMojo

public AbstractExternalDependencyMojo()

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

createArtifact

protected org.apache.maven.artifact.Artifact createArtifact(ArtifactItem item)

Create Maven Artifact object from ArtifactItem configuration descriptor.

Parameters:

item - the item

Returns:

Artifact

generatePomFile

protected File generatePomFile(ArtifactItem artifact)
                        throws org.apache.maven.plugin.MojoExecutionException

Generates a (temporary) POM file from the plugin configuration. It's the responsibility of the caller to delete the generated file when no longer needed.

Parameters:

artifact - the artifact

Returns:

The path to the generated POM file, never null.

Throws:

org.apache.maven.plugin.MojoExecutionException - If the POM file could not be generated.

generateModel

protected org.apache.maven.model.Model generateModel(ArtifactItem artifact)

Generates a minimal model from the user-supplied artifact information.

Parameters:

artifact - the artifact

Returns:

The generated model, never null.

getFullyQualifiedArtifactFilePath

protected File getFullyQualifiedArtifactFilePath(ArtifactItem artifactItem)

Resolves the file path and returns a file object instance for an artifact item.

Parameters:

artifactItem - the artifact item

Returns:

File object for artifact item

verifyChecksum

protected boolean verifyChecksum(File targetFile,
                                 org.codehaus.plexus.digest.Digester digester,
                                 String checksum)
                          throws org.apache.maven.plugin.MojoExecutionException

Verifies a checksum for the specified file.

Parameters:

targetFile - the path to the file from which the checksum is verified, must not be null.

digester - the checksum algorithm to use, must not be null.

checksum - the checksum to verify.

Returns:

The result

Throws:

org.apache.maven.plugin.MojoExecutionException - If the checksum could not be installed.

verifyArtifactItemChecksum

protected void verifyArtifactItemChecksum(ArtifactItem artifactItem,
                                          File targetFile)
                                   throws org.apache.maven.plugin.MojoExecutionException,
                                          org.apache.maven.plugin.MojoFailureException

Validate artifact configured checksum against specified file.

Parameters:

artifactItem - to validate checksum against

targetFile - to validate checksum against

Throws:

org.apache.maven.plugin.MojoExecutionException - the mojo execution exception

org.apache.maven.plugin.MojoFailureException - the mojo failure exception

verifyArtifactItemExtractFileChecksum

protected void verifyArtifactItemExtractFileChecksum(ArtifactItem artifactItem,
                                                     File targetFile)
                                              throws org.apache.maven.plugin.MojoExecutionException,
                                                     org.apache.maven.plugin.MojoFailureException

Validate artifact configured extracted file checksum against specified file.

Parameters:

artifactItem - to validate checksum against

targetFile - to validate checksum against

Throws:

org.apache.maven.plugin.MojoExecutionException - MojoExecutionException

org.apache.maven.plugin.MojoFailureException - MojoFailureException

verifyArtifactItemChecksumByCentralLookup

protected void verifyArtifactItemChecksumByCentralLookup(ArtifactItem artifactItem,
                                                         File targetFile)
                                                  throws org.apache.maven.plugin.MojoExecutionException,
                                                         org.apache.maven.plugin.MojoFailureException

Validate downloaded file artifact checksum does not match another artifact's checksum that already exists in the central Maven repository. Using the search.maven.org REST API to perform a checksum lookup.

Parameters:

artifactItem - to validate checksum against

targetFile - to validate checksum against

Throws:

org.apache.maven.plugin.MojoExecutionException - MojoExecutionException

org.apache.maven.plugin.MojoFailureException - MojoFailureException

Since:

0.1

getSettingsBuilder

public org.apache.maven.settings.building.SettingsBuilder getSettingsBuilder()

Generates a default settings builder.

Returns:

The SettingsBuilder instance

getSettingsBuildingRequest

public org.apache.maven.settings.building.SettingsBuildingRequest getSettingsBuildingRequest()

Generates a settings builder request from parameters.

Returns:

The SettingsBuilderRequest instance

resolveArtifactItem

protected boolean resolveArtifactItem(org.apache.maven.artifact.Artifact artifact)

resolve the artifact in local or remote repository

Parameters:

artifact - the artifact to resolve

Returns:

Whether or not the artifact was resolved

downloadArtifact

protected void downloadArtifact(ArtifactItem artifactItem,
                                org.apache.maven.artifact.Artifact artifact,
                                File artifactFile,
                                Map<URL,File> cachedDownloads)
                         throws org.apache.maven.plugin.MojoExecutionException,
                                org.apache.maven.plugin.MojoFailureException

Download an artifact.

Parameters:

artifactItem - the artifact item

artifact - the artifact

artifactFile - the artifact file

cachedDownloads - the cached downloads

Throws:

org.apache.maven.plugin.MojoExecutionException - the mojo execution exception

org.apache.maven.plugin.MojoFailureException - the mojo failure exception

getExtension

protected String getExtension(URL downloadURL)

Gets the file extension.

Parameters:

downloadURL - the download url

Returns:

the extension

getProxyInfo

protected org.apache.maven.wagon.proxy.ProxyInfo getProxyInfo()

Looks up ProxyInfo from Maven settings.

Returns:

ProxyInfo

verifyArtifact

protected void verifyArtifact(ArtifactItem artifactItem,
                              File stagedArtifactFile)
                       throws org.apache.maven.plugin.MojoExecutionException,
                              org.apache.maven.plugin.MojoFailureException

Verify artifact.

Parameters:

artifactItem - the artifact item

stagedArtifactFile - the staged artifact file

Throws:

org.apache.maven.plugin.MojoExecutionException - the mojo execution exception

org.apache.maven.plugin.MojoFailureException - the mojo failure exception

installArtifact

protected void installArtifact(ArtifactItem artifactItem,
                               org.apache.maven.artifact.Artifact artifact,
                               File stagedArtifactFile)
                        throws org.apache.maven.plugin.MojoExecutionException

Install an artifact into the local repository

Parameters:

artifactItem - the current ArtifactItem

artifact - the Artifact representing the ArtifactItem

stagedArtifactFile - the File representing the staged location for the ArtifactItem

Throws:

org.apache.maven.plugin.MojoExecutionException - MojoExecutionException