DefaultMarketplaceClient (Atlassian Marketplace Client 2.0.0 API)

java.lang.Object
- com.atlassian.marketplace.client.impl.DefaultMarketplaceClient

All Implemented Interfaces:

MarketplaceClient, Closeable, AutoCloseable
```
public final class DefaultMarketplaceClient
extends Object
implements MarketplaceClient
```
Default implementation of MarketplaceClient for the Marketplace 2.0 API.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`API_VERSION`
`protected URI`	`baseUri`
`static URI`	`DEFAULT_SERVER_URI`
`protected EntityEncoding`	`encoding`
`protected HttpTransport`	`httpTransport`

Constructor Summary

Constructors
Constructor and Description
`DefaultMarketplaceClient(URI baseUri, HttpConfiguration configuration)` Constructs a `DefaultMarketplaceClient` using the default HTTP implementation.
`DefaultMarketplaceClient(URI serverBaseUri, HttpTransport httpTransport, EntityEncoding encoding)` Constructs a `DefaultMarketplaceClient` using a specific HTTP implementation and response parser.

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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_SERVER_URI
```
public static final URI DEFAULT_SERVER_URI
```
  - baseUri
```
protected final URI baseUri
```
  - httpTransport
```
protected final HttpTransport httpTransport
```
  - encoding
```
protected final EntityEncoding encoding
```
  - API_VERSION
```
public static final String API_VERSION
```
    See Also:
    Constant Field Values
- Constructor Detail
  - DefaultMarketplaceClient
```
public DefaultMarketplaceClient(URI baseUri,
                        HttpConfiguration configuration)
```
    Constructs a DefaultMarketplaceClient using the default HTTP implementation.
    
    Parameters:
    baseUri - The root URI of the Marketplace server.
    configuration - Client parameters such as timeouts, authentication, and proxy settings.
  - DefaultMarketplaceClient
```
public DefaultMarketplaceClient(URI serverBaseUri,
                        HttpTransport httpTransport,
                        EntityEncoding encoding)
```
    Constructs a DefaultMarketplaceClient using a specific HTTP implementation and response parser.
    
    Parameters:
    serverBaseUri - The root URI of the Marketplace server.
    httpTransport - An object that will execute all HTTP requests.
    encoding - An EntityEncoding implementation.
- Method Detail
  - close
```
public void close()
```
    Description copied from interface: MarketplaceClient
    
    Should be called when finished with client to release resources.
    
    Specified by:
    
    close in interface MarketplaceClient
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
  - isReachable
```
public boolean isReachable()
```
    Description copied from interface: MarketplaceClient
    
    Checks whether the MPAC service is available, by attempting to get the root resource.
    
    Specified by:
    
    isReachable in interface MarketplaceClient
    
    Returns:
    true if the request was successful; false if it failed for any reason
  - getRootLinks
```
public Links getRootLinks()
                   throws MpacException
```
    Description copied from interface: MarketplaceClient
    
    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.
    
    Specified by:
    
    getRootLinks in interface MarketplaceClient
    
    Returns:
    a Links object
    
    Throws:
    
    MpacException - if the server was unavailable or returned an error
  - getHttp
```
public HttpTransport getHttp()
```
    Description copied from interface: MarketplaceClient
    
    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.
    
    Specified by:
    
    getHttp in interface MarketplaceClient
  - toJson
```
public <T> String toJson(T entity)
              throws MpacException
```
    Description copied from interface: MarketplaceClient
    
    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.
    
    Specified by:
    
    toJson in interface MarketplaceClient
    
    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)
  - addons
```
public Addons addons()
              throws MpacException
```
    Description copied from interface: MarketplaceClient
    
    Returns an API object that provides access to add-on listings.
    
    Specified by:
    
    addons in interface MarketplaceClient
    
    Throws:
    
    MpacException
  - addonCategories
```
public AddonCategories addonCategories()
                                throws MpacException
```
    Description copied from interface: MarketplaceClient
    
    Returns an API object that provides access to add-on categories.
    
    Specified by:
    
    addonCategories in interface MarketplaceClient
    
    Throws:
    
    MpacException
  - applications
```
public Applications applications()
                          throws MpacException
```
    Description copied from interface: MarketplaceClient
    
    Returns an API object that provides access to application listings.
    
    Specified by:
    
    applications in interface MarketplaceClient
    
    Throws:
    
    MpacException
  - assets
```
public Assets assets()
              throws MpacException
```
    Description copied from interface: MarketplaceClient
    
    Returns an API object that provides file uploading capabilities.
    
    Specified by:
    
    assets in interface MarketplaceClient
    
    Throws:
    
    MpacException
  - licenseTypes
```
public LicenseTypes licenseTypes()
                          throws MpacException
```
    Description copied from interface: MarketplaceClient
    
    Returns an API object that provides access to software license types.
    
    Specified by:
    
    licenseTypes in interface MarketplaceClient
    
    Throws:
    
    MpacException
  - products
```
public Products products()
                  throws MpacException
```
    Description copied from interface: MarketplaceClient
    
    Returns an API object that provides access to product listings (which are called "applications" in the administrative UI).
    
    Specified by:
    
    products in interface MarketplaceClient
    
    Throws:
    
    MpacException
  - vendors
```
public Vendors vendors()
                throws MpacException
```
    Description copied from interface: MarketplaceClient
    
    Returns an API object that provides access to vendors.
    
    Specified by:
    
    vendors in interface MarketplaceClient
    
    Throws:
    
    MpacException
  - getMore
```
public <T> Page<T> getMore(PageReference<T> ref)
                throws MpacException
```
    Description copied from interface: MarketplaceClient
    
    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.
    
    Specified by:
    
    getMore in interface MarketplaceClient
    
    Returns:
    a Page containing the results
    
    Throws:
    
    MpacException - if the server was unavailable or returned an error

Class DefaultMarketplaceClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_SERVER_URI

baseUri

httpTransport

encoding

API_VERSION

Constructor Detail

DefaultMarketplaceClient

DefaultMarketplaceClient

Method Detail

close

isReachable

getRootLinks

getHttp

toJson

addons

addonCategories

applications

assets

licenseTypes

products

vendors

getMore