Package org.spdx.maven.utils

Class SpdxV2DocumentBuilder

java.lang.Object

org.spdx.maven.utils.AbstractDocumentBuilder

org.spdx.maven.utils.SpdxV2DocumentBuilder

public class SpdxV2DocumentBuilder
extends AbstractDocumentBuilder

Builder for SPDX Spec version 2 SPDX Documents

Author:

Gary O'Neall

Field Summary

Fields

Modifier and Type	Field	Description
protected SpdxV2LicenseManager	licenseManager
protected org.spdx.library.model.v2.SpdxPackage	projectPackage
protected org.spdx.library.model.v2.SpdxDocument	spdxDoc

Fields inherited from class org.spdx.maven.utils.AbstractDocumentBuilder

copyManager, format, generatePurls, modelStore, NULL_SHA1, outputFormatEnum, project, spdxFile, UNSPECIFIED

Constructor Summary

Constructors

Constructor	Description
SpdxV2DocumentBuilder(org.apache.maven.project.MavenProject mavenProject, boolean generatePurls, File spdxFile, URI spdxDocumentNamespace, OutputFormat outputFormatEnum)

Method Summary

Modifier and Type	Method	Description
void	addNonStandardLicenses(NonStandardLicense[] nonStandardLicenses)
void	collectSpdxFileInformation(List<org.apache.maven.shared.model.fileset.FileSet> sources, String baseDir, SpdxDefaultFileInformation defaultFileInformation, HashMap<String,SpdxDefaultFileInformation> pathSpecificInformation, Set<String> checksumAlgorithms)	Collect information at the file level, fill in the SPDX document
org.spdx.library.model.v2.ExternalRef	convertExternalRef(ExternalReference externalReference)
void	fillSpdxDocumentInformation(SpdxProjectInformation projectInformation)
SpdxV2LicenseManager	getLicenseManager()
org.spdx.core.CoreModelObject	getProjectPackage()
org.spdx.library.model.v2.SpdxDocument	getSpdxDoc()
String	mavenLicenseListToSpdxLicenseExpression(List<org.apache.maven.model.License> mavenLicenses)
void	saveSpdxDocumentToFile()	Saves the SPDX document to the file
List<String>	verify()	Verifies the top level document

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

spdxDoc

protected org.spdx.library.model.v2.SpdxDocument spdxDoc

licenseManager

protected SpdxV2LicenseManager licenseManager

projectPackage

protected org.spdx.library.model.v2.SpdxPackage projectPackage

Constructor Details

SpdxV2DocumentBuilder

public SpdxV2DocumentBuilder(org.apache.maven.project.MavenProject mavenProject,
 boolean generatePurls,
 File spdxFile,
 URI spdxDocumentNamespace,
 OutputFormat outputFormatEnum)
                      throws SpdxBuilderException,
LicenseMapperException

Parameters:

mavenProject - Maven project

generatePurls - If true, generated Package URLs for all package references

spdxFile - File to store the SPDX document results

spdxDocumentNamespace - SPDX Document namespace - must be unique

outputFormatEnum - output format to use for storing the SPDX file

Throws:

SpdxBuilderException

LicenseMapperException

Method Details

getSpdxDoc

public org.spdx.library.model.v2.SpdxDocument getSpdxDoc()

Returns:

the SPDX Document

fillSpdxDocumentInformation

public void fillSpdxDocumentInformation(SpdxProjectInformation projectInformation)
                                 throws SpdxBuilderException

Specified by:

fillSpdxDocumentInformation in class AbstractDocumentBuilder

Parameters:

projectInformation - Information about project extracted from Maven metadata and parameters

Throws:

SpdxBuilderException - on errors adding document level information

collectSpdxFileInformation

public void collectSpdxFileInformation(List<org.apache.maven.shared.model.fileset.FileSet> sources,
 String baseDir,
 SpdxDefaultFileInformation defaultFileInformation,
 HashMap<String,SpdxDefaultFileInformation> pathSpecificInformation,
 Set<String> checksumAlgorithms)
                                throws SpdxBuilderException

Description copied from class: AbstractDocumentBuilder

Collect information at the file level, fill in the SPDX document

Specified by:

collectSpdxFileInformation in class AbstractDocumentBuilder

Parameters:

sources - Source directories to be included in the document

baseDir - project base directory used to construct the relative paths for the SPDX files

defaultFileInformation - Information on default SPDX field data for the files

pathSpecificInformation - Map of path to file information used to override the default file information

checksumAlgorithms - algorithms to use to generate checksums

Throws:

SpdxBuilderException - on errors collecting files

saveSpdxDocumentToFile

public void saveSpdxDocumentToFile()
                            throws SpdxBuilderException

Description copied from class: AbstractDocumentBuilder

Saves the SPDX document to the file

Specified by:

saveSpdxDocumentToFile in class AbstractDocumentBuilder

Throws:

SpdxBuilderException - On any error saving the file

addNonStandardLicenses

public void addNonStandardLicenses(NonStandardLicense[] nonStandardLicenses)
                            throws SpdxBuilderException

Specified by:

addNonStandardLicenses in class AbstractDocumentBuilder

Parameters:

nonStandardLicenses - non standard licenses to add

Throws:

SpdxBuilderException

convertExternalRef

public org.spdx.library.model.v2.ExternalRef convertExternalRef(ExternalReference externalReference)
                                                         throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getProjectPackage

public org.spdx.core.CoreModelObject getProjectPackage()

Specified by:

getProjectPackage in class AbstractDocumentBuilder

Returns:

package representing the Maven project

mavenLicenseListToSpdxLicenseExpression

public String mavenLicenseListToSpdxLicenseExpression(List<org.apache.maven.model.License> mavenLicenses)
                                               throws LicenseManagerException

Specified by:

mavenLicenseListToSpdxLicenseExpression in class AbstractDocumentBuilder

Parameters:

mavenLicenses - list of licenses

Returns:

license expression representing the list of mavenLicenses

Throws:

LicenseManagerException - On error converting license

verify

public List<String> verify()

Description copied from class: AbstractDocumentBuilder

Verifies the top level document

Specified by:

verify in class AbstractDocumentBuilder

Returns:

list of any errors or warnings

getLicenseManager

public SpdxV2LicenseManager getLicenseManager()

Returns:

the license manager