com.atlassian.upm.application.marketplace

Class ApplicationMarketplaceQueriesImpl

java.lang.Object

com.atlassian.upm.application.marketplace.ApplicationMarketplaceQueriesImpl

All Implemented Interfaces:

ApplicationMarketplaceQueries, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean

public class ApplicationMarketplaceQueriesImpl
extends Object
implements ApplicationMarketplaceQueries, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean

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

Since:

2.19

Constructor Summary

Constructors

Constructor and Description

ApplicationMarketplaceQueriesImpl(ApplicationAccessor applicationAccessor, com.atlassian.sal.api.ApplicationProperties applicationProperties, VersionAwareHostApplicationInformation hostApplicationInformation, com.atlassian.event.api.EventPublisher eventPublisher, MarketplaceClientManager marketplaceClientFactory, SysPersisted sysPersisted, com.atlassian.sal.api.executor.ThreadLocalDelegateExecutorFactory threadLocalDelegateExecutorFactory, com.atlassian.cache.CacheFactory cacheFactory)

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	destroy()
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.
void	onMarketplaceBaseUrlChangedEvent(MarketplaceBaseUrlChangedEvent event)
void	onPlatformBuildNumberChangeEvent(PlatformBuildNumberChangeEvent event)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApplicationMarketplaceQueriesImpl

public ApplicationMarketplaceQueriesImpl(ApplicationAccessor applicationAccessor,
                                         com.atlassian.sal.api.ApplicationProperties applicationProperties,
                                         VersionAwareHostApplicationInformation hostApplicationInformation,
                                         com.atlassian.event.api.EventPublisher eventPublisher,
                                         MarketplaceClientManager marketplaceClientFactory,
                                         SysPersisted sysPersisted,
                                         com.atlassian.sal.api.executor.ThreadLocalDelegateExecutorFactory threadLocalDelegateExecutorFactory,
                                         com.atlassian.cache.CacheFactory cacheFactory)

Method Detail

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

destroy

public void destroy()

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

getPlatformVersionInfo

public PlatformVersionInfo getPlatformVersionInfo()

Description copied from interface: ApplicationMarketplaceQueries

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

Specified by:

getPlatformVersionInfo in interface ApplicationMarketplaceQueries

See Also:

PlatformVersionInfo

getAvailableAppsInfo

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

Description copied from interface: ApplicationMarketplaceQueries

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.

Specified by:

getAvailableAppsInfo in interface ApplicationMarketplaceQueries

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

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

Description copied from interface: ApplicationMarketplaceQueries

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.

Specified by:

getAppUpdateInfo in interface ApplicationMarketplaceQueries

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

getProductWithLatestVersion

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

Description copied from interface: ApplicationMarketplaceQueries

Query Marketplace for the listing of the specified application.

Specified by:

getProductWithLatestVersion in interface ApplicationMarketplaceQueries

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

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

Description copied from interface: ApplicationMarketplaceQueries

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

Specified by:

getMpacVersionInfoForInstalledApps in interface ApplicationMarketplaceQueries

Parameters:

apps - iterable of applications

Returns:

Map containing String to ProductVersion representations

getMpacVersionInfoForInstalledApp

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

Description copied from interface: ApplicationMarketplaceQueries

Query Marketplace to get the version info for the provided application

Specified by:

getMpacVersionInfoForInstalledApp in interface ApplicationMarketplaceQueries

Parameters:

app - application

Returns:

optional ProductVersion info for the application

onPlatformBuildNumberChangeEvent

@EventListener
public void onPlatformBuildNumberChangeEvent(PlatformBuildNumberChangeEvent event)

onMarketplaceBaseUrlChangedEvent

@EventListener
public void onMarketplaceBaseUrlChangedEvent(MarketplaceBaseUrlChangedEvent event)