de.irissmann.arachni.client

Class Scan

java.lang.Object

de.irissmann.arachni.client.Scan

Direct Known Subclasses:

ScanRestImpl

public abstract class Scan
extends Object

With a Scan instance you can get all informations and reports from Arachni Security Scanner.

Since:

1.0.0

Author:

Ingo Rissmann

Method Summary

Modifier and Type	Method and Description
String	getId() Returns the id of the scan.
abstract void	getReportHtml(OutputStream outstream) Writes the scan HTML report in a given OutputStream as a zip file.
abstract String	getReportJson() Retrieve the scan report as JSON string.
abstract String	getReportXml() Retrieve the scan report as XML string.
abstract String	getReportYaml() Retrieve the scan report as YAML string.
abstract ScanResponse	monitor() Monitors the scan and returns a ReportScan object.
abstract boolean	shutdown() This call needs to take place after each scan is done in order to prevent zombie processes.

Methods inherited from class java.lang.Object

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

Method Detail

getId

public String getId()

Returns the id of the scan.

Returns:

The id.

monitor

public abstract ScanResponse monitor()

Monitors the scan and returns a ReportScan object. This method can thrown a ArachniClientException.

Returns:

A ReportScan with all monitoring information.

Throws:

ArachniClientException

shutdown

public abstract boolean shutdown()

This call needs to take place after each scan is done in order to prevent zombie processes. Once that call is made, the scan process will be killed and removed from the service, if you wish to retrieve the report you will need to do so prior to performing this call.

Returns:

true if shutdown was successful.

Throws:

ArachniClientException

getReportJson

public abstract String getReportJson()

Retrieve the scan report as JSON string. This method can thrown an ArachniClientException

Returns:

The scan report as JSON string.

Throws:

ArachniClientException

getReportHtml

public abstract void getReportHtml(OutputStream outstream)

Writes the scan HTML report in a given OutputStream as a zip file.

Parameters:

outstream - The OutputStream object to write the report.

Throws:

ArachniClientException

getReportXml

public abstract String getReportXml()

Retrieve the scan report as XML string. This method can thrown an ArachniClientException

Returns:

The scan report as XML string.

Throws:

ArachniClientException

getReportYaml

public abstract String getReportYaml()

Retrieve the scan report as YAML string. This method can thrown an ArachniClientException

Returns:

The scan report as YAML string.

Throws:

ArachniClientException