com.offbytwo.jenkins.client.util

Class UrlUtils

java.lang.Object

com.offbytwo.jenkins.client.util.UrlUtils

public final class UrlUtils
extends Object

Utility class for manipulating API paths.

Author:

Dell Green

Method Summary

Modifier and Type	Method and Description
static String	join(String path1, String path2) Join two paths together taking into account leading/trailing slashes.
static String	toBaseUrl(FolderJob folder) Helper to create a base url in case a folder is given
static String	toFullJobPath(String jobName) Parses the provided job name for folders to get the full path for the job.
static String	toJobBaseUrl(FolderJob folder, String jobName) Helper to create the base url for a job, with or without a given folder
static URI	toJsonApiUri(URI uri, String context, String path) Create a JSON URI from the supplied parameters.
static URI	toNoApiUri(URI uri, String context, String path) Create a URI from the supplied parameters.
static String	toViewBaseUrl(FolderJob folder, String name) Helper to create the base url for a view, with or without a given folder

Methods inherited from class java.lang.Object

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

Method Detail

toBaseUrl

public static String toBaseUrl(FolderJob folder)

Helper to create a base url in case a folder is given

Parameters:

folder - the folder or null

Returns:

The created base url.

toJobBaseUrl

public static String toJobBaseUrl(FolderJob folder,
                                  String jobName)

Helper to create the base url for a job, with or without a given folder

Parameters:

folder - the folder or null

jobName - the name of the job.

Returns:

converted base url.

toViewBaseUrl

public static String toViewBaseUrl(FolderJob folder,
                                   String name)

Helper to create the base url for a view, with or without a given folder

Parameters:

folder - the folder or null

name - the of the view.

Returns:

converted view url.

toFullJobPath

public static String toFullJobPath(String jobName)

Parses the provided job name for folders to get the full path for the job.

Parameters:

jobName - the fullName of the job.

Returns:

the path of the job including folders if present.

join

public static String join(String path1,
                          String path2)

Join two paths together taking into account leading/trailing slashes.

Parameters:

path1 - the first path

path2 - the second path

Returns:

the joins path

toJsonApiUri

public static URI toJsonApiUri(URI uri,
                               String context,
                               String path)

Create a JSON URI from the supplied parameters.

Parameters:

uri - the server URI

context - the server context if any

path - the specific API path

Returns:

new full URI instance

toNoApiUri

public static URI toNoApiUri(URI uri,
                             String context,
                             String path)

Create a URI from the supplied parameters.

Parameters:

uri - the server URI

context - the server context if any

path - the specific API path

Returns:

new full URI instance