io.datafx.io

Class RestSourceBuilder<T>

java.lang.Object

io.datafx.io.RestSourceBuilder<T>

Type Parameters:

T - the type of the data that is expected from the REST endpoint.

public class RestSourceBuilder<T>
extends java.lang.Object

Builder class for creating an RestSource.

Field Summary

Fields

Modifier and Type	Field and Description
protected RestSource<T>	restSource

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RestSourceBuilder()

Method Summary

Modifier and Type	Method and Description
RestSource	build() Create the RestSource based on all parameters supplied on this RestSource Builder
RestSourceBuilder	consumerKey(java.lang.String consumerKey) Set the consumer key for this request.
RestSourceBuilder	consumerSecret(java.lang.String consumerSecret) Set the consumer secret for this request.
RestSourceBuilder	contentType(java.lang.String contentType) Set the contentType for this request.
RestSourceBuilder	converter(InputStreamConverter<T> converter) Set the converter that will convert the raw data into object(s) of type T.
static <T> RestSourceBuilder	create() Create a RestSourceBuilder in order to create a RestSource
RestSourceBuilder	dataString(java.lang.String dataString) Explicitly set the datastring for this request.
RestSourceBuilder	formParam(java.lang.String key, java.lang.String value) Add a specific form parameter
RestSourceBuilder	host(java.lang.String host) Set the host parameter for this endpoint.
RestSourceBuilder	path(java.lang.String p) Add a path element to the path that ultimately will point to the endpoint.
RestSourceBuilder	queryParam(java.lang.String key, java.lang.String value) Add a specific query parameter
RestSourceBuilder	requestMethod(java.lang.String requestMethod) Set the request method for this request as a String (e.g.
RestSourceBuilder	timeout(int timeout) Set the timeout value for this instance.

Methods inherited from class java.lang.Object

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

Field Detail

restSource

protected RestSource<T> restSource

Constructor Detail

RestSourceBuilder

protected RestSourceBuilder()

Method Detail

create

public static <T> RestSourceBuilder create()

Create a RestSourceBuilder in order to create a RestSource

Type Parameters:

T - the type of the data that is expected from the REST endpoint.

Returns:

This RestSourceBuilder

converter

public RestSourceBuilder converter(InputStreamConverter<T> converter)

Set the converter that will convert the raw data into object(s) of type T.

Parameters:

converter - the Converter that will be used to convert raw data into object(s) of type T

Returns:

This RestSourceBuilder

path

public RestSourceBuilder path(java.lang.String p)

Add a path element to the path that ultimately will point to the endpoint.

Parameters:

p - the path element

Returns:

This RestSourceBuilder

requestMethod

public RestSourceBuilder requestMethod(java.lang.String requestMethod)

Set the request method for this request as a String (e.g. "POST", "GET")

Parameters:

requestMethod - the requestMethod to set

Returns:

This RestSourceBuilder

queryParam

public RestSourceBuilder queryParam(java.lang.String key,
                                    java.lang.String value)

Add a specific query parameter

Parameters:

key - the key for the query parameter

value - the value for the query parameter

Returns:

This RestSourceBuilder

formParam

public RestSourceBuilder formParam(java.lang.String key,
                                   java.lang.String value)

Add a specific form parameter

Parameters:

key - the key for the form parameter

value - the value for the form parameter

Returns:

This RestSourceBuilder

dataString

public RestSourceBuilder dataString(java.lang.String dataString)

Explicitly set the datastring for this request. This is useful for POST requests with a body.

Parameters:

dataString - the dataString to set

Returns:

This RestSourceBuilder

consumerKey

public RestSourceBuilder consumerKey(java.lang.String consumerKey)

Set the consumer key for this request.

Parameters:

consumerKey - the consumerKey to set

Returns:

This RestSourceBuilder

consumerSecret

public RestSourceBuilder consumerSecret(java.lang.String consumerSecret)

Set the consumer secret for this request.

Parameters:

consumerSecret - the consumer secret to set

Returns:

This RestSourceBuilder

contentType

public RestSourceBuilder contentType(java.lang.String contentType)

Set the contentType for this request. If the contentType is not set, and form parameters or a post body is used, the contentType will be set to "application/x-www-form-urlencoded"

Parameters:

contentType - the contentType to set

Returns:

This RestSourceBuilder

host

public RestSourceBuilder host(java.lang.String host)

Set the host parameter for this endpoint.

Parameters:

host - the host parameter for this endpoint.

Returns:

This RestSourceBuilder

timeout

public RestSourceBuilder timeout(int timeout)

Set the timeout value for this instance.

Parameters:

timeout - the timeout value

Returns:

This RestSouceBuilder

build

public RestSource build()

Create the RestSource based on all parameters supplied on this RestSource Builder

Returns:

the created RestSource