com.atlassian.bamboo.utils
Class BambooUrl

java.lang.Object
  com.atlassian.bamboo.utils.BambooUrl

public class BambooUrl
extends Object

Encapsulates creation of redirect URLs.

Constructor Summary

BambooUrl(AdministrationConfiguration administrationConfiguration)
Deprecated. since 5.0 use BambooUrl(AdministrationConfigurationAccessor)

BambooUrl(AdministrationConfigurationAccessor administrationConfigurationAccessor)

Method Summary

String	getBaseUrl() Deprecated. since 5.6
String	getBaseUrl(com.atlassian.sal.api.UrlMode urlMode)
static String	getCurrentPathAndQuery()
String	rootContext()
String	withBaseUrlFromConfiguration() This URL should be used for storage or when a user other than the current one will use it.
String	withBaseUrlFromConfiguration(String path) This URL should be used for storage or when a user other than the current one will use it.
String	withBaseUrlFromRequest() This URL should be used when redirecting to Bamboo instance from external applications within the same user session.
String	withBaseUrlFromRequest(String path) This URL should be used when redirecting to Bamboo instance from external applications within the same user session.
String	withRelativeUrl() This URL should be used when redirecting internally within Bamboo instance

Methods inherited from class java.lang.Object

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

Constructor Detail

BambooUrl

public BambooUrl(AdministrationConfigurationAccessor administrationConfigurationAccessor)

BambooUrl

@Deprecated
public BambooUrl(AdministrationConfiguration administrationConfiguration)

Deprecated. since 5.0 use BambooUrl(AdministrationConfigurationAccessor)

Parameters:

administrationConfiguration -

Method Detail

withBaseUrlFromConfiguration

public String withBaseUrlFromConfiguration()

This URL should be used for storage or when a user other than the current one will use it.

Returns:

current absolute URL with base taken from configuration with the current path and query appended to it.

withBaseUrlFromConfiguration

@NotNull
public String withBaseUrlFromConfiguration(@NotNull
                                                   String path)

This URL should be used for storage or when a user other than the current one will use it.

Returns:

current absolute URL with base taken from configuration with the provided path appended to it.

withRelativeUrl

@NotNull
public String withRelativeUrl()

This URL should be used when redirecting internally within Bamboo instance

Returns:

path and query from the current Request

withBaseUrlFromRequest

@NotNull
public String withBaseUrlFromRequest()

This URL should be used when redirecting to Bamboo instance from external applications within the same user session. Example: login dance.

Returns:

base url, path and query from the current Request

withBaseUrlFromRequest

@NotNull
public String withBaseUrlFromRequest(@NotNull
                                             String path)

This URL should be used when redirecting to Bamboo instance from external applications within the same user session. Example: login dance.

Returns:

base urlfrom the current Request with supplied path appended to it

getCurrentPathAndQuery

@NotNull
public static String getCurrentPathAndQuery()

Returns:

the current path and query from request

Throws:

IllegalStateException - if HttpServletRequest is not present

rootContext

public String rootContext()

getBaseUrl

@Deprecated
public String getBaseUrl()

Deprecated. since 5.6

getBaseUrl

public String getBaseUrl(com.atlassian.sal.api.UrlMode urlMode)