Class CoverallsClient

java.lang.Object

org.eluder.coveralls.maven.plugin.httpclient.CoverallsClient

Direct Known Subclasses:

CoverallsProxyClient

public class CoverallsClient
extends Object

The Class CoverallsClient.

Constructor Summary

Constructors

Constructor	Description
CoverallsClient(String coverallsUrl)	Instantiates a new Coveralls Client.
CoverallsClient(String coverallsUrl, HttpClient httpClient, com.fasterxml.jackson.databind.ObjectMapper objectMapper)	Instantiates a new Coveralls Client.

Method Summary

Modifier and Type	Method	Description
CoverallsResponse	submit(File file)	Submit a coveralls json file to the API.

Methods inherited from class Object

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

Constructor Details

CoverallsClient

public CoverallsClient(String coverallsUrl)

Instantiates a new Coveralls Client.

Parameters:

coverallsUrl - The base url for the Coveralls API. This should generally be set to

https://coveralls.io/api/v1/jobs
           

CoverallsClient

public CoverallsClient(String coverallsUrl,
 HttpClient httpClient,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Instantiates a new Coveralls Client.

Parameters:

coverallsUrl - The base url for the Coveralls API. This should generally be set to

https://coveralls.io/api/v1/jobs
           

httpClient - An implementation of HttpClient

objectMapper - A Jackson ObjectMapper

Method Details

submit

public CoverallsResponse submit(File file)
                         throws ProcessingException,
IOException,
InterruptedException

Submit a coveralls json file to the API.

Parameters:

file - A coveralls report that can be submitted to the jobs API

Returns:

An API response body deserialized to a CoverallsResponse

Throws:

ProcessingException - the processing exception

IOException - Signals that an I/O exception has occurred.

InterruptedException - the interrupted exception