com.intland.jenkins.api

Class CodebeamerApiClient

java.lang.Object

com.intland.jenkins.api.CodebeamerApiClient

public class CodebeamerApiClient
extends Object

A service class that implement the data transfer between the codeBeamer and the jenkins plugin

Author:

abanfi

Constructor Summary

Constructors

Constructor and Description
CodebeamerApiClient(String uri, String username, String password)

Method Summary

Modifier and Type	Method and Description
String	encodeParam(String param) Encode URL parameters
TrackerItemDto	findOrCreateTestSet(ExecutionContext context, Integer trackerId, String name, String description) Finds the tracker item by name in the specified tracker.
List<TrackerItemDto>	getTestCaseList(ExecutionContext context) Get all tracker item from the specified tracker
TrackerDto	getTracker(Integer trackerId) Fetch the tracker for the specified tracker id
TrackerItemDto	getTrackerItem(Integer itemId) Fetch a tracker item from the codeBeamer by the specified id
boolean	isTestCaseTypeSupported(Integer testCaseTrackerId, String testCaseType) Checks specified test case tracker is support the given test case type or not
TrackerItemDto	postTrackerItem(ExecutionContext context, TestRunDto testRunDto) Post the specified tracker item to the codeBeamer
TrackerItemDto	put(ExecutionContext context, Object dto) Put (update) an existing item to the codeBeamer
TrackerItemDto	updateTestCaseStatus(ExecutionContext context, Integer id, String status) Updates the specified test case status

Methods inherited from class java.lang.Object

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

Constructor Detail

CodebeamerApiClient

public CodebeamerApiClient(String uri,
                           String username,
                           String password)

Method Detail

findOrCreateTestSet

public TrackerItemDto findOrCreateTestSet(ExecutionContext context,
                                          Integer trackerId,
                                          String name,
                                          String description)
                                   throws IOException

Finds the tracker item by name in the specified tracker. If it is not exists the it create with the specified parameters

Parameters:

trackerId - the item's tracker id

name - the tracker's name

description - the new item's description

Returns:

the found or the newly created tracker item

Throws:

IOException

encodeParam

public String encodeParam(String param)

Encode URL parameters

Parameters:

param - the parameter to encode

Returns:

the encoded parameter

postTrackerItem

public TrackerItemDto postTrackerItem(ExecutionContext context,
                                      TestRunDto testRunDto)
                               throws IOException

Post the specified tracker item to the codeBeamer

Parameters:

context -

testRunDto -

Returns:

Throws:

IOException

getTestCaseList

public List<TrackerItemDto> getTestCaseList(ExecutionContext context)
                                     throws IOException

Get all tracker item from the specified tracker

Parameters:

trackerId - the tracker's id

Returns:

all of the tracker item in the tracker

Throws:

IOException

isTestCaseTypeSupported

public boolean isTestCaseTypeSupported(Integer testCaseTrackerId,
                                       String testCaseType)
                                throws IOException

Checks specified test case tracker is support the given test case type or not

Parameters:

testCaseTrackerId -

testCaseType -

Returns:

Throws:

IOException

updateTestCaseStatus

public TrackerItemDto updateTestCaseStatus(ExecutionContext context,
                                           Integer id,
                                           String status)
                                    throws IOException

Updates the specified test case status

Parameters:

context - the execution context

id - the test case id to update

status - the new status

Returns:

the updated value

Throws:

IOException

getTrackerItem

public TrackerItemDto getTrackerItem(Integer itemId)
                              throws IOException

Fetch a tracker item from the codeBeamer by the specified id

Parameters:

itemId -

Returns:

Throws:

IOException

getTracker

public TrackerDto getTracker(Integer trackerId)
                      throws IOException

Fetch the tracker for the specified tracker id

Parameters:

trackerId -

Returns:

Throws:

IOException

put

public TrackerItemDto put(ExecutionContext context,
                          Object dto)
                   throws IOException

Put (update) an existing item to the codeBeamer

Parameters:

context -

dto -

Returns:

Throws:

IOException