gov.nist.secauto.swid.plugin.generate

Class MavenProjectSwidBuilderHelper

java.lang.Object

gov.nist.secauto.swid.plugin.generate.MavenProjectSwidBuilderHelper

public class MavenProjectSwidBuilderHelper
extends Object

Method Summary

Modifier and Type	Method and Description
static SWIDBuilder	applyEntities(SWIDBuilder builder, List<Entity> entities) Append the provided SWID Tag entities to the tag.
static void	applyFileEnties(AbstractResourceCollectionBuilder<?> builder, String swidTagPath, List<FileEntry> swidFiles, Collection<HashAlgorithm> hashAlgorithms) Apply the provided file entries to the tag's payload.
static SWIDBuilder	applyProjectMetadata(SWIDBuilder builder, org.apache.maven.project.MavenProject project) Apply Maven project metadata to populate the core SWID Tag data elements.
static SWIDBuilder	buildSwidTag(org.apache.maven.project.MavenProject project, String swidTagPath, List<Entity> entities, List<FileEntry> swidFiles) Build a SWID Tag using Maven project metadata and provided Entity and FileEntry information.
protected static String	generateTagId(org.apache.maven.project.MavenProject project)

Methods inherited from class java.lang.Object

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

Method Detail

applyProjectMetadata

public static SWIDBuilder applyProjectMetadata(SWIDBuilder builder,
                                               org.apache.maven.project.MavenProject project)

Apply Maven project metadata to populate the core SWID Tag data elements.

Parameters:

builder - the SWID Tag builder

project - the Maven project instance

Returns:

the SWID Tag builder instance

generateTagId

protected static String generateTagId(org.apache.maven.project.MavenProject project)

applyEntities

public static SWIDBuilder applyEntities(SWIDBuilder builder,
                                        List<Entity> entities)

Append the provided SWID Tag entities to the tag.

Parameters:

builder - the SWID Tag builder

entities - the list of entities to append

Returns:

the SWID Tag builder instance

applyFileEnties

public static void applyFileEnties(AbstractResourceCollectionBuilder<?> builder,
                                   String swidTagPath,
                                   List<FileEntry> swidFiles,
                                   Collection<HashAlgorithm> hashAlgorithms)
                            throws NoSuchAlgorithmException,
                                   IOException

Apply the provided file entries to the tag's payload.

Parameters:

builder - the payload's builder

swidTagPath - the output path of the tag

swidFiles - the files to build payload entries for

hashAlgorithms - the hash algorithms to use to calculate file digests

Throws:

NoSuchAlgorithmException - if a hash algorithm is not supported

IOException - if an error occured while processing the payload files

buildSwidTag

public static SWIDBuilder buildSwidTag(org.apache.maven.project.MavenProject project,
                                       String swidTagPath,
                                       List<Entity> entities,
                                       List<FileEntry> swidFiles)
                                throws NoSuchAlgorithmException,
                                       IOException

Build a SWID Tag using Maven project metadata and provided Entity and FileEntry information.

Parameters:

project - the MavenProject to build the tag for

swidTagPath - the output path of the tag

entities - the SWID Tag entities to include

swidFiles - the files to build payload entries for

Returns:

a builder instance for the tag

Throws:

NoSuchAlgorithmException - if a hash algorithm is not supported

IOException - if an error occured while processing the payload files