com.atlassian.marketplace.client.http

Interface HttpTransport

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

CommonsHttpTransport

public interface HttpTransport
extends Closeable

Abstraction of how to execute HTTP requests against the API.

Since:

2.0.0

Method Summary

Methods

Modifier and Type	Method and Description
SimpleHttpResponse	delete(URI uri) Performs an HTTP DELETE.
SimpleHttpResponse	get(URI uri) Performs an HTTP GET.
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 interface java.io.Closeable

close

Method Detail

get

SimpleHttpResponse get(URI uri)
                       throws MpacException

Performs an HTTP GET.

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

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

Performs an HTTP POST with form parameters.

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

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

Performs an HTTP POST of an API entity.

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

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

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

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

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

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

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

SimpleHttpResponse delete(URI uri)
                          throws MpacException

Performs an HTTP DELETE.

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

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). The new instance still uses the same underlying HTTP transport; closing one will close the other.

Parameters:

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

Returns:

a new HttpTransport instance