io.georocket.client

Class AbstractClient

java.lang.Object

io.georocket.client.AbstractClient

Direct Known Subclasses:

StoreClient

public class AbstractClient
extends java.lang.Object

A client connecting to the GeoRocket api

Since:

1.1.0

Author:

Tim Hellhake

Field Summary

Fields

Modifier and Type	Field and Description
protected io.vertx.core.http.HttpClient	client HTTP client used to connect to GeoRocket

Constructor Summary

Constructors

Constructor and Description
AbstractClient(io.vertx.core.http.HttpClient client) Construct a new client using the given HTTP client

Method Summary

Modifier and Type	Method and Description
protected io.vertx.core.http.HttpClientRequest	configureRequest(io.vertx.core.http.HttpClientRequest request) Configure an HTTP request.
protected static <T> void	fail(io.vertx.core.http.HttpClientResponse response, io.vertx.core.Handler<io.vertx.core.AsyncResult<T>> handler) Parses an HTTP response and calls the given handler with the parsed error message
protected static <T> void	fail(io.vertx.core.http.HttpClientResponse response, io.vertx.core.Handler<io.vertx.core.AsyncResult<T>> handler, java.util.function.Function<java.lang.String,java.lang.Throwable> map) Parses an HTTP response, maps it to an exception and then calls the given handler
protected void	getWithParameter(java.lang.String endpoint, java.lang.String parameterName, java.lang.String parameterValue, java.lang.String query, java.lang.String layer, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.core.streams.ReadStream<io.vertx.core.buffer.Buffer>>> handler) Execute a get request with specified path, query and additional parameter
protected java.lang.String	prepareQuery(java.lang.String query, java.lang.String layer) Prepare a query.
protected void	update(io.vertx.core.http.HttpMethod method, java.lang.String fieldEndpoint, java.lang.String fieldName, java.lang.String query, java.lang.String layer, java.util.List<java.lang.String> updates, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>> handler) Update a field in the chunk metadata (such as properties or tags).
protected java.lang.String	urlencode(java.lang.String str) Convenience method to URL-encode a string

Methods inherited from class java.lang.Object

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

Field Detail

client

protected final io.vertx.core.http.HttpClient client

HTTP client used to connect to GeoRocket

Constructor Detail

AbstractClient

public AbstractClient(io.vertx.core.http.HttpClient client)

Construct a new client using the given HTTP client

Parameters:

client - the HTTP client

Method Detail

getWithParameter

protected void getWithParameter(java.lang.String endpoint,
                                java.lang.String parameterName,
                                java.lang.String parameterValue,
                                java.lang.String query,
                                java.lang.String layer,
                                io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.core.streams.ReadStream<io.vertx.core.buffer.Buffer>>> handler)

Execute a get request with specified path, query and additional parameter

Parameters:

endpoint - the endpoint

parameterName - the name of the query parameter

parameterValue - the value of the query parameter

query - a search query specifying which chunks to return (may be null)

layer - the name of the layer where to search for chunks recursively (may be null)

handler - a handler that will receive the ReadStream from which the results matching the given criteria can be read

update

protected void update(io.vertx.core.http.HttpMethod method,
                      java.lang.String fieldEndpoint,
                      java.lang.String fieldName,
                      java.lang.String query,
                      java.lang.String layer,
                      java.util.List<java.lang.String> updates,
                      io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>> handler)

Update a field in the chunk metadata (such as properties or tags).

The chunks are either specified by a query or layer information or both. If none is given, all chunks in the data store will be updated.

Parameters:

method - the http method to use for the update

fieldEndpoint - the path of the endpoint which should be used

fieldName - the name of the field to update

query - a search query specifying the chunks, whose fields should be updated (or null if the fields of all chunks in all sub-layers from the given layer should be updated)

layer - the absolute path to the layer from which to update fields (or null if the entire store should be queried to find the chunks, whose fields should be updated)

updates - a collection of values to update

handler - a handler that will be called when the operation has finished

Since:

1.1.0

prepareQuery

protected java.lang.String prepareQuery(java.lang.String query,
                                        java.lang.String layer)

Prepare a query. Generate a query path for the given search query and layer.

Parameters:

query - the search query (may be null)

layer - the layer to export (may be null)

Returns:

the query path

urlencode

protected java.lang.String urlencode(java.lang.String str)

Convenience method to URL-encode a string

Parameters:

str - the string

Returns:

the encoded string

configureRequest

protected io.vertx.core.http.HttpClientRequest configureRequest(io.vertx.core.http.HttpClientRequest request)

Configure an HTTP request. The default implementation of this method does nothing. Sub-classes may override if they want to configure a request before it is sent.

Parameters:

request - request the request to configure

Returns:

same HttpClientRequest as given but with options set

fail

protected static <T> void fail(io.vertx.core.http.HttpClientResponse response,
                               io.vertx.core.Handler<io.vertx.core.AsyncResult<T>> handler)

Parses an HTTP response and calls the given handler with the parsed error message

Type Parameters:

T - the type of the handler's result

Parameters:

response - the HTTP response

handler - the handler to call

fail

protected static <T> void fail(io.vertx.core.http.HttpClientResponse response,
                               io.vertx.core.Handler<io.vertx.core.AsyncResult<T>> handler,
                               java.util.function.Function<java.lang.String,java.lang.Throwable> map)

Parses an HTTP response, maps it to an exception and then calls the given handler

Type Parameters:

T - the type of the handler's result

Parameters:

response - the HTTP response

handler - the handler to call

map - a function that maps the parsed error message to an exception