org.jenkinsci.plugins.ParameterizedRemoteTrigger.utils

Class HttpHelper

java.lang.Object

org.jenkinsci.plugins.ParameterizedRemoteTrigger.utils.HttpHelper

public class HttpHelper
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	HTTP_GET
static String	HTTP_POST

Constructor Summary

Constructors

Constructor and Description
HttpHelper()

Method Summary

Modifier and Type	Method and Description
static String	buildTriggerUrl(String jobNameOrUrl, String securityToken, boolean isRemoteJobParameterized, BuildContext context) Build the proper URL to trigger the remote build All passed in string have already had their tokens replaced with real values.
static String	buildUrlQueryString(Map<String,String> parameters) Return the Collection<String> in an encoded query-string.
static String	encodeValue(String dirtyValue) Helper function for character encoding
protected static String	generateJobUrl(RemoteJenkinsServer remoteServer, String jobNameOrUrl)
static ConnectionResponse	get(String urlString, BuildContext context, int readTimeout, int pollInterval, int retryLimit, Auth2 overrideAuth)
static String	getRawResp(String urlString, String requestType, BuildContext context, Collection<String> postParams, int readTimeout, int numberOfAttempts, int pollInterval, int retryLimit, Auth2 overrideAuth)
static ConnectionResponse	post(String urlString, BuildContext context, Map<String,String> params, int readTimeout, int pollInterval, int retryLimit, Auth2 overrideAuth, boolean isCrubmCacheEnabled)
static ConnectionResponse	tryGet(String urlString, BuildContext context, int readTimeout, int pollInterval, int retryLimit, Auth2 overrideAuth, Semaphore lock)
static String	tryGetRawResp(String urlString, BuildContext context, int readTimeout, int pollInterval, int retryLimit, Auth2 overrideAuth, Semaphore lock)
static ConnectionResponse	tryPost(String urlString, BuildContext context, Map<String,String> params, int readTimeout, int pollInterval, int retryLimit, Auth2 overrideAuth, Semaphore lock, boolean isCrubmCacheEnabled)

Methods inherited from class java.lang.Object

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

Field Detail

HTTP_GET

public static final String HTTP_GET

See Also:

Constant Field Values

HTTP_POST

public static final String HTTP_POST

See Also:

Constant Field Values

Constructor Detail

HttpHelper

public HttpHelper()

Method Detail

buildUrlQueryString

public static String buildUrlQueryString(@NonNull
                                         Map<String,String> parameters)

Return the Collection<String> in an encoded query-string.

Parameters:

parameters - the parameters needed to trigger the remote job.

Returns:

query-parameter-formated URL-encoded string.

generateJobUrl

protected static String generateJobUrl(RemoteJenkinsServer remoteServer,
                                       String jobNameOrUrl)
                                throws AbortException

Throws:

AbortException

encodeValue

public static String encodeValue(String dirtyValue)

Helper function for character encoding

Parameters:

dirtyValue - something that wasn't encoded in UTF-8

Returns:

encoded value

buildTriggerUrl

public static String buildTriggerUrl(String jobNameOrUrl,
                                     String securityToken,
                                     boolean isRemoteJobParameterized,
                                     BuildContext context)
                              throws IOException

Build the proper URL to trigger the remote build All passed in string have already had their tokens replaced with real values. All 'params' also have the proper character encoding

Parameters:

jobNameOrUrl - Name of the remote job

securityToken - Security token used to trigger remote job

isRemoteJobParameterized - Is the remote job parameterized

context - The build context used in this plugin

Returns:

fully formed, fully qualified remote trigger URL

Throws:

IOException - throw when it can't pass data checking

tryPost

public static ConnectionResponse tryPost(String urlString,
                                         BuildContext context,
                                         Map<String,String> params,
                                         int readTimeout,
                                         int pollInterval,
                                         int retryLimit,
                                         Auth2 overrideAuth,
                                         Semaphore lock,
                                         boolean isCrubmCacheEnabled)
                                  throws IOException,
                                         InterruptedException

Throws:

IOException

InterruptedException

tryGet

public static ConnectionResponse tryGet(String urlString,
                                        BuildContext context,
                                        int readTimeout,
                                        int pollInterval,
                                        int retryLimit,
                                        Auth2 overrideAuth,
                                        Semaphore lock)
                                 throws IOException,
                                        InterruptedException

Throws:

IOException

InterruptedException

tryGetRawResp

public static String tryGetRawResp(String urlString,
                                   BuildContext context,
                                   int readTimeout,
                                   int pollInterval,
                                   int retryLimit,
                                   Auth2 overrideAuth,
                                   Semaphore lock)
                            throws IOException,
                                   InterruptedException

Throws:

IOException

InterruptedException

post

public static ConnectionResponse post(String urlString,
                                      BuildContext context,
                                      Map<String,String> params,
                                      int readTimeout,
                                      int pollInterval,
                                      int retryLimit,
                                      Auth2 overrideAuth,
                                      boolean isCrubmCacheEnabled)
                               throws IOException,
                                      InterruptedException

Throws:

IOException

InterruptedException

get

public static ConnectionResponse get(String urlString,
                                     BuildContext context,
                                     int readTimeout,
                                     int pollInterval,
                                     int retryLimit,
                                     Auth2 overrideAuth)
                              throws IOException,
                                     InterruptedException

Throws:

IOException

InterruptedException

getRawResp

public static String getRawResp(String urlString,
                                String requestType,
                                BuildContext context,
                                Collection<String> postParams,
                                int readTimeout,
                                int numberOfAttempts,
                                int pollInterval,
                                int retryLimit,
                                Auth2 overrideAuth)
                         throws IOException,
                                InterruptedException

Throws:

IOException

InterruptedException