com.atlassian.marketplace.client.impl

Class CommonsHttpTransport

java.lang.Object

com.atlassian.marketplace.client.impl.CommonsHttpTransport

All Implemented Interfaces:

HttpTransport, Closeable, AutoCloseable

public final class CommonsHttpTransport
extends Object
implements HttpTransport

Implementation of HttpTransport based on Apache HttpComponents.

Since:

2.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommonsHttpTransport.CachingBehavior Use with createHttpClient(com.atlassian.marketplace.client.http.HttpConfiguration, com.atlassian.fugue.Option<java.net.URI>) to indicate whether or not to enable HTTP caching.

Constructor Summary

Constructors

Constructor and Description
CommonsHttpTransport(HttpConfiguration configuration, URI baseUri)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Should be called to shutdown the Client HttpConnectionManager, this will prevent finaliser errors from appearing in the log, and helps to prevent a resource leak.
static org.apache.http.client.HttpClient	createHttpClient(HttpConfiguration config, com.atlassian.fugue.Option<URI> baseUri) Helper method that configures an HttpClient with the specified proxy/timeout properties.
SimpleHttpResponse	delete(URI uri) Performs an HTTP DELETE.
SimpleHttpResponse	get(URI uri) Performs an HTTP GET.
static org.apache.http.impl.client.HttpClientBuilder	httpClientBuilder(HttpConfiguration config, com.atlassian.fugue.Option<URI> baseUri, CommonsHttpTransport.CachingBehavior cachingBehavior) Helper method that configures an HttpClientBuilder with the specified proxy/timeout properties.
SimpleHttpResponse	patch(URI uri, byte[] content) Performs an HTTP PATCH.
SimpleHttpResponse	post(URI uri, InputStream content, long length, String contentType, String acceptContentType) Performs an HTTP POST of an API entity.
SimpleHttpResponse	postParams(URI uri, com.google.common.collect.Multimap<String,String> params) Performs an HTTP POST with form parameters.
SimpleHttpResponse	put(URI uri, byte[] content) Performs an HTTP PUT of an API entity.
HttpTransport	withRequestDecorator(RequestDecorator decorator) Returns another HttpTransport instance that behaves the same as this one except that it adds headers from the specified RequestDecorator to every request (in addition to any headers previously specified in the defaults).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CommonsHttpTransport

public CommonsHttpTransport(HttpConfiguration configuration,
                    URI baseUri)

Method Detail

get

public SimpleHttpResponse get(URI uri)
                       throws MpacException

Description copied from interface: HttpTransport

Performs an HTTP GET.

Specified by:

get in interface HttpTransport

Parameters:

uri - URI of resource to get

Returns:

a SimpleHttpResponse wrapping the HTTP response

Throws:

MpacException - if the server was unavailable or returned no response

postParams

public SimpleHttpResponse postParams(URI uri,
                            com.google.common.collect.Multimap<String,String> params)
                              throws MpacException

Description copied from interface: HttpTransport

Performs an HTTP POST with form parameters.

Specified by:

postParams in interface HttpTransport

Parameters:

uri - URI of resource to post to

params - the unencoded parameters

Returns:

a SimpleHttpResponse wrapping the HTTP response

Throws:

MpacException - if the server was unavailable or returned no response

post

public SimpleHttpResponse post(URI uri,
                      InputStream content,
                      long length,
                      String contentType,
                      String acceptContentType)
                        throws MpacException

Description copied from interface: HttpTransport

Performs an HTTP POST of an API entity.

Specified by:

post in interface HttpTransport

Parameters:

uri - URI of resource to post to

content - input stream containing the request body

length - length of the input stream

contentType - content type of the entity

acceptContentType - expected content type of response

Returns:

a SimpleHttpResponse wrapping the HTTP response

Throws:

MpacException - if the server was unavailable or returned no response

put

public SimpleHttpResponse put(URI uri,
                     byte[] content)
                       throws MpacException

Description copied from interface: HttpTransport

Performs an HTTP PUT of an API entity. The content type is assumed to be JSON.

Specified by:

put in interface HttpTransport

Parameters:

uri - URI of resource to put

content - request body

Returns:

a SimpleHttpResponse wrapping the HTTP response

Throws:

MpacException - if the server was unavailable or returned no response

patch

public SimpleHttpResponse patch(URI uri,
                       byte[] content)
                         throws MpacException

Description copied from interface: HttpTransport

Performs an HTTP PATCH. The content type is assumed to be application/json-patch+json.

Specified by:

patch in interface HttpTransport

Parameters:

uri - URI of resource to put

content - request body

Returns:

a SimpleHttpResponse wrapping the HTTP response

Throws:

MpacException - if the server was unavailable or returned no response

delete

public SimpleHttpResponse delete(URI uri)
                          throws MpacException

Description copied from interface: HttpTransport

Performs an HTTP DELETE.

Specified by:

delete in interface HttpTransport

Parameters:

uri - URI of resource to delete

Returns:

a SimpleHttpResponse wrapping the HTTP response

Throws:

MpacException - if the server was unavailable or returned no response

withRequestDecorator

public HttpTransport withRequestDecorator(RequestDecorator decorator)

Description copied from interface: HttpTransport

Returns another HttpTransport instance that behaves the same as this one except that it adds headers from the specified RequestDecorator to every request (in addition to any headers previously specified in the defaults). The new instance still uses the same underlying HTTP transport; closing one will close the other.

Specified by:

withRequestDecorator in interface HttpTransport

Parameters:

decorator - will generate additional headers for requests made via the new instance

Returns:

a new HttpTransport instance

close

public void close()

Should be called to shutdown the Client HttpConnectionManager, this will prevent finaliser errors from appearing in the log, and helps to prevent a resource leak.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

createHttpClient

public static org.apache.http.client.HttpClient createHttpClient(HttpConfiguration config,
                                                 com.atlassian.fugue.Option<URI> baseUri)

Helper method that configures an HttpClient with the specified proxy/timeout properties. All requests done through the resulting client will use the configured settings, in terms of timeouts, proxies, RequestDecorators, etc.

Parameters:

config - an HttpConfiguration

baseUri - base URI of the Marketplace server; this is only relevant if you're providing basicauth credentials for the server itself (rather than for the proxy)

Returns:

a configured HttpClient

httpClientBuilder

public static org.apache.http.impl.client.HttpClientBuilder httpClientBuilder(HttpConfiguration config,
                                                              com.atlassian.fugue.Option<URI> baseUri,
                                                              CommonsHttpTransport.CachingBehavior cachingBehavior)

Helper method that configures an HttpClientBuilder with the specified proxy/timeout properties. All requests done through the resulting client will use the configured settings, in terms of timeouts, proxies, RequestDecorators, etc.

Parameters:

config - an HttpConfiguration

baseUri - base URI of the Marketplace server; this is only relevant if you're providing basicauth credentials for the server itself (rather than for the proxy)

cachingBehavior - determines whether to use a caching client

Returns:

a configured HttpClientBuilder