org.owasp.dependencycheck.reporting

Class ReportGenerator

java.lang.Object

org.owasp.dependencycheck.reporting.ReportGenerator

@NotThreadSafe
public class ReportGenerator
extends Object

The ReportGenerator is used to, as the name implies, generate reports. Internally the generator uses the Velocity Templating Engine. The ReportGenerator exposes a list of Dependencies to the template when generating the report.

Author:

Jeremy Long

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReportGenerator.Format An enumeration of the report formats.

Constructor Summary

Constructors

Constructor and Description
ReportGenerator(String applicationName, List<Dependency> dependencies, List<Analyzer> analyzers, DatabaseProperties properties, Settings settings) Deprecated. Please use ReportGenerator(java.lang.String, java.util.List, java.util.List, org.owasp.dependencycheck.data.nvdcve.DatabaseProperties, org.owasp.dependencycheck.utils.Settings, org.owasp.dependencycheck.exception.ExceptionCollection)
ReportGenerator(String applicationName, List<Dependency> dependencies, List<Analyzer> analyzers, DatabaseProperties properties, Settings settings, ExceptionCollection exceptions) Constructs a new ReportGenerator.
ReportGenerator(String applicationName, String groupID, String artifactID, String version, List<Dependency> dependencies, List<Analyzer> analyzers, DatabaseProperties properties, Settings settings) Deprecated. Please use ReportGenerator(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.List, java.util.List, org.owasp.dependencycheck.data.nvdcve.DatabaseProperties, org.owasp.dependencycheck.utils.Settings, org.owasp.dependencycheck.exception.ExceptionCollection)
ReportGenerator(String applicationName, String groupID, String artifactID, String version, List<Dependency> dependencies, List<Analyzer> analyzers, DatabaseProperties properties, Settings settings, ExceptionCollection exceptions) Constructs a new ReportGenerator.

Method Summary

Modifier and Type	Method and Description
static File	getReportFile(String outputLocation, ReportGenerator.Format format) Determines the report file name based on the give output location and format.
protected void	processTemplate(String template, File file) Generates a report from a given Velocity Template.
protected void	processTemplate(String templateName, OutputStream outputStream) Generates a report from a given Velocity Template.
void	write(String outputLocation, ReportGenerator.Format format) Writes the dependency-check report(s).
void	write(String outputLocation, String format) Writes the dependency-check report to the given output location.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportGenerator

@Deprecated
public ReportGenerator(String applicationName,
                                   List<Dependency> dependencies,
                                   List<Analyzer> analyzers,
                                   DatabaseProperties properties,
                                   Settings settings)

Deprecated. Please use ReportGenerator(java.lang.String, java.util.List, java.util.List, org.owasp.dependencycheck.data.nvdcve.DatabaseProperties, org.owasp.dependencycheck.utils.Settings, org.owasp.dependencycheck.exception.ExceptionCollection)

Constructs a new ReportGenerator.

Parameters:

applicationName - the application name being analyzed

dependencies - the list of dependencies

analyzers - the list of analyzers used

properties - the database properties (containing timestamps of the NVD CVE data)

settings - a reference to the database settings

ReportGenerator

public ReportGenerator(String applicationName,
                       List<Dependency> dependencies,
                       List<Analyzer> analyzers,
                       DatabaseProperties properties,
                       Settings settings,
                       ExceptionCollection exceptions)

Constructs a new ReportGenerator.

Parameters:

applicationName - the application name being analyzed

dependencies - the list of dependencies

analyzers - the list of analyzers used

properties - the database properties (containing timestamps of the NVD CVE data)

settings - a reference to the database settings

exceptions - a collection of exceptions that may have occurred during the analysis

Since:

5.1.0

ReportGenerator

@Deprecated
public ReportGenerator(String applicationName,
                                   String groupID,
                                   String artifactID,
                                   String version,
                                   List<Dependency> dependencies,
                                   List<Analyzer> analyzers,
                                   DatabaseProperties properties,
                                   Settings settings)

Deprecated. Please use ReportGenerator(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.List, java.util.List, org.owasp.dependencycheck.data.nvdcve.DatabaseProperties, org.owasp.dependencycheck.utils.Settings, org.owasp.dependencycheck.exception.ExceptionCollection)

Constructs a new ReportGenerator.

Parameters:

applicationName - the application name being analyzed

groupID - the group id of the project being analyzed

artifactID - the application id of the project being analyzed

version - the application version of the project being analyzed

dependencies - the list of dependencies

analyzers - the list of analyzers used

properties - the database properties (containing timestamps of the NVD CVE data)

settings - a reference to the database settings

ReportGenerator

public ReportGenerator(String applicationName,
                       String groupID,
                       String artifactID,
                       String version,
                       List<Dependency> dependencies,
                       List<Analyzer> analyzers,
                       DatabaseProperties properties,
                       Settings settings,
                       ExceptionCollection exceptions)

Constructs a new ReportGenerator.

Parameters:

applicationName - the application name being analyzed

groupID - the group id of the project being analyzed

artifactID - the application id of the project being analyzed

version - the application version of the project being analyzed

dependencies - the list of dependencies

analyzers - the list of analyzers used

properties - the database properties (containing timestamps of the NVD CVE data)

settings - a reference to the database settings

exceptions - a collection of exceptions that may have occurred during the analysis

Since:

5.1.0

Method Detail

write

public void write(String outputLocation,
                  String format)
           throws ReportException

Writes the dependency-check report to the given output location.

Parameters:

outputLocation - the path where the reports should be written

format - the format the report should be written in (XML, HTML, JSON, CSV, ALL) or even the path to a custom velocity template (either fully qualified or the template name on the class path).

Throws:

ReportException - is thrown if there is an error creating out the reports

write

public void write(String outputLocation,
                  ReportGenerator.Format format)
           throws ReportException

Writes the dependency-check report(s).

Parameters:

outputLocation - the path where the reports should be written

format - the format the report should be written in (XML, HTML, ALL)

Throws:

ReportException - is thrown if there is an error creating out the reports

getReportFile

public static File getReportFile(String outputLocation,
                                 ReportGenerator.Format format)

Determines the report file name based on the give output location and format. If the output location contains a full file name that has the correct extension for the given report type then the output location is returned. However, if the output location is a directory, this method will generate the correct name for the given output format.

Parameters:

outputLocation - the specified output location

format - the report format

Returns:

the report File

processTemplate

protected void processTemplate(String template,
                               File file)
                        throws ReportException

Generates a report from a given Velocity Template. The template name provided can be the name of a template contained in the jar file, such as 'XmlReport' or 'HtmlReport', or the template name can be the path to a template file.

Parameters:

template - the name of the template to load

file - the output file to write the report to

Throws:

ReportException - is thrown when the report cannot be generated

processTemplate

protected void processTemplate(String templateName,
                               OutputStream outputStream)
                        throws ReportException

Generates a report from a given Velocity Template. The template name provided can be the name of a template contained in the jar file, such as 'XmlReport' or 'HtmlReport', or the template name can be the path to a template file.

Parameters:

templateName - the name of the template to load

outputStream - the OutputStream to write the report to

Throws:

ReportException - is thrown when an exception occurs