org.jenkinsci.plugins.zap.report

Class ZAPReport

java.lang.Object

org.jenkinsci.plugins.zap.report.ZAPReport

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ZAPReportHTML, ZAPReportXML

public abstract class ZAPReport
extends Object
implements Serializable

This abstract class is used to generate report in ZAP available format.

Author:

Goran Sarenkapa, Mostafa AbdelMoez, Tanguy de Lignières, Abdellah Azougarh, Thilina Madhusanka, Johann Ollivier-Lapeyre, Ludovic Roucoux

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	format The report format
protected static String	REPORT_FORMAT_HTML
protected static String	REPORT_FORMAT_XML

Constructor Summary

Constructors

Constructor and Description
ZAPReport()

Method Summary

Modifier and Type	Method and Description
abstract byte[]	generateReport(org.zaproxy.clientapi.core.ClientApi clientApi, String apikey) Generate a ZAP report in the format of daughter class.
String	getFormat()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

REPORT_FORMAT_XML

protected static final String REPORT_FORMAT_XML

See Also:

Constant Field Values

REPORT_FORMAT_HTML

protected static final String REPORT_FORMAT_HTML

See Also:

Constant Field Values

format

protected String format

The report format

Constructor Detail

ZAPReport

public ZAPReport()

Method Detail

generateReport

public abstract byte[] generateReport(org.zaproxy.clientapi.core.ClientApi clientApi,
                                      String apikey)
                               throws org.zaproxy.clientapi.core.ClientApiException

Generate a ZAP report in the format of daughter class.

Parameters:

clientApi - of type ClientApi: the ZAP client API to call method.

apikey - of type String: ZAP apikey. Can be null.

Returns:

an array of byte containing the report.

Throws:

org.zaproxy.clientapi.core.ClientApiException

getFormat

public String getFormat()

toString

public String toString()

Overrides:

toString in class Object