Package com.atlassian.jira.util

Class DefaultBaseUrl

java.lang.Object

com.atlassian.jira.util.DefaultBaseUrl

All Implemented Interfaces:

BaseUrl

public class DefaultBaseUrl
extends Object
implements BaseUrl

Since:

v5.2

Constructor Summary

Constructors

Constructor	Description
DefaultBaseUrl(VelocityRequestContextFactory factory)

Method Summary

Modifier and Type	Method	Description
URI	getBaseUri()
String	getBaseUrl()
String	getCanonicalBaseUrl()
URI	resolveAddress(String relative)	Resolve the given relative path against the base URI.
<I, O> O	runWithStaticBaseUrl(I input, com.google.common.base.Function<I,O> runnable)	Run the passed function in an environment where JIRA's configured baseURL is always used.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultBaseUrl

public DefaultBaseUrl(VelocityRequestContextFactory factory)

Method Details

getBaseUrl

@Nonnull
public String getBaseUrl()

Specified by:

getBaseUrl in interface BaseUrl

Returns:

The base URL for this instance, also known as the context path. If running in the context of a web request, this will return a url relative to the server root (ie "/jira/"). If running via email, it will return an absolute URL (eg. "http://example.com/jira"). In both cases URL does not contain trailing "/" character.

getCanonicalBaseUrl

@Nonnull
public String getCanonicalBaseUrl()

Specified by:

getCanonicalBaseUrl in interface BaseUrl

Returns:

The canonical base URL for this instance. It will return an absolute URL (eg. "http://example.com/jira"). This URL does not contain trailing "/" character.

getBaseUri

public URI getBaseUri()

Specified by:

getBaseUri in interface BaseUrl

Returns:

The absolute base URI for this instance. It will contain trailing "/" character (eg. "http://example.com/jira/") as opposed to BaseUrl.getCanonicalBaseUrl()

resolveAddress

@Nonnull
public URI resolveAddress(@Nonnull
 String relative)

Description copied from interface: BaseUrl

Resolve the given relative path against the base URI.

Specified by:

resolveAddress in interface BaseUrl

Parameters:

relative - the path to be resolved

Returns:

absolute URI

runWithStaticBaseUrl

@Nullable
public <I,
O> O runWithStaticBaseUrl(@Nullable
 I input,
 @Nonnull
 com.google.common.base.Function<I,O> runnable)

Description copied from interface: BaseUrl

Run the passed function in an environment where JIRA's configured baseURL is always used. This basically makes the passed function ignore any smart baseURL that can be generated from the request associated with the calling thread.

Specified by:

runWithStaticBaseUrl in interface BaseUrl

Parameters:

input - input to pass to the function.

runnable - the function to execute.

Returns:

the result of the function.