com.atlassian.marketplace.client.api

Interface Assets

public interface Assets

Allows you to manage file-like data that can be attached to resources, such as a logo for an add-on or vendor, or an artifact for an installable add-on. Use MarketplaceClient.assets() to access this API.

Asset uploads are managed as follows:

• To upload an asset, you must be authenticated as a Marketplace user (that is, when you created your client instance with MarketplaceClientFactory, you provided an HttpConfiguration with HttpConfiguration.Credentials).
• The Marketplace server may reject uploads if you submit many of them in rapid succession.
• If an uploaded asset is not used in any model object (for instance, if you upload a logo image, but then do not set it as the logo for an add-on or a vendor), the server will delete it after about a day.

Since:

2.0.0

Method Summary

Methods

Modifier and Type	Method and Description
ArtifactId	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	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.

Method Detail

uploadAddonArtifact

ArtifactId uploadAddonArtifact(File artifactFile)
                               throws MpacException

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.

If successful, you will receive an ArtifactId, which you can pass to ModelBuilders.AddonVersionBuilder#artifact.

Note that if the artifact is available online (for instance, an Atlassian Connect descriptor), you can instead use ArtifactId.fromUri(java.net.URI) to tell Marketplace where to get the artifact.

Parameters:

artifactFile - a local file containing the artifact

Returns:

an ArtifactId that uniquely identifies the new asset resource

Throws:

MpacException - if the server was unavailable or returned an error

uploadImage

ImageId uploadImage(File imageFile,
                  ImagePurpose imageType)
                    throws MpacException

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.

If successful, you will receive an ImageId, which you can pass to one of the ModelBuilders methods such as ModelBuilders.AddonBuilder#logo(com.atlassian.fugue.Option) or ModelBuilders.ScreenshotBuilder#image(ImageId).

Note that if the image is available online, you do not have to upload it, but can instead use ImageId.fromUri(java.net.URI) to tell Marketplace where to get the image.

Parameters:

imageFile - a local file containing the image data

imageType - specifies what kind of property the image will be used for; this determines how it will be scaled

Returns:

an ImageId that uniquely identifies the new asset resource

Throws:

MpacException - if the server was unavailable or returned an error