io.cimpress.tagliatelle

Class ClientRequest

java.lang.Object

io.cimpress.tagliatelle.ClientRequest

public class ClientRequest
extends Object

The higher level request object. Its supplementary role is to capture more advanced use cases around calling the low level api, e.g: - adding tag vs updating tag has in most use cases little significance - if the user doesn't store tag id, removing a tag requires at least two calls, and that can be abstracted away for most users

Field Summary

Fields

Modifier and Type	Field and Description
private LowLevelClient	lowLevelClient Low level client abstraction for invoking commands on the API
private TagRequest	tagRequest Request object holding all properties of the tag

Constructor Summary

Constructors

Constructor and Description
ClientRequest(String accessToken)
ClientRequest(String accessToken, String urlOverride)

Method Summary

Modifier and Type	Method and Description
void	apply()
TagBulkResponse	fetch()
private <T> void	handleErrorCondition(com.mashape.unirest.http.HttpResponse<T> response)
private TagBulkResponse	handleOperationFetch()
private void	handleOperationTag()
private void	handleOperationUntag()
void	remove()
ClientRequest	withKey(String tagKey) Fluent command for specifying the key of the tag
ClientRequest	withObjectValue(Object value)
ClientRequest	withResource(String resourceUri) Fluent command for specifying the resource the tag should refer to
ClientRequest	withStringValue(String value) Optionally it is possible to attach opaque metadata to the tag.

Methods inherited from class java.lang.Object

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

Field Detail

tagRequest

private final TagRequest tagRequest

Request object holding all properties of the tag

lowLevelClient

private LowLevelClient lowLevelClient

Low level client abstraction for invoking commands on the API

Constructor Detail

ClientRequest

ClientRequest(String accessToken)

ClientRequest

ClientRequest(String accessToken,
              String urlOverride)

Method Detail

withResource

public ClientRequest withResource(String resourceUri)

Fluent command for specifying the resource the tag should refer to

Parameters:

resourceUri - Resource url the tag should be attached to.

Returns:

withKey

public ClientRequest withKey(String tagKey)

Fluent command for specifying the key of the tag

Parameters:

tagKey - Key of the tag is a user provided URN that describes the tag. The fact that that the key is a URN, gives freedom for the user to model hierarchy and other aspects of their tag

Returns:

withStringValue

public ClientRequest withStringValue(String value)

Optionally it is possible to attach opaque metadata to the tag.

Parameters:

value -

Returns:

withObjectValue

public ClientRequest withObjectValue(Object value)
                              throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

handleErrorCondition

private <T> void handleErrorCondition(com.mashape.unirest.http.HttpResponse<T> response)
                               throws UnauthorizedException,
                                      ForbiddenException

Throws:

UnauthorizedException

ForbiddenException

apply

public void apply()
           throws Exception

Throws:

Exception

remove

public void remove()
            throws Exception

Throws:

Exception

fetch

public TagBulkResponse fetch()
                      throws Exception

Throws:

Exception

handleOperationFetch

private TagBulkResponse handleOperationFetch()
                                      throws ExecutionException,
                                             InterruptedException

Throws:

ExecutionException

InterruptedException

handleOperationUntag

private void handleOperationUntag()
                           throws InterruptedException,
                                  ExecutionException,
                                  UnauthorizedException,
                                  ForbiddenException

Throws:

InterruptedException

ExecutionException

UnauthorizedException

ForbiddenException

handleOperationTag

private void handleOperationTag()
                         throws Exception

Throws:

Exception