java.lang.Object
- org.eclipse.steady.report.Report

```
public class Report
extends Object
```
Report class.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Report.AggregatedVuln

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`THRESHOLD_ACT_EXE`	Constant `THRESHOLD_ACT_EXE="actuallyExecutes"`
`static String`	`THRESHOLD_DEP_ON`	Constant `THRESHOLD_DEP_ON="dependsOn"`
`static String`	`THRESHOLD_NONE`	Constant `THRESHOLD_NONE="noException"`
`static String`	`THRESHOLD_POT_EXE`	Constant `THRESHOLD_POT_EXE="potentiallyExecutes"`

Constructor Summary

Constructors
Constructor Description

Report(GoalContext _ctx, Application _app, Set<Application> _modules)
Constructor for Report.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`fetchAppVulnerabilities()`	Downloads vulnerable dependencies for all `Application`s in member variable `modules`.
`Map<String,String>`	`getConfiguration()`	Returns a human-readable description of the configuration.
`String`	`getExceptionMessage()`	getExceptionMessage.
`String`	`getExceptionThreshold()`	Getter for the field `exceptionThreshold`.
`String`	`getResultAsString()`	getResultAsString.
`Map<String,Long>`	`getStats()`	Getter for the field `stats`.
`boolean`	`isCreateAffectedLibraries()`	isCreateAffectedLibraries.
`boolean`	`isThrowBuildException()`	Returns true if a build exception shall be thrown, which is the case if a threshold other than `THRESHOLD_NONE` is defined and vulnerabilities exist above this threshold.
`void`	`processVulnerabilities()`	Processes all the vulnerabilities of all application modules as obtained from the backend.
`void`	`setCreateAffectedLibraries(boolean createAffectedLibraries)`	Setter for the field `createAffectedLibraries`.
`void`	`setExceptionThreshold(String _threshold)`	Setter for the field `exceptionThreshold`.
`void`	`setExemptions(ExemptionSet _exemptions)`	Setter for the field `excemptions`.
`void`	`writeResult(@NotNull Path _dir)`	Creates result reports in HTML, XML and JSON.
`Path`	`writeResult(@NotNull Path _dir, String _template, String _report)`	writeResult.
`Path`	`writeResultAsHtml(@NotNull Path _dir)`	writeResultAsHtml.
`Path`	`writeResultAsJson(@NotNull Path _dir)`	writeResultAsJson.
`Path`	`writeResultAsXml(@NotNull Path _dir)`	writeResultAsXml.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - THRESHOLD_NONE
```
public static final String THRESHOLD_NONE
```
    Constant THRESHOLD_NONE="noException"
    
    See Also:
    
    Constant Field Values
  - THRESHOLD_DEP_ON
```
public static final String THRESHOLD_DEP_ON
```
    Constant THRESHOLD_DEP_ON="dependsOn"
    
    See Also:
    
    Constant Field Values
  - THRESHOLD_POT_EXE
```
public static final String THRESHOLD_POT_EXE
```
    Constant THRESHOLD_POT_EXE="potentiallyExecutes"
    
    See Also:
    
    Constant Field Values
  - THRESHOLD_ACT_EXE
```
public static final String THRESHOLD_ACT_EXE
```
    Constant THRESHOLD_ACT_EXE="actuallyExecutes"
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Report
```
public Report(GoalContext _ctx,
              Application _app,
              Set<Application> _modules)
```
    Constructor for Report.
    
    Parameters:
    
    _ctx - a GoalContext object.
    
    _app - a Application object.
    
    _modules - a Set object.
- Method Detail
  - getExceptionThreshold
```
public String getExceptionThreshold()
```
    Getter for the field exceptionThreshold.
    
    Returns:
    
    a String object.
  - setExceptionThreshold
```
public void setExceptionThreshold(String _threshold)
```
    Setter for the field exceptionThreshold.
    
    Parameters:
    
    _threshold - a String object.
  - isCreateAffectedLibraries
