com.atlassian.sal.api

Interface ApplicationProperties

public interface ApplicationProperties

Component for looking up application properties specific to their web interface

Since:

2.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	PLATFORM_BAMBOO
static String	PLATFORM_CONFLUENCE
static String	PLATFORM_CROWD
static String	PLATFORM_FECRU
static String	PLATFORM_JIRA
static String	PLATFORM_STASH

Method Summary

Methods

Modifier and Type	Method and Description
String	getBaseUrl() Deprecated. since 2.10. This implementation is application-specific, and unreliable for a cross product plugin. Use getBaseUrl(UrlMode) instead.
String	getBaseUrl(UrlMode urlMode) Get the base URL of the current application, with respect to the given UrlMode.
Date	getBuildDate()
String	getBuildNumber()
String	getDisplayName() Returns the display name for this application.
File	getHomeDirectory()
String	getPlatformId() Returns the exact ID of this application/platform, as defined in HAMS and used for licensing purposes.
String	getPropertyValue(String key) Deprecated. As of SAL 2.7.
String	getVersion()

Field Detail

PLATFORM_JIRA

static final String PLATFORM_JIRA

See Also:

Constant Field Values

PLATFORM_CONFLUENCE

static final String PLATFORM_CONFLUENCE

See Also:

Constant Field Values

PLATFORM_BAMBOO

static final String PLATFORM_BAMBOO

See Also:

Constant Field Values

PLATFORM_CROWD

static final String PLATFORM_CROWD

See Also:

Constant Field Values

PLATFORM_FECRU

static final String PLATFORM_FECRU

See Also:

Constant Field Values

PLATFORM_STASH

static final String PLATFORM_STASH

See Also:

Constant Field Values

Method Detail

getBaseUrl

@Deprecated
String getBaseUrl()

Deprecated. since 2.10. This implementation is application-specific, and unreliable for a cross product plugin. Use getBaseUrl(UrlMode) instead.

Get the base URL of the current application.

Returns:

the current application's base URL

getBaseUrl

@Nonnull
String getBaseUrl(UrlMode urlMode)

Get the base URL of the current application, with respect to the given UrlMode. This varies as follows:

• If UrlMode.CANONICAL return the configured base URL.
• If UrlMode.ABSOLUTE return either the base URL of a request in the current scope, or the configured base URL if there is no such request.
• If UrlMode.RELATIVE return either the context path of a request in the current scope, or the configured context path if there is no such request.
• If UrlMode.RELATIVE_CANONICAL return the configured context path.
• If UrlMode.AUTO return either a relative URL if there is a request in the current scope, or the canonical URL if there is no such request.

Parameters:

urlMode - the UrlMode to use.

Returns:

the current application's base URL.

getDisplayName

@Nonnull
String getDisplayName()

Returns the display name for this application.

Returns:

the displayable name of the application

See Also:

getPlatformId()

getPlatformId

@Nonnull
String getPlatformId()

Returns the exact ID of this application/platform, as defined in HAMS and used for licensing purposes.

Return values include:

• PLATFORM_JIRA
• PLATFORM_CONFLUENCE
• PLATFORM_BAMBOO
• PLATFORM_CROWD
• PLATFORM_FECRU
• PLATFORM_STASH

Fisheye / Crucible is a snowflake in that they have two separate licenses with two separate application IDs ("fisheye" and "crucible"). For the purposes of having a single ID for the platform, FeCru will return "fisheye" (PLATFORM_FECRU) from this method.

Returns:

the ID of this application/platform

Since:

3.0

See Also:

getDisplayName()

getVersion

@Nonnull
String getVersion()

Returns:

the version of the application

getBuildDate

@Nonnull
Date getBuildDate()

Returns:

the build date of the application

getBuildNumber

@Nonnull
String getBuildNumber()

Returns:

the build number of the application, must be parsable by Long.parseLong(String)

getHomeDirectory

@Nullable
File getHomeDirectory()

Returns:

the home directory of the application or null if none is defined

getPropertyValue

@Deprecated
String getPropertyValue(String key)

Deprecated. As of SAL 2.7.

Get the value of an application property by its key.

Parameters:

key - The Key of the property to retrieve.

Returns:

The value of the property or Null if the property does not exist