DependenciesMojo (checksum-maven-plugin 1.5 API)

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - net.nicoulaj.maven.plugins.checksum.mojo.DependenciesMojo

All Implemented Interfaces:: org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

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

Compute project dependencies checksum digests and store them in 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`	`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 List<String>`	`scopes` The dependency scopes to include.
`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`	`transitive` Transitive dependencies or only direct dependencies.
`protected List<String>`	`types` The dependency types to include.
`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

DependenciesMojo()

Constructors
Constructor and Description
`DependenciesMojo()`

Method Summary

All Methods Instance Methods Concrete Methods
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`	`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="false")
protected boolean individualFiles
```
    Indicates whether the build will store checksums in separate files (one file per algorithm per artifact).
    
    Since:
    
    1.0
  - individualFilesOutputDirectory
```
@Parameter(defaultValue="${project.build.directory}")
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="true")
protected boolean csvSummary
```
    Indicates whether the build will store checksums to a single CSV summary file.
    
    Since:
    
    1.0
  - csvSummaryFile
```
@Parameter(defaultValue="dependencies-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="dependencies-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="dependencies-checksums.sha")
protected String shasumSummaryFile
```
    The name of the summary file created if the option is activated.
    
    Since:
    
    1.3
    
    See Also:
    
    shasumSummary
  - scopes
```
@Parameter
protected List<String> scopes
```
    The dependency scopes to include.
    Allowed values are compile, test, runtime, provided and system.
    All scopes are included by default.
    
    Use the following syntax:
```
<scopes>
   <scope>compile<scope>
   <scope>runtime<scope>
 </scopes>
```
    Since:
    
    1.0
  - types
```
@Parameter
protected List<String> types
```
    The dependency types to include.
    All types are included by default.
    
    Use the following syntax:
```
<types>
   <type>jar<type>
   <type>zip<type>
 </types>
```
    Since:
    
    1.0
  - transitive
```
@Parameter(defaultValue="false")
protected boolean transitive
```
    Transitive dependencies or only direct dependencies.
    
    Since:
    
    1.0
  - 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
  - DependenciesMojo
```
public DependenciesMojo()
```
- 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 dependencies.
    
    Returns:
    
    the list of files that should be processed.
  - isIndividualFiles
```
protected boolean isIndividualFiles()
```
  - getIndividualFilesOutputDirectory
```
protected String getIndividualFilesOutputDirectory()
```
  - 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
  - isAppendFilename
```
protected boolean isAppendFilename()
```

Class DependenciesMojo

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class org.apache.maven.plugin.AbstractMojo

Methods inherited from class java.lang.Object

Field Detail

NAME

individualFiles

individualFilesOutputDirectory

csvSummary

csvSummaryFile

xmlSummary

xmlSummaryFile

shasumSummary

shasumSummaryFile

scopes

types

transitive

project

projectHelper

algorithms

failOnError

encoding

attachChecksums

quiet

includeRelativePath

relativeSubPath

Constructor Detail

DependenciesMojo

Method Detail

getFilesToProcess

isIndividualFiles

getIndividualFilesOutputDirectory

isCsvSummary

getCsvSummaryFile

isXmlSummary

getXmlSummaryFile

isShasumSummary

getShasumSummaryFile

execute

isAppendFilename