Package org.spdx.maven.utils

Class SpdxV3DocumentBuilder

java.lang.Object

org.spdx.maven.utils.AbstractDocumentBuilder

org.spdx.maven.utils.SpdxV3DocumentBuilder

public class SpdxV3DocumentBuilder
extends AbstractDocumentBuilder

Builder for SPDX Spec version 3 SBOMs

Author:

Gary O'Neall

Field Summary

Fields

Modifier and Type	Field	Description
protected org.spdx.library.model.v3_0_1.core.CreationInfo	creationInfo
protected List<org.spdx.library.model.v3_0_1.core.DictionaryEntry>	customIdToUri	Holds a mapping of IDs to URIs for any custom licenses defined outside the spdxDoc
protected SpdxV3LicenseManager	licenseManager
protected org.spdx.library.model.v3_0_1.software.SpdxPackage	projectPackage
protected org.spdx.library.model.v3_0_1.software.Sbom	sbom
protected org.spdx.library.model.v3_0_1.core.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
SpdxV3DocumentBuilder(org.apache.maven.project.MavenProject mavenProject, boolean generatePurls, File spdxFile, URI namespaceUri, 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
void	fillSpdxDocumentInformation(SpdxProjectInformation projectInformation)
SpdxV3LicenseManager	getLicenseManager()
org.spdx.core.CoreModelObject	getProjectPackage()
org.spdx.library.model.v3_0_1.core.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

creationInfo

protected org.spdx.library.model.v3_0_1.core.CreationInfo creationInfo

sbom

protected org.spdx.library.model.v3_0_1.software.Sbom sbom

spdxDoc

protected org.spdx.library.model.v3_0_1.core.SpdxDocument spdxDoc

projectPackage

protected org.spdx.library.model.v3_0_1.software.SpdxPackage projectPackage

licenseManager

protected SpdxV3LicenseManager licenseManager

customIdToUri

protected List<org.spdx.library.model.v3_0_1.core.DictionaryEntry> customIdToUri

Holds a mapping of IDs to URIs for any custom licenses defined outside the spdxDoc

Constructor Details

SpdxV3DocumentBuilder

public SpdxV3DocumentBuilder(org.apache.maven.project.MavenProject mavenProject,
 boolean generatePurls,
 File spdxFile,
 URI namespaceUri,
 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

namespaceUri - Namespace prefix for generated SPDX URIs document - must be unique

outputFormatEnum - format for the SPDX document

Throws:

SpdxBuilderException

LicenseMapperException

Method Details

getSpdxDoc

public org.spdx.library.model.v3_0_1.core.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

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

getLicenseManager

public SpdxV3LicenseManager getLicenseManager()

Returns:

the licenseManager

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