com.atlassian.marketplace.client.api

Interface Applications

public interface Applications

Starting point for all resources that return application information. Use MarketplaceClient.applications() to access this API.

An "application", in this context, is a top-level Atlassian software platform such as JIRA or Confluence; software packages like JIRA Service Desk, which are called "applications" in the UI, are instead accessed through the Products API.

Since:

2.0.0

Method Summary

Methods

Modifier and Type	Method and Description
Application	createApplication(Application application) Creates a new application.
ApplicationVersion	createVersion(ApplicationKey applicationKey, ApplicationVersion version) Creates a new version for an existing application.
com.atlassian.fugue.Option<Application>	getByKey(ApplicationKey applicationKey) Queries a single application.
com.atlassian.fugue.Option<ApplicationVersion>	getVersion(ApplicationKey applicationKey, ApplicationVersionSpecifier versionQuery) Queries a specific version of an application.
Page<ApplicationVersion>	getVersions(ApplicationKey applicationKey, ApplicationVersionsQuery versionsQuery) Gets a list of versions for an application.
Application	updateApplication(Application original, Application updated) Attempts to modify an existing application.
ApplicationVersion	updateVersion(ApplicationVersion original, ApplicationVersion updated) Attempts to modify an existing application version.

Method Detail

getByKey

com.atlassian.fugue.Option<Application> getByKey(ApplicationKey applicationKey)
                                                 throws MpacException

Queries a single application.

Parameters:

applicationKey - the application's unique key

Returns:

the application information, or Option.none() if there is no match

Throws:

MpacException - if the server was unavailable or returned an error

createApplication

Application createApplication(Application application)
                              throws MpacException

Creates a new application. Only Marketplace administrators can perform this operation.

Use ModelBuilders.application() to build a new Application object.

Parameters:

application - the application to create

Returns:

an Application representing the application in its initial state after being created

Throws:

MpacException - if the server was unavailable or returned an error

updateApplication

Application updateApplication(Application original,
                            Application updated)
                              throws MpacException

Attempts to modify an existing application. Only Marketplace administrators can perform this operation. You must have already queried the current state of the application with getByKey(ApplicationKey); then, build another instance that includes any changes you want to make, using ModelBuilders.application(Application).

Parameters:

original - the existing application

updated - a copy of the application that includes some changes

Returns:

the updated application (re-queried from the server) if successful

Throws:

MpacException - if the server was unavailable or returned an error

getVersion

com.atlassian.fugue.Option<ApplicationVersion> getVersion(ApplicationKey applicationKey,
                                                        ApplicationVersionSpecifier versionQuery)
                                                          throws MpacException

Queries a specific version of an application.

Parameters:

applicationKey - the application's unique key

versionQuery - search criteria for identifying a single version

Returns:

the application version information, or Option.none() if there is no match

Throws:

MpacException - if the server was unavailable or returned an error

getVersions

Page<ApplicationVersion> getVersions(ApplicationKey applicationKey,
                                   ApplicationVersionsQuery versionsQuery)
                                     throws MpacException

Gets a list of versions for an application.

Parameters:

applicationKey - the application's unique key

versionsQuery - an ApplicationVersionsQuery which may contain criteria to limit the search; use ApplicationVersionsQuery.any() if there are no additional criteria

Returns:

the application versions

Throws:

MpacException - if the server was unavailable or returned an error

createVersion

ApplicationVersion createVersion(ApplicationKey applicationKey,
                               ApplicationVersion version)
                                 throws MpacException

Creates a new version for an existing application. Only Marketplace administrators can perform this operation.

Use ModelBuilders.applicationVersion() to build a new ApplicationVersion object.

Parameters:

applicationKey - unique key of the existing application

version - the add-on version to create

Returns:

an ApplicationVersion representing the version in its initial state after being created

Throws:

MpacException - if the server was unavailable or returned an error

updateVersion

ApplicationVersion updateVersion(ApplicationVersion original,
                               ApplicationVersion updated)
                                 throws MpacException

Attempts to modify an existing application version. Only Marketplace administrators can perform this operation. You must have already queried the current state of the version with getVersion(ApplicationKey, ApplicationVersionSpecifier); then, build another instance that includes any changes you want to make, using ModelBuilders.applicationVersion(ApplicationVersion).

Parameters:

original - the existing application version

updated - a copy of the version that includes some changes

Returns:

the updated version (re-queried from the server) if successful

Throws:

MpacException - if the server was unavailable or returned an error