com.synopsys.protecode.sc.jenkins

Class ProtecodeScService

java.lang.Object

com.synopsys.protecode.sc.jenkins.ProtecodeScService

public class ProtecodeScService
extends Object

This class implements and encapsulates the interface towards BDBA. As a service class it won't know what it's calling, so the backend must be provided for it.

Constructor Summary

Constructors

Constructor and Description
ProtecodeScService(String credentialsId, URL host, hudson.model.Run<?,?> run, boolean checkCertificate) The implementation of the BDBA backend

Method Summary

Modifier and Type	Method and Description
ConnectionStatus	connectionOk() Test the connection with a HEAD call.
void	groups(Listeners.GroupService listener) Fetch groups for a user
void	poll(Integer scanId, Listeners.PollService listener)
void	scan(String group, String fileName, okhttp3.RequestBody requestBody, Listeners.ScanService listener)
void	scanFetchFromUrl(String group, String url, Map<String,String> headers, Listeners.ScanService listener)
void	scanResult(String sha1sum, Listeners.ResultService listener)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtecodeScService

public ProtecodeScService(String credentialsId,
                          URL host,
                          hudson.model.Run<?,?> run,
                          boolean checkCertificate)

The implementation of the BDBA backend

Parameters:

credentialsId - the id of the chosen credentials. This is used when the connection is built.

host - Host URL for BDBA instance

run - The Jenkins Run instance to be used (for accessing credentials)

checkCertificate - whether to check certificate or not

Method Detail

scan

public void scan(String group,
                 String fileName,
                 okhttp3.RequestBody requestBody,
                 Listeners.ScanService listener)

scanFetchFromUrl

public void scanFetchFromUrl(String group,
                             String url,
                             Map<String,String> headers,
                             Listeners.ScanService listener)

poll

public void poll(Integer scanId,
                 Listeners.PollService listener)

scanResult

public void scanResult(String sha1sum,
                       Listeners.ResultService listener)

connectionOk

public ConnectionStatus connectionOk()

Test the connection with a HEAD call.

Returns:

ConnectionStatus object for the current connection.

groups

public void groups(Listeners.GroupService listener)

Fetch groups for a user

Parameters:

listener - GroupService instance to handle responses