Class DomainTemplateClient

java.lang.Object

fr.tiogars.template.client.DomainTemplateClient

public class DomainTemplateClient
extends Object

Provides HTTP access to the DomainTemplate API.

Since:

0.1.0

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class Object

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

Constructor Details

DomainTemplateClient

public DomainTemplateClient(URI baseUri)

Creates a client backed by the default Java HTTP client.

Parameters:

baseUri - base URI of the server

Method Details

create

public DomainTemplate create(CreateDomainTemplateRequest request)
                      throws IOException,
InterruptedException

Creates a DomainTemplate.

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

DomainTemplateException - if the server returns an unexpected HTTP status

findAll

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

Lists all DomainTemplates.

Returns:

templates returned by the server

Throws:

IOException - if response deserialization fails

InterruptedException - if the thread is interrupted while awaiting the response

DomainTemplateException - if the server returns an unexpected HTTP status

findById

public DomainTemplate findById(long id)
                        throws IOException,
InterruptedException

Finds a DomainTemplate 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

DomainTemplateException - if the server returns an unexpected HTTP status

update

public DomainTemplate update(long id,
 UpdateDomainTemplateRequest request)
                      throws IOException,
InterruptedException

Updates a DomainTemplate.

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

DomainTemplateException - if the server returns an unexpected HTTP status

delete

public void delete(long id)
            throws IOException,
InterruptedException

Deletes a DomainTemplate.

Parameters:

id - persistent template identifier

Throws:

IOException - if the request fails

InterruptedException - if the thread is interrupted while awaiting the response

DomainTemplateException - if the server returns an unexpected HTTP status

seed

public List<DomainTemplate> seed(List<CreateDomainTemplateRequest> requests)
                          throws IOException,
InterruptedException

Seeds DomainTemplates 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

DomainTemplateException - if the server returns an unexpected HTTP status

importJson

public List<DomainTemplate> importJson(List<CreateDomainTemplateRequest> requests)
                                throws IOException,
InterruptedException

Imports DomainTemplates 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

DomainTemplateException - if the server returns an unexpected HTTP status

importCsv

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

Imports DomainTemplates 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

DomainTemplateException - if the server returns an unexpected HTTP status

exportJson

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

Exports all DomainTemplates 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

DomainTemplateException - if the server returns an unexpected HTTP status

exportCsv

public String exportCsv()
                 throws IOException,
InterruptedException

Exports all DomainTemplates 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

DomainTemplateException - if the server returns an unexpected HTTP status