com.ca.devtest.jenkins.plugin.util

Class Utils

java.lang.Object

com.ca.devtest.jenkins.plugin.util.Utils

public class Utils
extends Object

Utils class providing helping methods.

Author:

jakro01

Method Summary

Modifier and Type	Method and Description
static void	checkRegistryEndpoint(DefaultBuildStep buildstep) Checks Registry endpoint values for empty or null values.
static String	createBasicAuthHeader(String username, String password) Creates authorization header for basic security.
static hudson.util.FormValidation	doCheckHost(hudson.model.Item context, boolean useCustomRegistry, String host, String port, String tokenCredentialId) Helping method for checking custom Registry endpoint input.
static List<String>	getFilesMatchingWildcard(String wildcard, String startDir) Retrieves list of file paths matching the wildcard.
static List<String>	getFilesMatchingWildcardList(List<String> marFilesWildcards, String workspace) Retrieves list of file paths matching the list of wildcards.
static com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials	lookupCredentials(hudson.model.Item context, String credentialId) Resolves jenkins credentials by id.
static String	resolveParameter(String parameter, hudson.model.Run<?,?> run, hudson.model.TaskListener listener) Resolves single Jenkins parameter from build based on job environment.
static List<String>	resolveParameters(List<String> parameters, hudson.model.Run<?,?> run, hudson.model.TaskListener listener) Resolves Jenkins parameters from build based on job environment and returns them as List containing resolved parameters or original value.

Methods inherited from class java.lang.Object

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

Method Detail

createBasicAuthHeader

public static String createBasicAuthHeader(String username,
                                           String password)
                                    throws UnsupportedEncodingException

Creates authorization header for basic security.

Parameters:

username - username

password - password

Returns:

header value

Throws:

UnsupportedEncodingException - when encoding failed

doCheckHost

public static hudson.util.FormValidation doCheckHost(@AncestorInPath
                                                     hudson.model.Item context,
                                                     boolean useCustomRegistry,
                                                     String host,
                                                     String port,
                                                     String tokenCredentialId)

Helping method for checking custom Registry endpoint input.

Parameters:

useCustomRegistry - if custom Registry endpoint should be used

host - host to Registry

port - port to Registry

tokenCredentialId - credentials token id

Returns:

form validation

checkRegistryEndpoint

public static void checkRegistryEndpoint(DefaultBuildStep buildstep)
                                  throws hudson.AbortException

Checks Registry endpoint values for empty or null values.

Parameters:

buildstep - build step that extend DefaultBuildStep

Throws:

hudson.AbortException - if some required fields are null

resolveParameters

public static List<String> resolveParameters(List<String> parameters,
                                             hudson.model.Run<?,?> run,
                                             hudson.model.TaskListener listener)
                                      throws IOException,
                                             InterruptedException

Resolves Jenkins parameters from build based on job environment and returns them as List containing resolved parameters or original value. Pattern for parameters in Jenkins is either $parameter or ${parameter}.

Parameters:

parameters - list of parameters

run - specific jenkins job run

listener - listener of the same job run

Returns:

list containing resolved parameters

Throws:

IOException - when there is a problem of getting build environment

InterruptedException - interrupted exception

resolveParameter

public static String resolveParameter(String parameter,
                                      hudson.model.Run<?,?> run,
                                      hudson.model.TaskListener listener)
                               throws IOException,
                                      InterruptedException

Resolves single Jenkins parameter from build based on job environment. Pattern for parameters in Jenkins is either $parameter or ${parameter}.

Parameters:

parameter - parameter

run - specific jenkins job run

listener - listener of the same job run

Returns:

String resolved parameters

Throws:

IOException - when there is a problem of getting build environment

InterruptedException - interrupted exception

lookupCredentials

public static com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials lookupCredentials(@AncestorInPath
                                                                                                             hudson.model.Item context,
                                                                                                             String credentialId)

Resolves jenkins credentials by id.

Parameters:

credentialId - id

Returns:

credentials object else if credentialId is null then it return null

getFilesMatchingWildcardList

public static List<String> getFilesMatchingWildcardList(List<String> marFilesWildcards,
                                                        String workspace)
                                                 throws hudson.AbortException

Retrieves list of file paths matching the list of wildcards.

Parameters:

marFilesWildcards - wildcards

workspace - project workspace path

Returns:

list of file paths matching list of wildcards

Throws:

hudson.AbortException - if there are no files matching wildcard

getFilesMatchingWildcard

public static List<String> getFilesMatchingWildcard(String wildcard,
                                                    String startDir)
                                             throws hudson.AbortException

Retrieves list of file paths matching the wildcard.

Parameters:

wildcard - wildcard

startDir - search root folder path

Returns:

list of file paths

Throws:

hudson.AbortException - if there are no files matching wildcard