io.georocket.client

Class GeoRocketClient

java.lang.Object

io.georocket.client.GeoRocketClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class GeoRocketClient
extends Object
implements Closeable

Provides interface to perform operations against a GeoRocket server

Since:

1.0.0

Author:

Michel Kraemer

Field Summary

Fields

Modifier and Type	Field and Description
protected HttpClient	client HTTP client used to connect to GeoRocket
static String	DEFAULT_HOST Default server host: "localhost"
static int	DEFAULT_PORT Default server port: 63020

Constructor Summary

Constructors

Constructor and Description
GeoRocketClient(HttpClient client) Create a client connecting to GeoRocket through the given HTTP client
GeoRocketClient(HttpClientOptions options, Vertx vertx) Create a client connecting to GeoRocket running with specified options
GeoRocketClient(String host, int port, Vertx vertx) Create a client connecting to GeoRocket running on the specified host and port
GeoRocketClient(String host, Vertx vertx) Create a client connecting to GeoRocket running on the specified host and the default port 63020
GeoRocketClient(Vertx vertx) Create a client connecting to GeoRocket running on "localhost":63020

Method Summary

Modifier and Type	Method and Description
void	close() Close this client and release all resources
StoreClient	getStore() Create a new client accessing the GeoRocket data store

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_HOST

public static final String DEFAULT_HOST

Default server host: "localhost"

See Also:

Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

Default server port: 63020

See Also:

Constant Field Values

client

protected final HttpClient client

HTTP client used to connect to GeoRocket

Constructor Detail

GeoRocketClient

public GeoRocketClient(Vertx vertx)

Create a client connecting to GeoRocket running on "localhost":63020

Parameters:

vertx - a Vert.x instance used to create a HTTP client

GeoRocketClient

public GeoRocketClient(String host,
                       Vertx vertx)

Create a client connecting to GeoRocket running on the specified host and the default port 63020

Parameters:

host - the GeoRocket host

vertx - a Vert.x instance used to create a HTTP client

GeoRocketClient

public GeoRocketClient(String host,
                       int port,
                       Vertx vertx)

Create a client connecting to GeoRocket running on the specified host and port

Parameters:

host - the GeoRocket host

port - the GeoRocket port

vertx - a Vert.x instance used to create a HTTP client

GeoRocketClient

public GeoRocketClient(HttpClientOptions options,
                       Vertx vertx)

Create a client connecting to GeoRocket running with specified options

Parameters:

options - options for HTTP client

vertx - a Vert.x instance used to create a HTTP client

GeoRocketClient

public GeoRocketClient(HttpClient client)

Create a client connecting to GeoRocket through the given HTTP client

Parameters:

client - the HTTP client

Method Detail

close

public void close()

Close this client and release all resources

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

getStore

public StoreClient getStore()

Create a new client accessing the GeoRocket data store

Returns:

the store client