uk.co.visalia.brightpearl.apiclient.http

Interface Client

All Known Implementing Classes:

HttpClient4Client

public interface Client

A simple interface for an HTTP client, providing a generic API that can be implemented using any HTTP client library, to make this client library fully portable.

BrightpearlApiClient requests a Client instance from ClientFactory every time it makes a request to the Brightpearl API. This allows support for HTTP clients that can only be used once or cannot support concurrent requests.

Implementations should not attempt to handle unexpected response codes; if a response was received from the remote server with any status code, this method should return without throwing an exception. BrightpearlApiClient handles interpretation of unexpected status codes. An exception should only be thrown if there is a failure to connect to the remote server or an exception while processing the response. The recommended exception to throw in these cases is BrightpearlHttpException.

Method Summary

Methods

Modifier and Type	Method and Description
Response	execute(Request request) Executes a request and returns the response.

Method Detail

execute

Response execute(Request request)

Executes a request and returns the response. The status code, response body and headers should all be returned if any response is received from the server, regardless of status code. If the request fails due to a transport error, a BrightpearlHttpException should be thrown.

Parameters:

request - The request to be executed.

Returns:

Response from the server.