Package io.jenkins.plugins.octanesuitegatebyembiti.repositories

Class OctaneClient

java.lang.Object

io.jenkins.plugins.octanesuitegatebyembiti.repositories.OctaneClient

All Implemented Interfaces:

AutoCloseable

public class OctaneClient
extends Object
implements AutoCloseable

Constructor Summary

Constructors

Constructor	Description
OctaneClient(String baseUrl, String clientId, Secret clientSecret)
OctaneClient(HttpClient httpClient, String baseUrl, String clientId, Secret clientSecret)

Method Summary

Modifier and Type	Method	Description
void	authenticate()
void	close()
Map<String,List<RunRecord>>	fetchAvailableSuiteChildRuns(String sharedSpaceId, String workspaceId, List<String> suiteRunIds)	Fetches all currently reachable suites while omitting suite runs confirmed as missing.
List<DefectRecord>	fetchDefectsByIds(String sharedSpaceId, String workspaceId, List<String> defectIds, int maxDefects)
List<DefectRecord>	fetchLinkedDefects(String sharedSpaceId, String workspaceId, Map<String,List<RunRecord>> suiteRuns, String defectQuery, int maxDefects)
List<RunRecord>	fetchScopedRuns(String sharedSpaceId, String workspaceId, List<String> runIds, String scopeQuery)
List<String>	fetchSuiteChildRunIds(String sharedSpaceId, String workspaceId, String suiteRunId)
List<RunRecord>	fetchSuiteChildRuns(String sharedSpaceId, String workspaceId, String suiteRunId)
Map<String,List<RunRecord>>	fetchSuiteChildRuns(String sharedSpaceId, String workspaceId, List<String> suiteRunIds)
List<String>	fetchSuiteRunIdsByReleaseAndSprint(String sharedSpaceId, String workspaceId, String releaseName, String sprintName)	Resolves suite runs assigned to the named release and, when supplied, sprint.
int	testWorkspaceAccess(String sharedSpaceId, String workspaceId)
static OctaneClient	withCredentials(String baseUrl, String clientId, Secret clientSecret)
static OctaneClient	withCredentials(String baseUrl, String clientId, Secret clientSecret, boolean secretBaseUrl)

Methods inherited from class java.lang.Object

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

Constructor Details

OctaneClient

public OctaneClient(String baseUrl,
 String clientId,
 Secret clientSecret)

OctaneClient

public OctaneClient(HttpClient httpClient,
 String baseUrl,
 String clientId,
 Secret clientSecret)

Method Details

withCredentials

public static OctaneClient withCredentials(String baseUrl,
 String clientId,
 Secret clientSecret)

withCredentials

public static OctaneClient withCredentials(String baseUrl,
 String clientId,
 Secret clientSecret,
 boolean secretBaseUrl)

authenticate

public void authenticate()
                  throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

fetchSuiteChildRuns

public List<RunRecord> fetchSuiteChildRuns(String sharedSpaceId,
 String workspaceId,
 String suiteRunId)
                                    throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

fetchSuiteChildRuns

public Map<String,List<RunRecord>> fetchSuiteChildRuns(String sharedSpaceId,
 String workspaceId,
 List<String> suiteRunIds)
                                                throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

fetchAvailableSuiteChildRuns

public Map<String,List<RunRecord>> fetchAvailableSuiteChildRuns(String sharedSpaceId,
 String workspaceId,
 List<String> suiteRunIds)
                                                         throws IOException,
InterruptedException

Fetches all currently reachable suites while omitting suite runs confirmed as missing.

Throws:

IOException

InterruptedException

fetchSuiteRunIdsByReleaseAndSprint

public List<String> fetchSuiteRunIdsByReleaseAndSprint(String sharedSpaceId,
 String workspaceId,
 String releaseName,
 String sprintName)
                                                throws IOException,
InterruptedException

Resolves suite runs assigned to the named release and, when supplied, sprint.

Throws:

IOException

InterruptedException

fetchScopedRuns

public List<RunRecord> fetchScopedRuns(String sharedSpaceId,
 String workspaceId,
 List<String> runIds,
 String scopeQuery)
                                throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

fetchSuiteChildRunIds

public List<String> fetchSuiteChildRunIds(String sharedSpaceId,
 String workspaceId,
 String suiteRunId)
                                   throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

fetchLinkedDefects

public List<DefectRecord> fetchLinkedDefects(String sharedSpaceId,
 String workspaceId,
 Map<String,List<RunRecord>> suiteRuns,
 String defectQuery,
 int maxDefects)
                                      throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

fetchDefectsByIds

public List<DefectRecord> fetchDefectsByIds(String sharedSpaceId,
 String workspaceId,
 List<String> defectIds,
 int maxDefects)
                                     throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

testWorkspaceAccess

public int testWorkspaceAccess(String sharedSpaceId,
 String workspaceId)
                        throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException