com.atlassian.applinks.host.spi
Interface HostApplication

All Known Subinterfaces:

InternalHostApplication

All Known Implementing Classes:

AbstractInternalHostApplication

public interface HostApplication

Injectable component interface that is implemented by the host application and contains the application specific logic to determine the application's capabilities.

Since:

3.0

Method Summary

java.net.URI	getBaseUrl()
ApplicationId	getId() Returns a globally unique identifier for this server.

Method Detail

getId

ApplicationId getId()

Returns a globally unique identifier for this server. If the host application has an Atlassian server ID, it can return that. Otherwise the application is responsible for generating a GUID itself and storing it, so that every call to this method always returns the same value.

To generate a GUID, consider UUID.

The returned string must use anything ONLY upper and lowercase characters, the digits [0-9] and dashes (-). There are no length requirements for the returned string.

Returns:

a globally unique identifier for this server that will never change.

getBaseUrl

java.net.URI getBaseUrl()

Returns:

the base URL for the application to be used when constructing links that are sent to clients, e.g. web browsers. The URI returned by this method must not have a trailing slash. e.g. "https://mydomain.com/jira"