net.nicoulaj.maven.plugins.checksum.mojo

Class ArtifactsMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

net.nicoulaj.maven.plugins.checksum.mojo.ArtifactsMojo

All Implemented Interfaces:

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

@Mojo(name="artifacts",
      defaultPhase=VERIFY,
      requiresProject=true,
      inheritByDefault=false,
      threadSafe=true)
public class ArtifactsMojo
extends org.apache.maven.plugin.AbstractMojo

Compute project artifacts checksum digests and store them in individual files and/or a summary file.

Since:

1.0

Author:

Julien Nicoulaud

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	algorithms The list of checksum algorithms used.
protected boolean	appendFilename Append the artifact filename in the generated checksum file.
protected boolean	attachChecksums Should the checksums be attached as build artifacts.
protected boolean	csvSummary Indicates whether the build will store checksums to a single CSV summary file.
protected String	csvSummaryFile The name of the summary file created if the option is activated.
protected String	encoding Encoding to use for generated files.
protected boolean	failOnError Indicates whether the build will fail if there are errors.
protected boolean	includeRelativePath Indicates whether the build will output relative path information as well.
protected boolean	individualFiles Indicates whether the build will store checksums in separate files (one file per algorithm per artifact).
protected String	individualFilesOutputDirectory The directory where output files will be stored.
static String	NAME The mojo name.
protected org.apache.maven.project.MavenProject	project The Maven project.
protected org.apache.maven.project.MavenProjectHelper	projectHelper The Maven Project Helper.
protected boolean	quiet Indicates whether the build will print checksums in the build log.
protected String	relativeSubPath Sub path to use as the root of the relative path when including relative path in xml/csv files
protected boolean	shasumSummary Indicates whether the build will store checksums to a single shasum summary file.
protected String	shasumSummaryFile The name of the summary file created if the option is activated.
protected boolean	xmlSummary Indicates whether the build will store checksums to a single XML summary file.
protected String	xmlSummaryFile The name of the summary file created if the option is activated.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
ArtifactsMojo()

Method Summary

Modifier and Type	Method and Description
void	execute()
protected String	getCsvSummaryFile()
protected List<ChecksumFile>	getFilesToProcess() Build the list of files from which digests should be generated.
protected String	getIndividualFilesOutputDirectory()
protected String	getShasumSummaryFile()
protected String	getXmlSummaryFile()
protected boolean	hasValidFile(org.apache.maven.artifact.Artifact artifact) Decide whether the artifact file should be processed.
protected boolean	isAppendFilename()
protected boolean	isCsvSummary()
protected boolean	isIndividualFiles()
protected boolean	isShasumSummary()
protected boolean	isXmlSummary()

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

NAME

public static final String NAME

The mojo name.

See Also:

Constant Field Values

individualFiles

@Parameter(defaultValue="true")
protected boolean individualFiles

Indicates whether the build will store checksums in separate files (one file per algorithm per artifact).

Since:

1.0

individualFilesOutputDirectory

@Parameter
protected String individualFilesOutputDirectory

The directory where output files will be stored. Leave unset to have each file next to the source file.

Since:

1.0

csvSummary

@Parameter(defaultValue="false")
protected boolean csvSummary

Indicates whether the build will store checksums to a single CSV summary file.

Since:

1.0

csvSummaryFile

@Parameter(defaultValue="artifacts-checksums.csv")
protected String csvSummaryFile

The name of the summary file created if the option is activated.

Since:

1.0

See Also:

csvSummary

xmlSummary

@Parameter(defaultValue="false")
protected boolean xmlSummary

Indicates whether the build will store checksums to a single XML summary file.

Since:

1.0

xmlSummaryFile

@Parameter(defaultValue="artifacts-checksums.xml")
protected String xmlSummaryFile

The name of the summary file created if the option is activated.

Since:

1.0

See Also:

xmlSummary

shasumSummary

@Parameter(defaultValue="false")
protected boolean shasumSummary

Indicates whether the build will store checksums to a single shasum summary file.

Since:

1.3

shasumSummaryFile

@Parameter(defaultValue="artifacts-checksums.sha")
protected String shasumSummaryFile

The name of the summary file created if the option is activated.

Since:

1.3

See Also:

shasumSummary

appendFilename

@Parameter(defaultValue="false")
protected boolean appendFilename

Append the artifact filename in the generated checksum file. This parameter require the parameter individualFiles be equal to true.

Since:

1.4

See Also:

individualFiles

project

@Parameter(property="project",
           required=true,
           readonly=true)
protected org.apache.maven.project.MavenProject project

The Maven project.

Since:

1.0

projectHelper

@Component
protected org.apache.maven.project.MavenProjectHelper projectHelper

The Maven Project Helper. Used to attach checksums as build artifacts.

Since:

1.3

algorithms

@Parameter
protected List<String> algorithms

The list of checksum algorithms used.

Default value is MD5 and SHA-1.
Allowed values are CRC32, MD2, MD4, MD5, SHA-1, SHA-224, SHA-256, SHA-384, SHA-512, RIPEMD128, RIPEMD160, RIPEMD256, RIPEMD320, GOST3411 and Tiger.

Use the following syntax:

<algorithms>
   <algorithm>MD5<algorithm>
   <algorithm>SHA-1<algorithm>
 </algorithms>

Since:

1.0

failOnError

@Parameter(defaultValue="true")
protected boolean failOnError

Indicates whether the build will fail if there are errors.

Since:

1.0

encoding

@Parameter(property="encoding",
           defaultValue="${project.build.sourceEncoding}")
protected String encoding

Encoding to use for generated files.

Since:

1.0

attachChecksums

@Parameter(property="attachChecksums",
           defaultValue="false")
protected boolean attachChecksums

Should the checksums be attached as build artifacts.

Since:

1.3

quiet

@Parameter(defaultValue="false")
protected boolean quiet

Indicates whether the build will print checksums in the build log.

Since:

1.0

includeRelativePath

@Parameter(defaultValue="false")
protected boolean includeRelativePath

Indicates whether the build will output relative path information as well.

Since:

1.3

relativeSubPath

@Parameter(defaultValue="")
protected String relativeSubPath

Sub path to use as the root of the relative path when including relative path in xml/csv files

Since:

1.3

Constructor Detail

ArtifactsMojo

public ArtifactsMojo()

Method Detail

getFilesToProcess

protected List<ChecksumFile> getFilesToProcess()

Build the list of files from which digests should be generated.

The list is composed of the project main and attached artifacts.

Returns:

the list of files that should be processed.

See Also:

hasValidFile(org.apache.maven.artifact.Artifact)

hasValidFile

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

Decide whether the artifact file should be processed.

Excludes the project POM file and any file outside the build directory, because this could lead to writing files on the user local repository for example.

Parameters:

artifact - the artifact to check.

Returns:

true if the artifact should be included in the files to process.

isIndividualFiles

protected boolean isIndividualFiles()

getIndividualFilesOutputDirectory

protected String getIndividualFilesOutputDirectory()

isAppendFilename

protected boolean isAppendFilename()

isCsvSummary

protected boolean isCsvSummary()

getCsvSummaryFile

protected String getCsvSummaryFile()

isXmlSummary

protected boolean isXmlSummary()

getXmlSummaryFile

protected String getXmlSummaryFile()

isShasumSummary

protected boolean isShasumSummary()

getShasumSummaryFile

protected String getShasumSummaryFile()

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