com.flowthings.client.api

Class Request<S>

java.lang.Object

com.flowthings.client.api.Request<S>

Type Parameters:

S - the object type

public class Request<S>
extends Object

A Request object represents a command that can be sent to flowthings.io, e.g to Create, Get, Find, Update or Delete and object. These apply to the common flowthings.io objects, such as Flows, Tracks, and Drops.

In most cases, requests can be sent over any of the APIs (REST, WebSockets). If the request is naturally idempotent, such as Find or Get, they can be reused multiple times.

 
  
  Credentials credentials = new Credentials(accountName, tokenString);
  RestApi api = new RestApi(credentials);
  
  List<Flow> results = api.send(Flowthings.flow().find(new QueryOptions().limit(5)));
 
 

Author:

matt

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Request.Action

Field Summary

Fields

Modifier and Type	Field and Description
protected Request.Action	action
protected String	body
protected S	bodyObject
protected String	flowId
protected String	id
protected boolean	listResponse
protected static Logger	logger
protected String	member
protected Map<String,Object>	otherData
protected QueryOptions	queryOptions
protected Types	type
protected com.google.gson.reflect.TypeToken<? extends Response<S>>	typeToken

Constructor Summary

Constructors

Constructor and Description
Request(Request.Action action, Types type, com.google.gson.reflect.TypeToken<? extends Response<S>> typeToken, boolean listResponse)

Method Summary

Modifier and Type	Method and Description
Request<S>	addData(String k, Object o)
Request<S>	body(S s)
String	buildHttpPath(Credentials credentials, String url)
static <S> Request<List<S>>	createListRequest(Class<S> domainObjectType, Request.Action action)
static <S> Request<S>	createObjectRequest(Class<S> domainObjectType, Request.Action action)
Request<S>	flowId(String flowId)
Request<S>	id(String id)
Request<S>	member(String member)
Request<S>	params(QueryOptions queryOptions)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static Logger logger

id

protected String id

queryOptions

protected QueryOptions queryOptions

body

protected String body

typeToken

protected com.google.gson.reflect.TypeToken<? extends Response<S>> typeToken

action

protected Request.Action action

type

protected Types type

member

protected String member

flowId

protected String flowId

listResponse

protected boolean listResponse

bodyObject

protected S bodyObject

otherData

protected Map<String,Object> otherData

Constructor Detail

Request

public Request(Request.Action action,
               Types type,
               com.google.gson.reflect.TypeToken<? extends Response<S>> typeToken,
               boolean listResponse)

Method Detail

createObjectRequest

public static <S> Request<S> createObjectRequest(Class<S> domainObjectType,
                                                 Request.Action action)

createListRequest

public static <S> Request<List<S>> createListRequest(Class<S> domainObjectType,
                                                     Request.Action action)

member

public Request<S> member(String member)

id

public Request<S> id(String id)

flowId

public Request<S> flowId(String flowId)

params

public Request<S> params(QueryOptions queryOptions)

body

public Request<S> body(S s)

addData

public Request<S> addData(String k,
                          Object o)

buildHttpPath

public String buildHttpPath(Credentials credentials,
                            String url)