Package com.checkmarx.ast.wrapper

Class CxWrapper

java.lang.Object

com.checkmarx.ast.wrapper.CxWrapper

public class CxWrapper
extends Object

Constructor Summary

Constructors

Constructor	Description
CxWrapper(@NonNull CxConfig cxConfig, @NonNull org.slf4j.Logger logger)
CxWrapper(CxConfig cxConfig)

Method Summary

Modifier and Type	Method	Description
String	authValidate()
List<String>	buildResultsArguments(@NonNull UUID scanId, ReportFormat reportFormat)
List<String>	buildScanCancelArguments(@NonNull UUID scanId)
List<String>	buildScanCreateArguments(@NonNull Map<String,String> params, String additionalParameters)
List<CodeBashing>	codeBashingList(@NonNull String cweId, @NonNull String language, @NonNull String queryName)
int	getResultsBfl(@NonNull UUID scanId, @NonNull String queryId, List<Node> resultNodes)
boolean	ideScansEnabled()
KicsRealtimeResults	kicsRealtimeScan(@NonNull String fileSources, String engine, String additionalParams)
KicsRemediation	kicsRemediate(@NonNull String resultsFile, String kicsFile, String engine, String similarityIds)
List<LearnMore>	learnMore(String queryId)
List<String>	projectBranches(@NonNull UUID projectId, String filter)
List<Project>	projectList()
List<Project>	projectList(String filter)
Project	projectShow(@NonNull UUID projectId)
Results	results(@NonNull UUID scanId)
String	results(@NonNull UUID scanId, ReportFormat reportFormat)
ResultsSummary	resultsSummary(@NonNull UUID scanId)
void	scanCancel(String scanId)
Scan	scanCreate(@NonNull Map<String,String> params)
Scan	scanCreate(@NonNull Map<String,String> params, String additionalParameters)
List<Scan>	scanList()
List<Scan>	scanList(String filter)
Scan	scanShow(@NonNull UUID scanId)
String	scaRemediation(String packageFiles, String packages, String packageVersion)
List<TenantSetting>	tenantSettings()
List<Predicate>	triageShow(@NonNull UUID projectId, String similarityId, String scanType)
void	triageUpdate(@NonNull UUID projectId, String similarityId, String scanType, String state, String comment, String severity)

Methods inherited from class java.lang.Object

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

Constructor Detail

CxWrapper

public CxWrapper(CxConfig cxConfig)
          throws IOException

Throws:

IOException

CxWrapper

public CxWrapper(@NonNull
                 @NonNull CxConfig cxConfig,
                 @NonNull
                 @NonNull org.slf4j.Logger logger)
          throws IOException

Throws:

IOException

Method Detail

authValidate

public String authValidate()
                    throws IOException,
                           InterruptedException,
                           CxException

Throws:

IOException

InterruptedException

CxException

scanShow

public Scan scanShow(@NonNull
                     @NonNull UUID scanId)
              throws IOException,
                     InterruptedException,
                     CxException

Throws:

IOException

InterruptedException

CxException

scanList

public List<Scan> scanList()
                    throws IOException,
                           InterruptedException,
                           CxException

Throws:

IOException

InterruptedException

CxException

scanList

public List<Scan> scanList(String filter)
                    throws IOException,
                           InterruptedException,
                           CxException

Throws:

IOException

InterruptedException

CxException

scanCreate

public Scan scanCreate(@NonNull
                       @NonNull Map<String,String> params)
                throws IOException,
                       InterruptedException,
                       CxException

Throws:

IOException

InterruptedException

CxException

scanCreate

public Scan scanCreate(@NonNull
                       @NonNull Map<String,String> params,
                       String additionalParameters)
                throws IOException,
                       InterruptedException,
                       CxException

Throws:

IOException

InterruptedException

CxException

buildScanCreateArguments

public List<String> buildScanCreateArguments(@NonNull
                                             @NonNull Map<String,String> params,
                                             String additionalParameters)

scanCancel

public void scanCancel(String scanId)
                throws IOException,
                       InterruptedException,
                       CxException

Throws:

IOException

InterruptedException

CxException

buildScanCancelArguments

