de.irissmann.arachni.client.rest

Class ScanRestImpl

java.lang.Object

de.irissmann.arachni.client.Scan

de.irissmann.arachni.client.rest.ScanRestImpl

public class ScanRestImpl
extends Scan

This is a REST API implementation of the Scan interface. It is using an ArachniRestClient to communicate with a Arachni REST server.

Author:

Ingo Rissmann

Method Summary

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

Methods inherited from class de.irissmann.arachni.client.Scan

getId

Methods inherited from class java.lang.Object

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

Method Detail

monitor

public ScanResponse monitor()

Description copied from class: Scan

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

Specified by:

monitor in class Scan

Returns:

A ReportScan with all monitoring information.

shutdown

public boolean shutdown()

Description copied from class: Scan

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.

Specified by:

shutdown in class Scan

Returns:

true if shutdown was successful.

getReportJson

public String getReportJson()

Description copied from class: Scan

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

Specified by:

getReportJson in class Scan

Returns:

The scan report as JSON string.

getReportHtml

public void getReportHtml(OutputStream outstream)

Description copied from class: Scan

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

Specified by:

getReportHtml in class Scan

Parameters:

outstream - The OutputStream object to write the report.