com.atlassian.applinks.spi

Interface Manifest

public interface Manifest

Describes the capabilities of a remote application. A remote application can be another Atlassian app running AppLinks 3 or higher, or something else entirely (a subversion repo, a Google docs domain, etc).

Since:

3.0

Method Summary

Modifier and Type	Method and Description
org.osgi.framework.Version	getAppLinksVersion() Get the version of AppLinks running on the remote application.
Long	getBuildNumber() Get the build number of the remote application.
URI	getIconUri() Get a larger icon URI of the remote application
URI	getIconUrl() Deprecated.
ApplicationId	getId() Get the ID of this server.
Set<Class<? extends AuthenticationProvider>>	getInboundAuthenticationTypes() Get the inbound authentication types that this remote application supports.
String	getName() Get the name of this server.
Set<Class<? extends AuthenticationProvider>>	getOutboundAuthenticationTypes() Get the outbound authentication types that this remote application supports.
TypeId	getTypeId() Get the type ID of the application this manifest is for.
URI	getUrl() Get the URL of the remote application
String	getVersion() The version of the application.
Boolean	hasPublicSignup() Whether the remote application supports public sign up.

Method Detail

getId

ApplicationId getId()

Get the ID of this server.

Returns:

the globally unique, immutable ID of this server.

getName

String getName()

Get the name of this server. This should be the configured name of the instance of the remote application, or if the remote application is a static service, then the name of the service. For example, "My JIRA Instance".

Returns:

The name of the remote application.

getTypeId

TypeId getTypeId()

Get the type ID of the application this manifest is for.

Returns:

The type ID of the application this manifest is for.

getVersion

@Nullable
String getVersion()

The version of the application. Note that version strings formatting is not standardised. Although Atlassian applications tend to use "major.minor.micro", there can also be non-numeric components (e.g. "2.4-M2", "2.4.1.beta4", etc).

Returns:

the version of the application. Can return null.

getBuildNumber

Long getBuildNumber()

Get the build number of the remote application. Can return null.

Returns:

The build number of the application.

getUrl

URI getUrl()

Get the URL of the remote application

Returns:

The URL.

getIconUrl

@Deprecated
 @Nullable
URI getIconUrl()

Deprecated.

Get the icon URL of the remote application

Returns:

The icon URL.

getIconUri

@Nullable
URI getIconUri()

Get a larger icon URI of the remote application

Returns:

The icon URI.

getAppLinksVersion

@Nullable
org.osgi.framework.Version getAppLinksVersion()

Get the version of AppLinks running on the remote application.

Returns:

the version of the applinks bundle installed in the remote application, or null if the remote application is not an applinks 3.0+ container

getInboundAuthenticationTypes

Set<Class<? extends AuthenticationProvider>> getInboundAuthenticationTypes()

Get the inbound authentication types that this remote application supports. The inbound authentication types are the authentication types that the remote application can use to authenticate requests that it receives.

Returns:

The set of authentication types

getOutboundAuthenticationTypes

Set<Class<? extends AuthenticationProvider>> getOutboundAuthenticationTypes()

Get the outbound authentication types that this remote application supports. The outbound authentication types are the authentication types that this remote application can use to authenticate requests that it sends.

Returns:

The set of authentication types

hasPublicSignup

Boolean hasPublicSignup()

Whether the remote application supports public sign up.

Returns:

True if the remote application supports public sign up.