```
public boolean isCreateAffectedLibraries()
```
    isCreateAffectedLibraries.
    
    Returns:
    
    a boolean
  - setCreateAffectedLibraries
```
public void setCreateAffectedLibraries(boolean createAffectedLibraries)
```
    Setter for the field createAffectedLibraries.
    
    Parameters:
    
    createAffectedLibraries - a boolean
  - setExemptions
```
public void setExemptions(ExemptionSet _exemptions)
```
    Setter for the field excemptions.
    
    Parameters:
    
    _exemptions - a Set of ExemptionBugs.
  - fetchAppVulnerabilities
```
public void fetchAppVulnerabilities()
                             throws IOException,
                                    BackendConnectionException
```
    Downloads vulnerable dependencies for all Applications in member variable modules. The member variable modules only contains multiple Applications if the report is created through the Maven plugin and the respective Maven project (for which the report goal is executed) is a multi-module aggregator project. If both conditions are met, each project module corresponds to one Application in member variable modules.
    
    Throws:
    
    IOException
    
    BackendConnectionException
  - processVulnerabilities
```
public void processVulnerabilities()
```
    Processes all the vulnerabilities of all application modules as obtained from the backend. Populates the Velocity context required for rendering the templates in writeResult(Path).
  - isThrowBuildException
```
public boolean isThrowBuildException()
```
    Returns true if a build exception shall be thrown, which is the case if a threshold other than THRESHOLD_NONE is defined and vulnerabilities exist above this threshold.
    
    Returns:
    
    a boolean.
  - getConfiguration
```
public Map<String,String> getConfiguration()
```
    Returns a human-readable description of the configuration.
    
    Returns:
    
    a Map object.
  - getStats
```
public Map<String,Long> getStats()
```
    Getter for the field stats.
    
    Returns:
    
    a Map object.
  - getExceptionMessage
```
public String getExceptionMessage()
```
    getExceptionMessage.
    
    Returns:
    
    a String object.
  - getResultAsString
```
public String getResultAsString()
```
    getResultAsString.
    
    Returns:
    
    a String object.
  - writeResult
```
public void writeResult(@NotNull
                        @NotNull Path _dir)
```
    Creates result reports in HTML, XML and JSON.
    
    Parameters:
    
    _dir - a Path object.
  - writeResult
```
public Path writeResult(@NotNull
                        @NotNull Path _dir,
                        String _template,
                        String _report)
```
    writeResult.
    
    Parameters:
    
    _dir - a Path object.
    
    _template - a String object.
    
    _report - a String object.
    
    Returns:
    
    a Path object.
  - writeResultAsHtml
```
public Path writeResultAsHtml(@NotNull
                              @NotNull Path _dir)
```
    writeResultAsHtml.
    
    Parameters:
    
    _dir - a Path object.
    
    Returns:
    
    a Path object.
  - writeResultAsXml
```
public Path writeResultAsXml(@NotNull
                             @NotNull Path _dir)
```
    writeResultAsXml.
    
    Parameters:
    
    _dir - a Path object.
    
    Returns:
    
    a Path object.
  - writeResultAsJson
```
public Path writeResultAsJson(@NotNull
                              @NotNull Path _dir)
```
    writeResultAsJson.
    
    Parameters:
    
    _dir - a Path object.
    
    Returns:
    
    a Path object.

Class Report

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

THRESHOLD_NONE

THRESHOLD_DEP_ON

THRESHOLD_POT_EXE

THRESHOLD_ACT_EXE

Constructor Detail

Report

Method Detail

getExceptionThreshold

setExceptionThreshold

isCreateAffectedLibraries

setCreateAffectedLibraries

setExemptions

fetchAppVulnerabilities

processVulnerabilities

isThrowBuildException

getConfiguration

getStats

getExceptionMessage

getResultAsString

writeResult

writeResult

writeResultAsHtml

writeResultAsXml

writeResultAsJson