jenkins.internal

Class ClientRequest

java.lang.Object

jenkins.internal.ClientRequest

public class ClientRequest
extends Object

REST Api calls to EXAM

Constructor Summary

Constructors

Constructor and Description
ClientRequest(PrintStream logger, int apiPort, Launcher launcher) Constructor for REST Api calls to EXAM

Method Summary

Modifier and Type	Method and Description
void	clearWorkspace(String projectName) Deletes the project configuration at EXAM and deletes the corresponding report and pcode folders
boolean	connectClient(Executor executor, int timeout) try to connect to EXAM REST Server within a timeout
void	convert(String reportProject) Request the Api Version from EXAM Client
void	createExamProject(ModelConfiguration modelConfiguration) Creates a Exam Project on the Client.
void	disconnectClient(Executor executor, int timeout) Try to disconnect from EXAM Client
void	executeGoovyScript(GroovyConfiguration groovyConfiguration) Executes a Groovy Script at the Exam Client.
void	generateTestcases(GenerateConfiguration generateConfiguration) Generates Testcases with the TCG at the Exam Client.
int	getApiPort()
ApiVersion	getApiVersion() Request the Api Version from EXAM Client
PrintStream	getLogger()
ExamStatus	getStatus() Request the job xxecution status from EXAM Client
boolean	isApiAvailable() Checks, if the EXAM Client ist responding
boolean	isClientConnected()
void	setApiPort(int apiPort)
void	setLogger(PrintStream logger)
void	setTestrunFilter(FilterConfiguration filterConfig) Setting the EXAM Client
void	startTestrun(TestConfiguration testConfig) Configure and start testrun at EXAM Client
void	stopTestrun() stops a testrun
void	waitForExamIdle(Executor executor, int wait) Waits until EXAM is idle
void	waitForExportPDFReportJob(Executor executor, int wait) Waits until EXAM is idle
void	waitForTestrunEnds(Executor executor, int wait) Waits for the EXAM Testrun ends

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientRequest

public ClientRequest(PrintStream logger,
                     int apiPort,
                     Launcher launcher)

Constructor for REST Api calls to EXAM

Parameters:

logger - PrintStream

apiPort - Port

launcher - Launcher

Method Detail

isClientConnected

public boolean isClientConnected()

getApiPort

public int getApiPort()

setApiPort

public void setApiPort(int apiPort)

getLogger

public PrintStream getLogger()

setLogger

public void setLogger(PrintStream logger)

getStatus

@Nullable
public ExamStatus getStatus()
                                throws IOException,
                                       InterruptedException

Request the job xxecution status from EXAM Client

Returns:

ExamStatus

Throws:

InterruptedException - InterruptedException

IOException - IOException

getApiVersion

@Nullable
public ApiVersion getApiVersion()
                                    throws IOException,
                                           InterruptedException

Request the Api Version from EXAM Client

Returns:

ApiVersion

Throws:

InterruptedException - InterruptedException

IOException - IOException

isApiAvailable

public boolean isApiAvailable()
                       throws IOException,
                              InterruptedException

Checks, if the EXAM Client ist responding

Returns:

true, is available

Throws:

IOException - IOException

InterruptedException - InterruptedException

createExamProject

public void createExamProject(ModelConfiguration modelConfiguration)
                       throws IOException,
                              InterruptedException

Creates a Exam Project on the Client.

Parameters:

modelConfiguration - ModelConfiguration

Throws:

IOException - IOException

InterruptedException - InterruptedException

setTestrunFilter

public void setTestrunFilter(FilterConfiguration filterConfig)
                      throws IOException,
                             AbortException,
                             InterruptedException

Setting the EXAM Client

Parameters:

filterConfig - FilterConfiguration

Throws:

AbortException - AbortException

InterruptedException - InterruptedException

IOException - IOException

convert

public void convert(String reportProject)
             throws IOException,
                    InterruptedException

Request the Api Version from EXAM Client

Parameters:

reportProject - String

Throws:

InterruptedException - InterruptedException

IOException - IOException

startTestrun

public void startTestrun(TestConfiguration testConfig)
                  throws IOException,
                         InterruptedException

Configure and start testrun at EXAM Client

Parameters:

testConfig - TestConfiguration

Throws:

IOException - IOException

InterruptedException - InterruptedException

executeGoovyScript

public void executeGoovyScript(GroovyConfiguration groovyConfiguration)
                        throws IOException,
                               InterruptedException

Executes a Groovy Script at the Exam Client.

Parameters:

groovyConfiguration - GroovyConfiguration

Throws:

IOException - IOException

InterruptedException - InterruptedException

generateTestcases

public void generateTestcases(GenerateConfiguration generateConfiguration)
                       throws IOException,
                              InterruptedException

Generates Testcases with the TCG at the Exam Client.

Parameters:

generateConfiguration - GenerateConfiguration

Throws:

IOException - IOException

InterruptedException - InterruptedException

stopTestrun

public void stopTestrun()
                 throws IOException,
                        InterruptedException

stops a testrun

Throws:

IOException - IOException

InterruptedException - InterruptedException

clearWorkspace

public void clearWorkspace(String projectName)
                    throws IOException,
                           InterruptedException

Deletes the project configuration at EXAM and deletes the corresponding report and pcode folders

Parameters:

projectName - String

Throws:

IOException - IOException

InterruptedException - InterruptedException

connectClient

public boolean connectClient(Executor executor,
                             int timeout)
                      throws IOException,
                             InterruptedException

try to connect to EXAM REST Server within a timeout

Parameters:

executor - Executor

timeout - millis

Returns:

true, if connected

Throws:

IOException - IOException

InterruptedException - InterruptedException

disconnectClient

public void disconnectClient(Executor executor,
                             int timeout)
                      throws IOException,
                             InterruptedException

Try to disconnect from EXAM Client

Parameters:

executor - Executor

timeout - millis

Throws:

IOException - IOException

InterruptedException - InterruptedException

waitForTestrunEnds

public void waitForTestrunEnds(Executor executor,
                               int wait)
                        throws IOException,
                               InterruptedException

Waits for the EXAM Testrun ends

Parameters:

executor - Executor

wait - time in s

Throws:

IOException - IOException

InterruptedException - InterruptedException

waitForExamIdle

public void waitForExamIdle(Executor executor,
                            int wait)
                     throws IOException,
                            InterruptedException

Waits until EXAM is idle

Parameters:

executor - Executor

wait - time in s

Throws:

IOException - IOException

InterruptedException - InterruptedException

waitForExportPDFReportJob

public void waitForExportPDFReportJob(Executor executor,
                                      int wait)
                               throws IOException,
                                      InterruptedException

Waits until EXAM is idle

Parameters:

executor - Executor

wait - time in s

Throws:

IOException - IOException

InterruptedException - InterruptedException