com.compuware.ispw.restapi.util

Class RestApiUtils

java.lang.Object

com.compuware.ispw.restapi.util.RestApiUtils

public class RestApiUtils
extends Object

Utilities for ISPW operations plug-in

Author:

Sam Zhou

Constructor Summary

Constructors

Constructor and Description
RestApiUtils()

Method Summary

Modifier and Type	Method and Description
static void	assertNotNull(PrintStream logger, Object object, String message) Assert not null, if null, abort Jenkins job
static void	assertNotNull(PrintStream logger, Object object, String message, Object... args) Assert not null, abort Jenkins job
static hudson.util.ListBoxModel	buildConnectionIdItems(jenkins.model.Jenkins context, String connectionId, hudson.model.Item project)
static hudson.util.ListBoxModel	buildCredentialsIdItems(jenkins.model.Jenkins context, String credentialsId, hudson.model.Item project)
static hudson.util.ListBoxModel	buildIspwActionItems(jenkins.model.Jenkins context, String ispwAction, hudson.model.Item project)
static String	cleanContextPath(String contextPath) Clean up the context path and replace unused query parameters
static boolean	containsIgnoreCase(List<String> tokens, String anotherToken)
static ProgramList	convertSetInfoResp(SetInfoResponse setInfoResp) Convert SetInfoResponse object to a ProgramList object
static String	fixCesContainerListResponseJson(String responseJson)
static String	fixCesTaskListResponseJson(String responseJson)
static String	fixWorkListResponseJson(String responseJson)
static com.cloudbees.plugins.credentials.common.StandardCredentials	getCesCredentials(String credentialsId, hudson.model.Item item)
static String	getCesToken(String credentialsId, hudson.model.Item item)
static String	getCesUrl(String connectionId, PrintStream logger)
static com.compuware.jenkins.common.configuration.HostConnection	getHostConnection(String connectionId) Get the host connection
static String	getIspwHostLabel(String connectionId)
static String	getRuntimeConfig(String ispwRequestBody) Get runtime configuration from request body
static String	getSystemProperty(String key)
static ArrayList<String>	getVariables(String s) Find all variables that match variable name
static boolean	isIspwDebugMode()
static String	join(String delimiter, String[] stringArray, boolean appendEqualSign)
static List<String>	listAllParams(String contextPath) List all parameters in the contextPath based on pairs of {}
static List<String>	listQueryParams(String contextPath) Found out what is the query parameter names based on pairs of {}
static boolean	logMessageIfAny(PrintStream logger, ResponseContentSupplier response, boolean isError)
static String	maskToken(String token)
static BasicAuthentication	toBasicAuthentication(String flat)
static ArrayList<HttpHeader>	toHttpHeaders(String flat)

Methods inherited from class java.lang.Object

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

Constructor Detail

RestApiUtils

public RestApiUtils()

Method Detail

join

public static String join(String delimiter,
                          String[] stringArray,
                          boolean appendEqualSign)

toHttpHeaders

public static ArrayList<HttpHeader> toHttpHeaders(String flat)

toBasicAuthentication

public static BasicAuthentication toBasicAuthentication(String flat)

containsIgnoreCase

public static boolean containsIgnoreCase(List<String> tokens,
                                         String anotherToken)

fixCesTaskListResponseJson

public static String fixCesTaskListResponseJson(String responseJson)

fixCesContainerListResponseJson

public static String fixCesContainerListResponseJson(String responseJson)

fixWorkListResponseJson

public static String fixWorkListResponseJson(String responseJson)

buildConnectionIdItems

public static hudson.util.ListBoxModel buildConnectionIdItems(@AncestorInPath
                                                              jenkins.model.Jenkins context,
                                                              @QueryParameter
                                                              String connectionId,
                                                              @AncestorInPath
                                                              hudson.model.Item project)

getHostConnection

public static com.compuware.jenkins.common.configuration.HostConnection getHostConnection(String connectionId)

Get the host connection

Parameters:

connectionId - The connection ID

Returns:

The host connection or a null object

getCesUrl

public static String getCesUrl(String connectionId,
                               PrintStream logger)
                        throws hudson.AbortException

Throws:

hudson.AbortException

getIspwHostLabel

public static String getIspwHostLabel(String connectionId)

getCesToken

public static String getCesToken(String credentialsId,
                                 hudson.model.Item item)

getCesCredentials

public static com.cloudbees.plugins.credentials.common.StandardCredentials getCesCredentials(String credentialsId,
                                                                                             hudson.model.Item item)

buildCredentialsIdItems

public static hudson.util.ListBoxModel buildCredentialsIdItems(@AncestorInPath
                                                               jenkins.model.Jenkins context,
                                                               @QueryParameter
                                                               String credentialsId,
                                                               @AncestorInPath
                                                               hudson.model.Item project)

buildIspwActionItems

public static hudson.util.ListBoxModel buildIspwActionItems(@AncestorInPath
                                                            jenkins.model.Jenkins context,
                                                            @QueryParameter
                                                            String ispwAction,
                                                            @AncestorInPath
                                                            hudson.model.Item project)

maskToken

public static String maskToken(String token)

logMessageIfAny

public static boolean logMessageIfAny(PrintStream logger,
                                      ResponseContentSupplier response,
                                      boolean isError)

getSystemProperty

public static String getSystemProperty(String key)

isIspwDebugMode

public static boolean isIspwDebugMode()

assertNotNull

public static void assertNotNull(PrintStream logger,
                                 Object object,
                                 String message,
                                 Object... args)
                          throws hudson.AbortException

Assert not null, abort Jenkins job

Parameters:

logger - the Jenkins log

object - the object to be tested

message - the debug message

args - the debug message arguments

Throws:

hudson.AbortException - abort exception if null

assertNotNull

public static void assertNotNull(PrintStream logger,
                                 Object object,
                                 String message)
                          throws hudson.AbortException

Assert not null, if null, abort Jenkins job

Parameters:

logger - the Jenkins log

object - the object to be tested

message - debug message if null

Throws:

hudson.AbortException - abort exception if null

listAllParams

public static List<String> listAllParams(String contextPath)

List all parameters in the contextPath based on pairs of {}

Parameters:

contextPath - the context path

Returns:

array of all parameters

listQueryParams

public static List<String> listQueryParams(String contextPath)

Found out what is the query parameter names based on pairs of {}

Parameters:

contextPath - the context path

Returns:

array of query parameter names

cleanContextPath

public static String cleanContextPath(String contextPath)

Clean up the context path and replace unused query parameters

Parameters:

contextPath - the context path

Returns:

context path that is ready for submit

getVariables

public static ArrayList<String> getVariables(String s)

Find all variables that match variable name

Parameters:

s - the string to extract the variables from

Returns:

array list of variables

convertSetInfoResp

public static ProgramList convertSetInfoResp(SetInfoResponse setInfoResp)

Convert SetInfoResponse object to a ProgramList object

Parameters:

setInfoResp - the SetInfoResponse object

Returns:

a ProgramList object

getRuntimeConfig

public static String getRuntimeConfig(String ispwRequestBody)

Get runtime configuration from request body

Parameters:

ispwRequestBody - the request body

Returns:

runtime configuration