io.jenkins.tools.pluginmanager.util

Class PluginManagerUtils

java.lang.Object

io.jenkins.tools.pluginmanager.util.PluginManagerUtils

public final class PluginManagerUtils
extends Object

Method Summary

Modifier and Type	Method and Description
static String	appendPathOntoUrl(Object urlString, Object... pathSection) Convert object arguments to strings and pass through to the String-ish method to append the path section onto the base URL string
static String	appendPathOntoUrl(String urlString, String... pathSection) Given two strings, concatenate with a single slash at the point they are joined.
static String	dirName(Object urlString) Convert object arguments to strings and pass through to the String-ish method to remove the last part of the path from a URL
static String	dirName(String urlString) Extract the leading part of the URL up to but not including the last section (usually a filename).
static String	removePath(Object urlString) Convert object arguments to strings and pass through to the String-ish method to remove the entire path part from a URL
static String	removePath(String urlString) Remove the path part of a url, if present.
static String	removePossibleWrapperText(String urlText) Given text loaded from a Jenkins update center, extract just the json content. Jenkins update centers have meta-data in json form in a file "update-center.json" and, in the case of updates.jenkins.io, another file "update-center.actual.json".

Methods inherited from class java.lang.Object

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

Method Detail

appendPathOntoUrl

public static String appendPathOntoUrl(Object urlString,
                                       Object... pathSection)

Convert object arguments to strings and pass through to the String-ish method to append the path section onto the base URL string

Parameters:

urlString - the first part of a URL as an Object that will be "toString()"ed. (e.g. result of toString() is http://example.com) Trailing slashes are removed as appropriate. This could be, for example, a URL object.

pathSection - the next parts of a URL to be appended one after another to the first part. (e.g. path/to/file.json) Leading and trailing slashes are removed as appropriate. Pass in one or more Objects for which a call to toString() will return the usable String object.

Returns:

the two parts concatenated with one slash at the point they are joined.

See Also:

appendPathOntoUrl(String, String...)

appendPathOntoUrl

public static String appendPathOntoUrl(String urlString,
                                       String... pathSection)

Given two strings, concatenate with a single slash at the point they are joined. Additional trailing and leading slashes at that point will be adjusted so only one remains. If the first one ends in '://', it is preserved.

Parameters:

urlString - the first part of a URL. (e.g. http://example.com) Trailing slashes are removed as appropriate.

pathSection - the next parts of a URL to be appended one after another to the first part. (e.g. path/to/file.json) Leading and trailing slashes are removed as appropriate.

Returns:

the two parts concatenated with one slash at the point they are joined.

removePossibleWrapperText

public static String removePossibleWrapperText(String urlText)

Given text loaded from a Jenkins update center, extract just the json content.
Jenkins update centers have meta-data in json form in a file "update-center.json" and, in the case of updates.jenkins.io, another file "update-center.actual.json". The former file has wrapper text surrounding the json content. The latter file has no wrapper and is totally json. This method checks for the wrapper and removes it if found.
Historically the wrapper is said to allow easier display of the json in browsers. The text to remove is "updateCenter.post( ...json here... );" with all json content inside.

Parameters:

urlText - text loaded from "update-center.json" or "update-center.actual.json"

Returns:

the supplied text with any present wrapper removed

dirName

public static String dirName(Object urlString)

Convert object arguments to strings and pass through to the String-ish method to remove the last part of the path from a URL

Parameters:

urlString - an Object for which toString produces a string containing a url from which to remove the trailing section. The domain name and port section (that follows the double slash) will not be removed. This could be, for example, a URL object.

Returns:

the supplied string without the section after the last slash.

See Also:

dirName(String)

dirName

public static String dirName(String urlString)

Extract the leading part of the URL up to but not including the last section (usually a filename). The domain name and port section (that follows the double slash) will not be removed. Parts in the URL are separated by slashes. If there is no slash in the string, the string is returned unchanged.

Parameters:

urlString - a string containing a url from which to remove the trailing section.

Returns:

the supplied string without the section after the last slash.

removePath

public static String removePath(Object urlString)

Convert object arguments to strings and pass through to the String-ish method to remove the entire path part from a URL

Parameters:

urlString - an Object for which toString() will be called to produce a string containing a url from which to remove the entire path. This could be, for example, a URL object.

Returns:

the string with no path. Only protocol, full domain name and port will remain.

See Also:

removePath(String)

removePath

public static String removePath(String urlString)

Remove the path part of a url, if present. For example, http://example.com/other/path/file.json will end up as http://example.com without the path and filename portion.

Parameters:

urlString - a string containing a url from which to remove the path

Returns:

the string with no path. Only protocol, full domain name and port will remain.