de.irissmann.arachni.client.rest

Class ArachniRestClient

java.lang.Object

de.irissmann.arachni.client.rest.ArachniRestClient

All Implemented Interfaces:

ArachniClient

public class ArachniRestClient
extends Object
implements ArachniClient

Implementation that use the Arachni REST interface.

Since:

1.0.0

Author:

Ingo Rissmann

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH_SCANS

Method Summary

Modifier and Type	Method and Description
void	close() Depends on implementation the client close connections to Arachni Security Scanner.
List<String>	getScans() Returns a list with all scan id's.
Scan	performScan(ScanRequest scanRequest) Performs a new scan on the Arachni Rest Server and returns a Scan object.
Scan	performScan(ScanRequest scanRequest, String mergeString) Same as performScan(ScanRequest scanRequest) method but you can specify a Json string that will be merged into the request.

Methods inherited from class java.lang.Object

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

Field Detail

PATH_SCANS

public static final String PATH_SCANS

See Also:

Constant Field Values

Method Detail

performScan

public Scan performScan(ScanRequest scanRequest)

Description copied from interface: ArachniClient

Performs a new scan on the Arachni Rest Server and returns a Scan object. To start a new you have to create a ScanRequest first. Use the returned Scan object for further activities.

Specified by:

performScan in interface ArachniClient

Parameters:

scanRequest - Request with all information needed for the scan.

Returns:

A Scan object.

performScan

public Scan performScan(ScanRequest scanRequest,
                        String mergeString)

Description copied from interface: ArachniClient

Same as performScan(ScanRequest scanRequest) method but you can specify a Json string that will be merged into the request.

Specified by:

performScan in interface ArachniClient

Returns:

getScans

public List<String> getScans()

Description copied from interface: ArachniClient

Returns a list with all scan id's. This method can throw the runtime exception ArachniClientException.

Specified by:

getScans in interface ArachniClient

Returns:

List with all scan id's.

close

public void close()

Description copied from interface: ArachniClient

Depends on implementation the client close connections to Arachni Security Scanner. Use this careful because after calling this method the ArachniClient and all created Scan objects can not be used anymore.

Specified by:

close in interface ArachniClient