com.atlassian.sal.api
Interface ApplicationProperties

public interface ApplicationProperties

Component for looking up application properties specific to their web interface

Since:

2.0

Method Summary

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()
File	getHomeDirectory()
String	getPropertyValue(String key) Deprecated. As of SAL 2.7.
String	getVersion()

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

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

String getDisplayName()

Returns:

the displayable name of the application

getVersion

String getVersion()

Returns:

the version of the application

getBuildDate

Date getBuildDate()

Returns:

the build date of the application

getBuildNumber

String getBuildNumber()

Returns:

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

getHomeDirectory

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