io.jenkins.plugins.uleska.scan

Class HttpScanApi

java.lang.Object

io.jenkins.plugins.uleska.api.BaseHttpApi

io.jenkins.plugins.uleska.scan.HttpScanApi

All Implemented Interfaces:

ScanApi, AutoCloseable

public class HttpScanApi
extends BaseHttpApi
implements ScanApi

Field Summary

Fields inherited from class io.jenkins.plugins.uleska.api.BaseHttpApi

apiKey, host, httpFactory, taskListener

Constructor Summary

Constructors

Constructor and Description
HttpScanApi(TaskListener taskListener, HttpFactory httpFactory, String host, char[] apiKey)

Method Summary

Modifier and Type	Method and Description
void	doScan(UUID applicationId, UUID versionId) Scans an application/version with the tools in that application/version
void	doScan(UUID applicationId, UUID versionId, UUID toolkitId) Scans an application/version with the tools in the toolkit

Methods inherited from class io.jenkins.plugins.uleska.api.BaseHttpApi

close, convertJsonToObject, doHttpGet

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.AutoCloseable

close

Constructor Detail

HttpScanApi

public HttpScanApi(TaskListener taskListener,
                   HttpFactory httpFactory,
                   String host,
                   char[] apiKey)

Method Detail

doScan

public void doScan(UUID applicationId,
                   UUID versionId)
            throws ScanException

Description copied from interface: ScanApi

Scans an application/version with the tools in that application/version

Specified by:

doScan in interface ScanApi

Parameters:

applicationId - The id of the application being scanned

versionId - The id of the version being scanned

Throws:

ScanException - if something goes wrong making a scanning request

doScan

public void doScan(UUID applicationId,
                   UUID versionId,
                   UUID toolkitId)
            throws ScanException

Description copied from interface: ScanApi

Scans an application/version with the tools in the toolkit

Specified by:

doScan in interface ScanApi

Parameters:

applicationId - The id of the application being scanned

versionId - The id of the version being scanned

toolkitId - The id of the toolkit

Throws:

ScanException - if something goes wrong making a scanning request