| Package | Description |
|---|---|
| com.atlassian.marketplace.client |
Top-level interfaces and value classes for the Atlassian Marketplace API.
|
| com.atlassian.marketplace.client.api |
Interfaces and immutable value classes used in the Atlassian Marketplace API.
|
| com.atlassian.marketplace.client.http |
Interfaces and classes related to the HTTP transport layer.
|
| com.atlassian.marketplace.client.impl |
Internal implementation of Marketplace client APIs.
|
| com.atlassian.marketplace.client.model |
Entities that can be returned by the Atlassian Marketplace API.
|
| Modifier and Type | Class and Description |
|---|---|
static class |
MpacException.CannotUpdateNonServerSideEntity
Indicates that an
update method was called for an object that did not come from
the Marketplace server. |
static class |
MpacException.ConnectionFailure
Indicates that the client was unable to make an HTTP connection to the server, or that
a request timed out before a response was received.
|
static class |
MpacException.InvalidResponseError
Indicates that the server returned a response that could not be parsed.
|
static class |
MpacException.ServerError
Indicates that the server returned an HTTP error status code.
|
| Modifier and Type | Method and Description |
|---|---|
AddonCategories |
MarketplaceClient.addonCategories()
Returns an API object that provides access to add-on categories.
|
Addons |
MarketplaceClient.addons()
Returns an API object that provides access to add-on listings.
|
Applications |
MarketplaceClient.applications()
Returns an API object that provides access to application listings.
|
Assets |
MarketplaceClient.assets()
Returns an API object that provides file uploading capabilities.
|
<T> Page<T> |
MarketplaceClient.getMore(PageReference<T> ref)
Queries a page of a result set from a previous query, for any resource that provides paginated
results (such as
Addons.find(com.atlassian.marketplace.client.api.AddonQuery)). |
Links |
MarketplaceClient.getRootLinks()
Returns the top-level API resource links, such as "addons".
|
LicenseTypes |
MarketplaceClient.licenseTypes()
Returns an API object that provides access to software license types.
|
Products |
MarketplaceClient.products()
Returns an API object that provides access to product listings (which are called "applications" in the administrative UI).
|
<T> String |
MarketplaceClient.toJson(T entity)
Attempts to convert the specified model object to a JSON string.
|
Vendors |
MarketplaceClient.vendors()
Returns an API object that provides access to vendors.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
Addons.claimAccessToken(String addonKey,
String token)
Checks if the access token for the given add-on is valid for this application instance to use,
and if so, marks it as claimed by this instance (based on the current hostname).
|
Addon |
Addons.createAddon(Addon addon)
Creates a new add-on listing.
|
Vendor |
Vendors.createVendor(Vendor vendor)
Creates a new vendor.
|
ApplicationVersion |
Applications.createVersion(ApplicationKey applicationKey,
ApplicationVersion version)
Creates a new version for an existing application.
|
AddonVersion |
Addons.createVersion(String addonKey,
AddonVersion version)
Creates a new version for an existing add-on.
|
Page<AddonSummary> |
Addons.find(AddonQuery query)
Returns a list of add-ons.
|
Page<Product> |
Products.find(ProductQuery query)
Returns a list of products.
|
Page<VendorSummary> |
Vendors.find(VendorQuery query)
Gets a list of vendors.
|
Page<AddonReference> |
Addons.findBanners(AddonQuery query)
Similar to
Addons.find(com.atlassian.marketplace.client.api.AddonQuery), but further restricts the query to add-ons that have a banner image,
and returns minimal AddonReference results, whose AddonReference.getImage() method
will return the banner image. |
Iterable<AddonCategorySummary> |
AddonCategories.findForApplication(ApplicationKey appKey)
Returns the list of all categories that are relevant to the specified application.
|
Page<AddonReference> |
Addons.findRecommendations(String addonKey,
AddonQuery query)
Returns add-ons that Marketplace considers similar to the specified add-on in some way,
optionally constrained by compatibility or other
AddonQuery properties. |
Iterable<LicenseType> |
LicenseTypes.getAllLicenseTypes()
Returns all of the available license types.
|
Page<ApplicationVersion> |
Applications.getVersions(ApplicationKey applicationKey,
ApplicationVersionsQuery versionsQuery)
Gets a list of versions for an application.
|
Page<AddonVersionSummary> |
Addons.getVersions(String addonKey,
AddonVersionsQuery versionsQuery)
Gets a list of versions for an add-on.
|
abstract Page<T> |
PageReader.readPage(PageReference<T> ref,
InputStream in) |
Optional<Vendor> |
Vendors.safeGetById(VendorId id)
Queries a single vendor.
|
Optional<Application> |
Applications.safeGetByKey(ApplicationKey applicationKey)
Queries a single application.
|
Optional<LicenseType> |
LicenseTypes.safeGetByKey(String licenseKey)
Searches for a license type by its "key" property - for instance, "gpl" or "commercial".
|
Optional<Addon> |
Addons.safeGetByKey(String addonKey,
AddonQuery query)
Queries detail information for a single add-on.
|
Optional<Product> |
Products.safeGetByKey(String productKey,
ProductQuery query)
Queries a single product.
|
Optional<AddonPricing> |
Addons.safeGetPricing(String addonKey,
PricingType pricingType)
Queries the current pricing (the prices that are publicly visible on the Marketplace site) for
an add-on.
|
Optional<ApplicationVersion> |
Applications.safeGetVersion(ApplicationKey applicationKey,
ApplicationVersionSpecifier versionQuery)
Queries a specific version of an application.
|
Optional<AddonVersion> |
Addons.safeGetVersion(String addonKey,
AddonVersionSpecifier version,
AddonVersionsQuery query)
Queries one version of an add-on.
|
Optional<ProductVersion> |
Products.safeGetVersion(String productKey,
ProductVersionSpecifier versionQuery)
Queries a specific version of a product.
|
Addon |
Addons.updateAddon(Addon original,
Addon updated)
Attempts to modify an existing add-on.
|
Vendor |
Vendors.updateVendor(Vendor original,
Vendor updated)
Attempts to modify an existing vendor.
|
AddonVersion |
Addons.updateVersion(AddonVersion original,
AddonVersion updated)
Attempts to modify an existing add-on version.
|
ApplicationVersion |
Applications.updateVersion(ApplicationVersion original,
ApplicationVersion updated)
Attempts to modify an existing application version.
|
ArtifactId |
Assets.uploadAddonArtifact(File artifactFile)
Uploads an add-on artifact (.jar or .obr) to the Marketplace server, which can then
be used for an add-on version that you are planning to create.
|
ImageId |
Assets.uploadImage(File imageFile,
ImagePurpose imageType)
Uploads an image file to the Marketplace server, which can then be used for an image
property of a model object that you are planning to create or update.
|
| Modifier and Type | Method and Description |
|---|---|
SimpleHttpResponse |
HttpTransport.delete(URI uri)
Performs an HTTP DELETE.
|
SimpleHttpResponse |
HttpTransport.get(URI uri)
Performs an HTTP GET.
|
InputStream |
SimpleHttpResponse.getContentStream()
An input stream for the response body.
|
SimpleHttpResponse |
HttpTransport.patch(URI uri,
byte[] content)
Performs an HTTP PATCH.
|
SimpleHttpResponse |
HttpTransport.post(URI uri,
InputStream content,
long length,
String contentType,
String acceptContentType,
Optional<Consumer<org.apache.http.client.methods.HttpPost>> modifyRequest)
Performs an HTTP POST of an API entity.
|
SimpleHttpResponse |
HttpTransport.postParams(URI uri,
com.google.common.collect.Multimap<String,String> params)
Performs an HTTP POST with form parameters.
|
SimpleHttpResponse |
HttpTransport.put(URI uri,
byte[] content)
Performs an HTTP PUT of an API entity.
|
| Modifier and Type | Method and Description |
|---|---|
AddonCategories |
DefaultMarketplaceClient.addonCategories() |
Addons |
DefaultMarketplaceClient.addons() |
Applications |
DefaultMarketplaceClient.applications() |
Assets |
DefaultMarketplaceClient.assets() |
<T> T |
EntityEncoding.decode(InputStream stream,
Class<T> type) |
<T> T |
JsonEntityEncoding.decode(InputStream stream,
Class<T> type) |
SimpleHttpResponse |
CommonsHttpTransport.delete(URI uri) |
<T> void |
EntityEncoding.encode(OutputStream stream,
T entity,
boolean includeReadOnlyFields) |
<T> void |
JsonEntityEncoding.encode(OutputStream stream,
T entity,
boolean includeReadOnlyFields) |
<T> void |
EntityEncoding.encodeChanges(OutputStream stream,
T original,
T updated) |
<T> void |
JsonEntityEncoding.encodeChanges(OutputStream stream,
T original,
T updated) |
SimpleHttpResponse |
CommonsHttpTransport.get(URI uri) |
<T> Page<T> |
DefaultMarketplaceClient.getMore(PageReference<T> ref) |
Links |
DefaultMarketplaceClient.getRootLinks() |
LicenseTypes |
DefaultMarketplaceClient.licenseTypes() |
SimpleHttpResponse |
CommonsHttpTransport.patch(URI uri,
byte[] content) |
SimpleHttpResponse |
CommonsHttpTransport.post(URI uri,
InputStream content,
long length,
String contentType,
String acceptContentType,
Optional<Consumer<org.apache.http.client.methods.HttpPost>> modifyRequest) |
SimpleHttpResponse |
CommonsHttpTransport.postParams(URI uri,
com.google.common.collect.Multimap<String,String> params) |
Products |
DefaultMarketplaceClient.products() |
SimpleHttpResponse |
CommonsHttpTransport.put(URI uri,
byte[] content) |
<T> String |
DefaultMarketplaceClient.toJson(T entity) |
Vendors |
DefaultMarketplaceClient.vendors() |
| Modifier and Type | Class and Description |
|---|---|
static class |
ModelBuilders.InvalidModelException
ModelBuilders methods that declare this checked exception will throw it if you attempt
to construct a model object that does not conform to the Marketplace API schema, for instance
by omitting a required property. |
Copyright © 2019 Atlassian. All rights reserved.