MarketplaceClient (Atlassian Marketplace Client 2.0.0-m4 API)

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

DefaultMarketplaceClient
```
public interface MarketplaceClient
extends Closeable
```
Client interface for the Atlassian Marketplace 2.0 API.
Construct a concrete implementation of the client (DefaultMarketplaceClient) and use that instance for all API requests.

Method Summary

Methods
Modifier and Type	Method and Description
`AddonCategories`	`addonCategories()` Returns an API object that provides access to add-on categories.
`Addons`	`addons()` Returns an API object that provides access to add-on listings.
`Applications`	`applications()` Returns an API object that provides access to application listings.
`Assets`	`assets()` Returns an API object that provides file uploading capabilities.
`void`	`close()` Should be called when finished with client to release resources
`HttpTransport`	`getHttp()` Provides access to the underlying HTTP transport mechanism.
`<T> Page<T>`	`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`	`getRootLinks()` Returns the top-level API resource links, such as "addons".
`boolean`	`isReachable()` Checks whether the MPAC service is available, by attempting to get the root resource.
`LicenseTypes`	`licenseTypes()` Returns an API object that provides access to software license types.
`Products`	`products()` Returns an API object that provides access to product listings (which are called "applications" in the administrative UI).
`<T> String`	`toJson(T entity)` Attempts to convert the specified model object to a JSON string.
`Vendors`	`vendors()` Returns an API object that provides access to vendors.

- Method Detail
  - isReachable
```
boolean isReachable()
```
    Checks whether the MPAC service is available, by attempting to get the root resource.
    
    Returns:
    true if the request was successful; false if it failed for any reason
  - addons
```
Addons addons()
              throws MpacException
```
    Returns an API object that provides access to add-on listings.
    
    Throws:
    
    MpacException
  - addonCategories
```
AddonCategories addonCategories()
                                throws MpacException
```
    Returns an API object that provides access to add-on categories.
    
    Throws:
    
    MpacException
  - applications
```
Applications applications()
                          throws MpacException
```
    Returns an API object that provides access to application listings.
    
    Throws:
    
    MpacException
  - assets
```
Assets assets()
              throws MpacException
```
    Returns an API object that provides file uploading capabilities.
    
    Throws:
    
    MpacException
  - licenseTypes
```
LicenseTypes licenseTypes()
                          throws MpacException
```
    Returns an API object that provides access to software license types.
    
    Throws:
    
    MpacException
  - products
```
Products products()
                  throws MpacException
```
    Returns an API object that provides access to product listings (which are called "applications" in the administrative UI).
    
    Throws:
    
    MpacException
  - vendors
```
Vendors vendors()
                throws MpacException
```
    Returns an API object that provides access to vendors.
    
    Throws:
    
    MpacException
  - getMore
```
<T> Page<T> getMore(PageReference<T> ref)
                throws MpacException
```
    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)). The PageReference is obtained by calling Page.getPrevious(), Page.getNext(), or Page.getReference() on an existing Page of results.
    
    Returns:
    a Page containing the results
    
    Throws:
    
    MpacException - if the server was unavailable or returned an error
  - getRootLinks
```
Links getRootLinks()
                   throws MpacException
```
    Returns the top-level API resource links, such as "addons". MarketplaceClient normally traverses these links automatically; you should only need to use this method if you are passing a URL outside of Java code, for instance to a front-end script.
    
    Returns:
    a Links object
    
    Throws:
    
    MpacException - if the server was unavailable or returned an error
  - getHttp
```
HttpTransport getHttp()
```
    Provides access to the underlying HTTP transport mechanism. This allows for implementation of extension modules for Marketplace APIs that are not supported by the base library.
  - toJson
```
<T> String toJson(T entity)
              throws MpacException
```
    Attempts to convert the specified model object to a JSON string. This should be used only for testing purposes; normally, JSON serialization is done automatically within client methods.
    
    Parameters:
    entity - a model object
    
    Returns:
    a JSON string
    
    Throws:
    
    MpacException - if the object could not be serialized as JSON (for instance, because it is not an instance of any of this library's model classes)
  - close
```
void close()
```
    Should be called when finished with client to release resources
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Closeable

Interface MarketplaceClient

Method Summary

Method Detail

isReachable

addons

addonCategories

applications

assets

licenseTypes

products

vendors

getMore

getRootLinks

getHttp

toJson

close