io.datafx.io

Class RestSource<T>

java.lang.Object

io.datafx.io.AbstractDataReader<T>

io.datafx.io.InputStreamDataReader<T>

io.datafx.io.RestSource<T>

Type Parameters:

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

All Implemented Interfaces:

DataReader<T>, WritableDataReader<T>, java.lang.Iterable<T>

Direct Known Subclasses:

SSERestSource

public class RestSource<T>
extends InputStreamDataReader<T>
implements WritableDataReader<T>

Client class that is used to create a request to an external REST endpoint.

Property Summary

Type	Property and Description
javafx.beans.property.ReadOnlyIntegerProperty	responseCode Gets the status code from an HTTP response message.
javafx.beans.property.ReadOnlyStringProperty	responseMessage Gets the HTTP response message, if any, returned along with the response code from a server.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	METHOD_GET
static java.lang.String	METHOD_POST
protected boolean	requestMade

Constructor Summary

Constructors

Constructor and Description
RestSource() Create a new RestSource
RestSource(java.lang.String host, InputStreamConverter<T> converter) Create a new RestSource and specifies the endpoint and the converter

Method Summary

Modifier and Type	Method and Description
java.io.InputStream	createInputStream() Create the InputStream for this request.
protected void	createRequest()
T	get() Obtain the next entity of data.
java.lang.String	getConsumerKey() Return the consumer key (used with oauth) for this request
java.lang.String	getConsumerSecret() Return the consumer secret (if used with oauth) for this request
java.lang.String	getContentType()
java.lang.String	getDataString() Return the datastring that will be send with this request
MultiValuedMap	getFormParams() Return a MultiValuedMap for the form parameters in this request.
java.util.Map<java.lang.String,java.lang.String>	getQueryParams() Return the query parameters as a Map
java.lang.String	getRequestMethod() Return the request method for this request.
java.util.Map<java.lang.String,java.lang.String>	getRequestProperties() Return the request properties as a Map
int	getResponseCode() Gets the value of the property responseCode.
java.lang.String	getResponseMessage() Gets the value of the property responseMessage.
int	getTimeout() Get the timeout value specified for this instance
boolean	next() Check if more data is available on this DataReader.
javafx.beans.property.ReadOnlyIntegerProperty	responseCodeProperty() Gets the status code from an HTTP response message.
javafx.beans.property.ReadOnlyStringProperty	responseMessageProperty() Gets the HTTP response message, if any, returned along with the response code from a server.
void	setConsumerKey(java.lang.String consumerKey) Set the consumer key for this request.
void	setConsumerSecret(java.lang.String consumerSecret) Set the consumer secret
void	setContentType(java.lang.String contentType) Set the contentType for this request.
void	setDataString(java.lang.String dataString) Explicitly set the datastring for this request.
void	setFormParams(java.util.Map<java.lang.String,java.lang.String> formParams) Set the form parameters as a Map.
void	setFormParams(MultiValuedMap formParams) Set the form parameters as a MultiValuedMap
void	setHost(java.lang.String host) Set the host parameter for this endpoint.
void	setPath(java.lang.String path) Explicitly sets the path for this resource.
void	setQueryParams(java.util.Map<java.lang.String,java.lang.String> queryParams) Set the query parameters as a Map
void	setRequestMethod(java.lang.String requestMethod) Set the request method for this request as a String (e.g.
void	setRequestProperties(java.util.Map<java.lang.String,java.lang.String> requestProperties) Set the request properties as a Map
void	setTimeout(int timeout) Set the timeout value for this instance.
void	writeBack() Initiates the writeback call.

Methods inherited from class io.datafx.io.InputStreamDataReader

getConverter, getInputStream, setConverter, setInputStream

Methods inherited from class io.datafx.io.AbstractDataReader

iterator

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Property Detail

responseCode

public javafx.beans.property.ReadOnlyIntegerProperty responseCodeProperty

Gets the status code from an HTTP response message.

See Also:

getResponseCode()

responseMessage

public javafx.beans.property.ReadOnlyStringProperty responseMessageProperty

Gets the HTTP response message, if any, returned along with the response code from a server.

See Also:

getResponseMessage()

Field Detail

METHOD_GET

public static final java.lang.String METHOD_GET

See Also:

Constant Field Values

METHOD_POST

public static final java.lang.String METHOD_POST

See Also:

Constant Field Values

requestMade

protected boolean requestMade

Constructor Detail

RestSource

public RestSource()

Create a new RestSource

RestSource

public RestSource(java.lang.String host,
                  InputStreamConverter<T> converter)

Create a new RestSource and specifies the endpoint and the converter

Parameters:

host - the host parameter of the endpoint

converter - the Converter that will be used to convert the raw data into Java objects of type T.

Method Detail

setHost

public void setHost(java.lang.String host)

Set the host parameter for this endpoint.

Parameters:

host - the host parameter for this endpoint.

setPath

public void setPath(java.lang.String path)

Explicitly sets the path for this resource.

Parameters:

path - the path. If null, the path will be the empty String

createRequest

protected void createRequest()
                      throws java.io.IOException

Throws:

java.io.IOException

get

public T get()
      throws java.io.IOException

Description copied from interface: DataReader

Obtain the next entity of data. In case the data is a single entity, this method returns all data. In case the data is a list, this method returns the next entity and moves a pointer to the subsequent entity, if any

Specified by:

get in interface DataReader<T>

Overrides:

get in class InputStreamDataReader<T>

Returns:

the next available data entity or null if no new data can be retrieved

Throws:

java.io.IOException - in case an exception occurs while reading data

next

public boolean next()

Description copied from interface: DataReader

Check if more data is available on this DataReader. This method will only return false if no data is available. It should not return false in case data will be available at a later time. Calling this method on a DataReader that does not support lists always returns false

Specified by:

next in interface DataReader<T>

Overrides:

next in class InputStreamDataReader<T>

Returns:

true in case more data is available and obtainable via a get() call, false otherwise.

createInputStream

public java.io.InputStream createInputStream()
                                      throws java.io.IOException

Create the InputStream for this request. This method does all the required initialization, and passes the appropriate parameters. When the server responds with an HTTP error code, the returned InputStream will be the errorStream of the URL connection instead and no IOException will be thrown. This allows the coupled Converter to continue parsing the response from the server. In case no requestMethod is specified via setRequestMethod, a POST request will be created in case form parameters or a dataString are supplied; a GET request will be created in the other cases.

Returns:

the created InputStream

Throws:

java.io.IOException - in case the InputStream cannot be created successfully.

getConsumerKey

public java.lang.String getConsumerKey()

Return the consumer key (used with oauth) for this request

Returns:

the consumerKey

setConsumerKey

public void setConsumerKey(java.lang.String consumerKey)

Set the consumer key for this request.

Parameters:

consumerKey - the consumerKey to set

getConsumerSecret

public java.lang.String getConsumerSecret()

Return the consumer secret (if used with oauth) for this request

Returns:

the consumerSecret

setConsumerSecret

public void setConsumerSecret(java.lang.String consumerSecret)

Set the consumer secret

Parameters:

consumerSecret - the consumerSecret to set

getRequestProperties

public java.util.Map<java.lang.String,java.lang.String> getRequestProperties()

Return the request properties as a Map

Returns:

the requestProperties

setRequestProperties

public void setRequestProperties(java.util.Map<java.lang.String,java.lang.String> requestProperties)

Set the request properties as a Map

Parameters:

requestProperties - the requestProperties to set

getQueryParams

public java.util.Map<java.lang.String,java.lang.String> getQueryParams()

Return the query parameters as a Map

Returns:

the queryParams

setQueryParams

public void setQueryParams(java.util.Map<java.lang.String,java.lang.String> queryParams)

Set the query parameters as a Map

Parameters:

queryParams - the queryParams to set. If null, this call is ignored

getFormParams

public MultiValuedMap getFormParams()

Return a MultiValuedMap for the form parameters in this request.

Returns:

the formParams

setFormParams

public void setFormParams(java.util.Map<java.lang.String,java.lang.String> formParams)

Set the form parameters as a Map. This is a convenience method, as form parameters can also be passed as a MultiValuedMap

Parameters:

formParams - the formParams to set

setFormParams

public void setFormParams(MultiValuedMap formParams)

Set the form parameters as a MultiValuedMap

Parameters:

formParams - the formParams to set

getDataString

public java.lang.String getDataString()

Return the datastring that will be send with this request

Returns:

the dataString

setDataString

public void setDataString(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

getRequestMethod

public java.lang.String getRequestMethod()

Return the request method for this request.

Returns:

the requestMethod

setRequestMethod

public void setRequestMethod(java.lang.String requestMethod)

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

Parameters:

requestMethod - the requestMethod to set

writeBack

public void writeBack()

Description copied from interface: WritableDataReader

Initiates the writeback call. It is up to the implementation class to do what is required for writing the data back to the original data source

Specified by:

writeBack in interface WritableDataReader<T>

getTimeout

public int getTimeout()

Get the timeout value specified for this instance

Returns:

the timeout value

setTimeout

public void setTimeout(int timeout)

Set the timeout value for this instance.

Parameters:

timeout - the timeout value

getContentType

public java.lang.String getContentType()

setContentType

public void setContentType(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

getResponseCode

public int getResponseCode()

Gets the value of the property responseCode.

Returns:

the value of the property responseCode

responseCodeProperty

public javafx.beans.property.ReadOnlyIntegerProperty responseCodeProperty()

Gets the status code from an HTTP response message.

See Also:

getResponseCode()

getResponseMessage

public java.lang.String getResponseMessage()

Gets the value of the property responseMessage.

Returns:

the value of the property responseMessage

responseMessageProperty

public javafx.beans.property.ReadOnlyStringProperty responseMessageProperty()

Gets the HTTP response message, if any, returned along with the response code from a server.

See Also:

getResponseMessage()