com.atlassian.applinks.spi.manifest

Interface ManifestRetriever

public interface ManifestRetriever

Since:

3.0

Method Summary

Modifier and Type	Method and Description
ApplicationStatus	getApplicationStatus(URI uri, ApplicationType type)
Manifest	getManifest(URI uri)
Manifest	getManifest(URI uri, ApplicationType type)

Method Detail

getManifest

Manifest getManifest(URI uri)
              throws ManifestNotFoundException

Parameters:

uri - the base url of the application to retrieve a Manifest from

Returns:

the Manifest of the remote application, will never return null

Throws:

ManifestNotFoundException - if the remote application did not provide a manifest for any reason (e.g. remote server was down, remote server does not support UAL, REST end-point is disabled in the remote server etc.)

getManifest

Manifest getManifest(URI uri,
                     ApplicationType type)
              throws ManifestNotFoundException

Parameters:

uri - the base url of the application to retrieve a Manifest from

type - the type of the target application - this application type's ManifestProducer specified by it's plugin descriptor will be used to retrieve/generate a suitable manifest

Returns:

the Manifest of the remote application, will never return null

Throws:

ManifestNotFoundException - if the remote application did not provide a manifest for any reason (e.g. remote server was down, remote server does not support UAL, REST end-point is disabled in the remote server etc.)

See Also:

ManifestProducer.getManifest(URI)

getApplicationStatus

ApplicationStatus getApplicationStatus(URI uri,
                                       ApplicationType type)

Parameters:

uri - the base url of the application to retrieve ApplicationStatus from

type - the type of the target application - this application type's ManifestProducer specified by it's plugin descriptor will be used to retrieve/generate the ApplicationStatus object

Returns:

the current state of the application located at the specified base url

See Also:

ManifestProducer.getStatus(URI)