Class TaskClient

java.lang.Object

fr.tiogars.chat.client.TaskClient

public class TaskClient
extends Object

Provides HTTP access to the Task API.

Since:

0.1.0

Constructor Summary

Constructors

Constructor	Description
TaskClient(URI baseUri)	Creates a client backed by the default Java HTTP client.

Method Summary

Modifier and Type	Method	Description
Task	create(CreateTaskRequest request)	Creates a Task.
void	delete(long id)	Deletes a Task.
String	exportCsv()	Exports all Tasks as CSV.
List<Task>	exportJson()	Exports all Tasks as JSON-compatible objects.
List<Task>	findAll()	Lists all Tasks.
Task	findById(long id)	Finds a Task by identifier.
List<Task>	importCsv(String csv)	Imports Tasks from a CSV document.
List<Task>	importJson(List<CreateTaskRequest> requests)	Imports Tasks from JSON-compatible requests.
List<Task>	seed(List<CreateTaskRequest> requests)	Seeds Tasks from structured requests.
Task	update(long id, UpdateTaskRequest request)	Updates a Task.

Methods inherited from class Object

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

Constructor Details

TaskClient

public TaskClient(URI baseUri)

Creates a client backed by the default Java HTTP client.

Parameters:

baseUri - base URI of the server

Method Details

create

public Task create(CreateTaskRequest request)
            throws IOException,
InterruptedException

Creates a Task.

Parameters:

request - template data to create

Returns:

template created by the server

Throws:

IOException - if request serialization or response deserialization fails

InterruptedException - if the thread is interrupted while awaiting the response

TaskException - if the server returns an unexpected HTTP status

findAll

public List<Task> findAll()
                   throws IOException,
InterruptedException

Lists all Tasks.

Returns:

templates returned by the server

Throws:

IOException - if response deserialization fails

InterruptedException - if the thread is interrupted while awaiting the response

TaskException - if the server returns an unexpected HTTP status

findById

public Task findById(long id)
              throws IOException,
InterruptedException

Finds a Task by identifier.

Parameters:

id - persistent template identifier

Returns:

matching template

Throws:

IOException - if response deserialization fails

InterruptedException - if the thread is interrupted while awaiting the response

TaskException - if the server returns an unexpected HTTP status

update

public Task update(long id,
 UpdateTaskRequest request)
            throws IOException,
InterruptedException

Updates a Task.

Parameters:

id - persistent template identifier

request - replacement label and description

Returns:

template updated by the server

Throws:

IOException - if request serialization or response deserialization fails

InterruptedException - if the thread is interrupted while awaiting the response

TaskException - if the server returns an unexpected HTTP status

delete

public void delete(long id)
            throws IOException,
InterruptedException

Deletes a Task.

Parameters:

id - persistent template identifier

Throws:

IOException - if the request fails

InterruptedException - if the thread is interrupted while awaiting the response

TaskException - if the server returns an unexpected HTTP status

seed

public List<Task> seed(List<CreateTaskRequest> requests)
                throws IOException,
InterruptedException

Seeds Tasks from structured requests.

Parameters:

requests - templates to seed

Returns:

templates stored by the server

Throws:

IOException - if request serialization or response deserialization fails

InterruptedException - if the thread is interrupted while awaiting the response

TaskException - if the server returns an unexpected HTTP status

importJson

public List<Task> importJson(List<CreateTaskRequest> requests)
                      throws IOException,
InterruptedException

Imports Tasks from JSON-compatible requests.

Parameters:

requests - templates to import

Returns:

templates imported by the server

Throws:

IOException - if request serialization or response deserialization fails

InterruptedException - if the thread is interrupted while awaiting the response

TaskException - if the server returns an unexpected HTTP status

importCsv

public List<Task> importCsv(String csv)
                     throws IOException,
InterruptedException

Imports Tasks from a CSV document.

Parameters:

csv - CSV document to import

Returns:

templates imported by the server

Throws:

IOException - if the request or response deserialization fails

InterruptedException - if the thread is interrupted while awaiting the response

TaskException - if the server returns an unexpected HTTP status

exportJson

public List<Task> exportJson()
                      throws IOException,
InterruptedException

Exports all Tasks as JSON-compatible objects.

Returns:

templates exported by the server

Throws:

IOException - if response deserialization fails

InterruptedException - if the thread is interrupted while awaiting the response

TaskException - if the server returns an unexpected HTTP status

exportCsv

public String exportCsv()
                 throws IOException,
InterruptedException

Exports all Tasks as CSV.

Returns:

CSV document returned by the server

Throws:

IOException - if the request fails

InterruptedException - if the thread is interrupted while awaiting the response

TaskException - if the server returns an unexpected HTTP status