Package org.spdx.maven.utils

Class AbstractFileCollector

java.lang.Object
org.spdx.maven.utils.AbstractFileCollector
Direct Known Subclasses:
SpdxV2FileCollector, SpdxV3FileCollector
public abstract class AbstractFileCollector extends Object
Collects SPDX file information from directories.

Concrete subclasses implement specific SPDX spec specific formats

Author:
Gary O'Neall

  • Field Details

    • LOG

      protected static final org.slf4j.Logger LOG

    • EXT_TO_FILE_TYPE

      public static final Map<String,org.spdx.library.model.v2.enumerations.FileType> EXT_TO_FILE_TYPE

    • CHECKSUM_ALGORITHMS

      public static final Map<String,String> CHECKSUM_ALGORITHMS

  • Constructor Details

    • AbstractFileCollector

      public AbstractFileCollector()

  • Method Details

    • getExtension

      public String getExtension(File file)

    • isSourceFile

      protected boolean isSourceFile(Collection<org.spdx.library.model.v2.enumerations.FileType> fileTypes)
      Parameters:
      fileTypes - list of file types for the file
      Returns:
      true if the fileTypes contain a source file type

    • convertFilePathToSpdxFileName

      public String convertFilePathToSpdxFileName(String filePath)
      Create the SPDX file name from a system specific path name
      Parameters:
      filePath - system specific file path relative to the top of the archive root to the top of the archive directory where the file is stored.
      Returns:
      valid SPDX file name per the spec

    • extensionToFileType

      protected static org.spdx.library.model.v2.enumerations.FileType extensionToFileType(String fileExtension)

    • convertChecksumToString

      public static String convertChecksumToString(byte[] digestBytes)
      Converts an array of bytes to a string compliant with the SPDX sha1 representation
      Parameters:
      digestBytes - result of a checksum digest calculation
      Returns:
      string representation of the checksum per the SPDX specification

    • generateSha1

      public static Checksum generateSha1(File file) throws SpdxCollectionException, org.spdx.core.InvalidSPDXAnalysisException
      Generate the Sha1 for a given file. Must have read access to the file. This method is equivalent to calling SpdxFileCollector.generateChecksum(file, "SHA-1").
      Parameters:
      file - file to generate checksum for
      Returns:
      SHA1 checksum of the input file
      Throws:
      SpdxCollectionException - if the algorithm is unavailable or the file cannot be read
      org.spdx.core.InvalidSPDXAnalysisException - on SPDX parsing errors

    • generateChecksum

      public static Set<Checksum> generateChecksum(File file, Set<String> algorithms) throws SpdxCollectionException, org.spdx.core.InvalidSPDXAnalysisException
      Generate checksums for a given file using each algorithm supplied. Must have read access to the file.
      Parameters:
      file - file whose checksum is to be generated
      algorithms - algorithms to generate the checksums
      Returns:
      Set of checksums for file using each algorithm specified
      Throws:
      SpdxCollectionException - if the input algorithm is invalid or unavailable or if the file cannot be read
      org.spdx.core.InvalidSPDXAnalysisException - on SPDX parsing errors

    • toRelativeFilePath

      protected static String toRelativeFilePath(File file, String baseDir)
      Parameters:
      file - file which is the target for the path string
      baseDir - base directory of the SPDX archive or project containing the file
      Returns:
      a file path for the file relative to the baseDir