Package io.jenkins.plugins.servicenow.api

Class ServiceNowAPIClient

java.lang.Object

io.jenkins.plugins.servicenow.api.ServiceNowAPIClient

public class ServiceNowAPIClient
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ServiceNowAPIClient.AcceptResponseType

Field Summary

Fields

Modifier and Type	Field	Description
ServiceNowAPIClient.AcceptResponseType	acceptResponseType

Constructor Summary

Constructors

Constructor	Description
ServiceNowAPIClient(String url, String username, Secret password)

Method Summary

Modifier and Type	Method	Description
Result	activatePlugin(String pluginId)
Result	applyChanges(String applicationScope, String systemId, String branchName)
Result	batchInstall(String payload)
Result	batchInstall(String batchName, String packages, String notes)
Result	batchRollback(String rollbackId)
Result	checkProgress()
Result	executeFullScan()
Result	executePointScan(String targetTable, String targetSysId)	Execute Point Scan (with progress flow).
Result	executeScanWithCombo(String comboSysId)
Result	executeScanWithSuiteOnScopedApps(String suiteSysId, String requestBody)
Result	executeScanWithSuiteOnUpdateSet(String suiteSysId, String requestBody)
String	getCurrentAppCustomizationVersion(String applicationScope, String systemId)
String	getCurrentAppVersion(String applicationScope, String systemId)
String	getLastActionProgressUrl()
Result	getTestSuiteResults(String resultsId)
Result	installApp(String applicationScope, String applicationSysId, String applicationVersion)
Result	installApp(String applicationScope, String applicationSysId, String applicationVersion, String baseAppVersion, Boolean autoUpgradeBaseApp)
Result	publishApp(String applicationScope, String applicationSysId, String applicationVersion, String devNotes)
Result	rollbackApp(String applicationScope, String applicationSysId, String rollbackVersion)
Result	rollbackPlugin(String pluginId)
Result	runTestSuite(String testSuiteName, String testSuiteSysId, String osName, String osVersion, String browserName, String browserVersion)

Methods inherited from class java.lang.Object

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

Field Detail

acceptResponseType

public ServiceNowAPIClient.AcceptResponseType acceptResponseType

Constructor Detail

ServiceNowAPIClient

public ServiceNowAPIClient(String url,
                           String username,
                           Secret password)

Parameters:

url - URL of the ServiceNow API

username - User name used to authorize requests

password - User password used for request authorization

Method Detail

getLastActionProgressUrl

public String getLastActionProgressUrl()

applyChanges

public Result applyChanges(String applicationScope,
                           String systemId,
                           String branchName)
                    throws IOException,
                           URISyntaxException

Throws:

IOException

URISyntaxException

runTestSuite

public Result runTestSuite(String testSuiteName,
                           String testSuiteSysId,
                           String osName,
                           String osVersion,
                           String browserName,
                           String browserVersion)
                    throws IOException,
                           URISyntaxException

Throws:

IOException

URISyntaxException

checkProgress

public Result checkProgress()

getTestSuiteResults

public Result getTestSuiteResults(String resultsId)

publishApp

public Result publishApp(String applicationScope,
                         String applicationSysId,
                         String applicationVersion,
                         String devNotes)
                  throws IOException,
                         URISyntaxException

Throws:

IOException

URISyntaxException

installApp

public Result installApp(String applicationScope,
                         String applicationSysId,
                         String applicationVersion)
                  throws IOException,
                         URISyntaxException

Throws:

IOException

URISyntaxException

installApp

public Result installApp(String applicationScope,
                         String applicationSysId,
                         String applicationVersion,
                         String baseAppVersion,
                         Boolean autoUpgradeBaseApp)
                  throws IOException,
                         URISyntaxException

Throws:

IOException

URISyntaxException

rollbackApp

public Result rollbackApp(String applicationScope,
                          String applicationSysId,
                          String rollbackVersion)
                   throws IOException,
                          URISyntaxException

Throws:

IOException

URISyntaxException

activatePlugin

public Result activatePlugin(String pluginId)
                      throws IOException,
                             URISyntaxException

Throws:

IOException

URISyntaxException

rollbackPlugin

public Result rollbackPlugin(String pluginId)
                      throws IOException,
                             URISyntaxException

Throws:

IOException

URISyntaxException

getCurrentAppVersion

public String getCurrentAppVersion(String applicationScope,
                                   String systemId)

getCurrentAppCustomizationVersion

public String getCurrentAppCustomizationVersion(String applicationScope,
                                                String systemId)

executeFullScan

public Result executeFullScan()
                       throws IOException,
                              URISyntaxException

Throws:

IOException

URISyntaxException

executePointScan

public Result executePointScan(String targetTable,
                               String targetSysId)
                        throws IOException,
                               URISyntaxException

Execute Point Scan (with progress flow).

Parameters:

targetTable - Target table to be scanned.

targetSysId - Target record to be scanned.

Returns:

Results with a link to follow the progress of the scan.

Throws:

IOException

URISyntaxException

executeScanWithCombo

public Result executeScanWithCombo(String comboSysId)
                            throws IOException,
                                   URISyntaxException

Throws:

IOException

URISyntaxException

executeScanWithSuiteOnScopedApps

public Result executeScanWithSuiteOnScopedApps(String suiteSysId,
                                               String requestBody)
                                        throws IOException,
                                               URISyntaxException

Throws:

IOException

URISyntaxException

executeScanWithSuiteOnUpdateSet

public Result executeScanWithSuiteOnUpdateSet(String suiteSysId,
                                              String requestBody)
                                       throws IOException,
                                              URISyntaxException

Throws:

IOException

URISyntaxException

batchInstall

public Result batchInstall(String payload)
                    throws IOException,
                           URISyntaxException

Throws:

IOException

URISyntaxException

batchInstall

public Result batchInstall(String batchName,
                           String packages,
                           String notes)
                    throws IOException,
                           URISyntaxException

Throws:

IOException

URISyntaxException

batchRollback

public Result batchRollback(String rollbackId)
                     throws IOException,
                            URISyntaxException

Throws:

IOException

URISyntaxException