com.synopsys.protecode.sc.jenkins.interfaces

Interface ProtecodeScApi

public interface ProtecodeScApi

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<HttpTypes.Meta>	abortScan(int scanId)
retrofit2.Call<HttpTypes.Meta>	deleteFiles(int scanId)
retrofit2.Call<HttpTypes.Meta>	deleteResult(int scanId)
retrofit2.Call<HttpTypes.Groups>	groups()
retrofit2.Call<HttpTypes.InfoLeak>	infoleak(int scanId)
retrofit2.Call<HttpTypes.UploadResponse>	poll(int scanId)
retrofit2.Call<HttpTypes.UploadResponse>	scan(String groupName, String filename, okhttp3.RequestBody bytes)
retrofit2.Call<HttpTypes.UploadResponse>	scanFetchFromUrl(Map<String,String> headers)
retrofit2.Call<HttpTypes.ScanResultResponse>	scanResult(String sha1sum)
retrofit2.Call<HttpTypes.Meta>	status()

Method Detail

scan

@PUT(value="/api/upload/{filename}")
retrofit2.Call<HttpTypes.UploadResponse> scan(@Header(value="Group")
                                                                                   String groupName,
                                                                                   @Path(value="filename")
                                                                                   String filename,
                                                                                   @Body
                                                                                   okhttp3.RequestBody bytes)

scanFetchFromUrl

@POST(value="/api/fetch/")
retrofit2.Call<HttpTypes.UploadResponse> scanFetchFromUrl(@HeaderMap
                                                                                     Map<String,String> headers)

poll

@GET(value="/api/product/{id}/")
retrofit2.Call<HttpTypes.UploadResponse> poll(@Path(value="id")
                                                                               int scanId)

scanResult

@GET(value="/api/product/{sha1sum}/")
retrofit2.Call<HttpTypes.ScanResultResponse> scanResult(@Path(value="sha1sum")
                                                                                              String sha1sum)

infoleak

@GET(value="/api/product/{id}/infoleak")
retrofit2.Call<HttpTypes.InfoLeak> infoleak(@Path(value="id")
                                                                                     int scanId)

deleteResult

@DELETE(value="/api/product/{id}")
retrofit2.Call<HttpTypes.Meta> deleteResult(@Path(value="id")
                                                                               int scanId)

deleteFiles

@DELETE(value="/api/product/{id}/remove")
retrofit2.Call<HttpTypes.Meta> deleteFiles(@Path(value="id")
                                                                                     int scanId)

abortScan

@POST(value="/api/product/{product_id}/abort")
retrofit2.Call<HttpTypes.Meta> abortScan(@Path(value="product_id")
                                                                                        int scanId)

status

@GET(value="/api/status/")
retrofit2.Call<HttpTypes.Meta> status()

groups

@GET(value="/api/groups/")
retrofit2.Call<HttpTypes.Groups> groups()