com.atlassian.bamboo.util

Class UrlUtils

java.lang.Object

com.atlassian.bamboo.util.UrlUtils

public class UrlUtils
extends Object

Method Summary

Modifier and Type	Method and Description
static String	appendSlashIfDoesntExist(String theString) Checks whether or not the given string has a '/' character as the last character, and appends one if it doesn't
static String	constructBaseUrl(javax.servlet.http.HttpServletRequest request) Attempts to construct a baseUrl using the HttpServletRequest object.
static String	correctlyFormatUrl(String host)
static URL	createUrl(String url)
static URL	createUrl(String context, String formActionDestination)
static com.google.common.collect.Multimap<String,String>	extractQueryParams(String url)
static com.google.common.collect.Multimap<String,String>	extractQueryParams(URI uri)
static com.google.common.collect.Multimap<String,String>	extractQueryParams(URL url)
static String	extractSingleQueryParam(String url, String paramName)
static String	extractSingleQueryParam(URL url, String paramName)
static String	getPathUnderContext(String url, String context) Deprecated. since 6.3, use UrlUtils.getPathUnderContext(java.lang.String, java.lang.String)
static boolean	hasXssRelatedCharacters(String string)
static boolean	isSameOrigin(URL url, URL origin)
static String	prependSlashIfDoesntExist(String theString) Checks whether or not the given string has a '/' character as the first character, and puts one in if it doesn't
static String	replaceOrInsertParamValue(String queryString, String newParamValue)
static String	replacePlanResultKeyInUrl(String url, PlanKey planKey, int newBuildNumber)
static String	sanitizeUri(String uri) Removes XSS related characters from URI: backslash, double and single quotes, angle brackets.
static String	stripLeadingSlashes(String toStrip) Strips any leading '/' characters off the front of the string, if any.
static String	stripTailingSlashes(String toStrip) Strips any leading '/' characters off the end of the string, if any.

Methods inherited from class java.lang.Object

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

Method Detail

sanitizeUri

@NotNull
public static String sanitizeUri(@NotNull
                                          String uri)

Removes XSS related characters from URI: backslash, double and single quotes, angle brackets.

Parameters:

uri -

Returns:

replaceOrInsertParamValue

@Nullable
public static String replaceOrInsertParamValue(String queryString,
                                                         String newParamValue)

replacePlanResultKeyInUrl

public static String replacePlanResultKeyInUrl(String url,
                                               PlanKey planKey,
                                               int newBuildNumber)

correctlyFormatUrl

public static String correctlyFormatUrl(String host)

stripLeadingSlashes

@NotNull
public static String stripLeadingSlashes(@Nullable
                                                  String toStrip)

Strips any leading '/' characters off the front of the string, if any.

Parameters:

toStrip - - the string to strip

Returns:

the string without the leading '/' characters

stripTailingSlashes

@NotNull
public static String stripTailingSlashes(@Nullable
                                                  String toStrip)

Strips any leading '/' characters off the end of the string, if any.

Parameters:

toStrip - - the string to strip

Returns:

the string without the end '/' characters

appendSlashIfDoesntExist

@NotNull
public static String appendSlashIfDoesntExist(@Nullable
                                                       String theString)

Checks whether or not the given string has a '/' character as the last character, and appends one if it doesn't

Parameters:

theString - to check and append.

Returns:

the original string with the extra '/' if required.

prependSlashIfDoesntExist

@NotNull
public static String prependSlashIfDoesntExist(@Nullable
                                                        String theString)

Checks whether or not the given string has a '/' character as the first character, and puts one in if it doesn't

Parameters:

theString - to check and prepend.

Returns:

the original string with the extra '/' if required.

getPathUnderContext

@Deprecated
public static String getPathUnderContext(@NotNull
                                                     String url,
                                                     @NotNull
                                                     String context)

Deprecated. since 6.3, use UrlUtils.getPathUnderContext(java.lang.String, java.lang.String)

Given an URL which may: - include scheme,host and optionally port - start directly with context - start with an arbitrary path under a context this method returns the path under context. It should not be used for security purposes, because it operates on best effort basis - including returning the URL without modifications if context is not found .

See Also:

for context description

extractQueryParams

@NotNull
public static com.google.common.collect.Multimap<String,String> extractQueryParams(@NotNull
                                                                                            URL url)

extractQueryParams

@NotNull
public static com.google.common.collect.Multimap<String,String> extractQueryParams(@NotNull
                                                                                            String url)

extractQueryParams

@NotNull
public static com.google.common.collect.Multimap<String,String> extractQueryParams(@NotNull
                                                                                            URI uri)

extractSingleQueryParam

@Nullable
public static String extractSingleQueryParam(@NotNull
                                                       URL url,
                                                       @NotNull
                                                       String paramName)

extractSingleQueryParam

@Nullable
public static String extractSingleQueryParam(@NotNull
                                                       String url,
                                                       @NotNull
                                                       String paramName)

isSameOrigin

public static boolean isSameOrigin(@NotNull
                                   URL url,
                                   @NotNull
                                   URL origin)

Parameters:

url - the url to check

origin - the origin to check against.

Returns:

true if the given url is the same origin as the given origin url otherwise returns false.

createUrl

@NotNull
public static URL createUrl(@NotNull
                                     String url)

createUrl

@NotNull
public static URL createUrl(@NotNull
                                     String context,
                                     @NotNull
                                     String formActionDestination)

constructBaseUrl

public static String constructBaseUrl(javax.servlet.http.HttpServletRequest request)

Attempts to construct a baseUrl using the HttpServletRequest object.

Parameters:

request - The incoming http request

Returns:

a string containing the absolute base URL

hasXssRelatedCharacters

public static boolean hasXssRelatedCharacters(@Nullable
                                              String string)