com.atlassian.upm.application.marketplace

Interface ApplicationMarketplaceQueries

All Known Implementing Classes:

ApplicationMarketplaceQueriesImpl

public interface ApplicationMarketplaceQueries

Encapsulates the Marketplace client used by upm-application-plugin and the default queries we make with it.

Method Summary

Modifier and Type	Method and Description
MarketplaceResult<Iterable<AppUpdateInfo>>	getAppUpdateInfo(int targetPlatformBuildNumber, Iterable<com.atlassian.application.api.Application> installedApps) Query Marketplace for available updates to installed applications.
MarketplaceResult<Iterable<com.atlassian.marketplace.client.model.Product>>	getAvailableAppsInfo(boolean withPlatform, io.atlassian.fugue.Option<Integer> platformBuildNumber) Get listings for available applications from Marketplace.
io.atlassian.fugue.Option<com.atlassian.marketplace.client.model.ProductVersion>	getMpacVersionInfoForInstalledApp(com.atlassian.application.api.Application app) Query Marketplace to get the version info for the provided application
MarketplaceResult<Map<String,com.atlassian.marketplace.client.model.ProductVersion>>	getMpacVersionInfoForInstalledApps(Iterable<com.atlassian.application.api.Application> apps) Query Marketplace to get version info for the provided applications if found
PlatformVersionInfo	getPlatformVersionInfo() Get information about the current installed platform version and whether it is known to Marketplace.
io.atlassian.fugue.Option<com.atlassian.marketplace.client.model.Product>	getProductWithLatestVersion(String applicationKey) Query Marketplace for the listing of the specified application.

Method Detail

getAvailableAppsInfo

MarketplaceResult<Iterable<com.atlassian.marketplace.client.model.Product>> getAvailableAppsInfo(boolean withPlatform,
                                                                                                 io.atlassian.fugue.Option<Integer> platformBuildNumber)

Get listings for available applications from Marketplace. If we already know that Marketplace is disabled or unavailable, then no query is done and it returns a "disabled" or "unreachable" MarketplaceResult instead of a list. If we know that Marketplace is available but that we won't be able to query for compatibility with the current platform, because the current platform version is unknown to Marketplace, then it returns an empty list.

Parameters:

withPlatform - true if the results should include the platform

platformBuildNumber - Some(N) to query only applications that are compatible with platform build number N; None to query applications that are compatible with the current installed platform version

Returns:

a MarketplaceResult whose value is a list of product representations; each of these contains a single product version representation that is the compatible version

getAppUpdateInfo

MarketplaceResult<Iterable<AppUpdateInfo>> getAppUpdateInfo(int targetPlatformBuildNumber,
                                                            Iterable<com.atlassian.application.api.Application> installedApps)

Query Marketplace for available updates to installed applications. If we already know that Marketplace is disabled or unavailable, then no query is done and it returns a "disabled" or "unreachable" MarketplaceResult instead of a list. If we know that Marketplace is available but that we won't be able to query for compatibility with the current platform, because the current platform version is unknown to Marketplace, then it returns an empty list.

Parameters:

targetPlatformBuildNumber - application updates must be compatible with this platform version

installedApps - a list of installed applications

Returns:

a MarketplaceResult whose value is a list of AppUpdateInfo objects for the available updates, if any

getPlatformVersionInfo

PlatformVersionInfo getPlatformVersionInfo()

Get information about the current installed platform version and whether it is known to Marketplace.

See Also:

PlatformVersionInfo

getProductWithLatestVersion

io.atlassian.fugue.Option<com.atlassian.marketplace.client.model.Product> getProductWithLatestVersion(String applicationKey)

Query Marketplace for the listing of the specified application.

Parameters:

applicationKey - an application key

Returns:

a product representation, which contains a single product version representation; or None if the application is not found (or if Marketplace is unavailable)

getMpacVersionInfoForInstalledApps

MarketplaceResult<Map<String,com.atlassian.marketplace.client.model.ProductVersion>> getMpacVersionInfoForInstalledApps(Iterable<com.atlassian.application.api.Application> apps)

Query Marketplace to get version info for the provided applications if found

Parameters:

apps - iterable of applications

Returns:

Map containing String to ProductVersion representations

getMpacVersionInfoForInstalledApp

io.atlassian.fugue.Option<com.atlassian.marketplace.client.model.ProductVersion> getMpacVersionInfoForInstalledApp(com.atlassian.application.api.Application app)

Query Marketplace to get the version info for the provided application

Parameters:

app - application

Returns:

optional ProductVersion info for the application