public List<String> buildScanCancelArguments(@NonNull
                                             @NonNull UUID scanId)

triageShow

public List<Predicate> triageShow(@NonNull
                                  @NonNull UUID projectId,
                                  String similarityId,
                                  String scanType)
                           throws IOException,
                                  InterruptedException,
                                  CxException

Throws:

IOException

InterruptedException

CxException

triageUpdate

public void triageUpdate(@NonNull
                         @NonNull UUID projectId,
                         String similarityId,
                         String scanType,
                         String state,
                         String comment,
                         String severity)
                  throws IOException,
                         InterruptedException,
                         CxException

Throws:

IOException

InterruptedException

CxException

projectShow

public Project projectShow(@NonNull
                           @NonNull UUID projectId)
                    throws IOException,
                           InterruptedException,
                           CxException

Throws:

IOException

InterruptedException

CxException

projectList

public List<Project> projectList()
                          throws IOException,
                                 InterruptedException,
                                 CxException

Throws:

IOException

InterruptedException

CxException

projectList

public List<Project> projectList(String filter)
                          throws IOException,
                                 InterruptedException,
                                 CxException

Throws:

IOException

InterruptedException

CxException

projectBranches

public List<String> projectBranches(@NonNull
                                    @NonNull UUID projectId,
                                    String filter)
                             throws CxException,
                                    IOException,
                                    InterruptedException

Throws:

CxException

IOException

InterruptedException

codeBashingList

public List<CodeBashing> codeBashingList(@NonNull
                                         @NonNull String cweId,
                                         @NonNull
                                         @NonNull String language,
                                         @NonNull
                                         @NonNull String queryName)
                                  throws IOException,
                                         InterruptedException,
                                         CxException

Throws:

IOException

InterruptedException

CxException

resultsSummary

public ResultsSummary resultsSummary(@NonNull
                                     @NonNull UUID scanId)
                              throws IOException,
                                     InterruptedException,
                                     CxException

Throws:

IOException

InterruptedException

CxException

results

public Results results(@NonNull
                       @NonNull UUID scanId)
                throws IOException,
                       InterruptedException,
                       CxException

Throws:

IOException

InterruptedException

CxException

results

public String results(@NonNull
                      @NonNull UUID scanId,
                      ReportFormat reportFormat)
               throws IOException,
                      InterruptedException,
                      CxException

Throws:

IOException

InterruptedException

CxException

scaRemediation

public String scaRemediation(String packageFiles,
                             String packages,
                             String packageVersion)
                      throws CxException,
                             IOException,
                             InterruptedException

Throws:

CxException

IOException

InterruptedException

getResultsBfl

public int getResultsBfl(@NonNull
                         @NonNull UUID scanId,
                         @NonNull
                         @NonNull String queryId,
                         List<Node> resultNodes)
                  throws IOException,
                         InterruptedException,
                         CxException

Throws:

IOException

InterruptedException

CxException

kicsRealtimeScan

public KicsRealtimeResults kicsRealtimeScan(@NonNull
                                            @NonNull String fileSources,
                                            String engine,
                                            String additionalParams)
                                     throws IOException,
                                            InterruptedException,
                                            CxException

Throws:

IOException

InterruptedException

CxException

kicsRemediate

public KicsRemediation kicsRemediate(@NonNull
                                     @NonNull String resultsFile,
                                     String kicsFile,
                                     String engine,
                                     String similarityIds)
                              throws IOException,
                                     InterruptedException,
                                     CxException

Throws:

IOException

InterruptedException

CxException

learnMore

public List<LearnMore> learnMore(String queryId)
                          throws CxException,
                                 IOException,
                                 InterruptedException

Throws:

CxException

IOException

InterruptedException

ideScansEnabled

public boolean ideScansEnabled()
                        throws CxException,
                               IOException,
                               InterruptedException

Throws:

CxException

IOException

InterruptedException

tenantSettings

public List<TenantSetting> tenantSettings()
                                   throws CxException,
                                          IOException,
                                          InterruptedException

Throws:

CxException

IOException

InterruptedException

buildResultsArguments

public List<String> buildResultsArguments(@NonNull
                                          @NonNull UUID scanId,
                                          ReportFormat reportFormat)