Constructor #

This is the main entry point to communicate with Kuzzle. Every other object inherits properties from the Kuzzle object.

Kuzzle(host, [options], [callback]) #

Options #

Notes:

• the offlineMode option only accepts the manual and auto values

Properties #

Notes:

• if connect is set to manual, the connect method will have to be called manually
• the kuzzle instance will automatically queue all requests, and play them automatically once a first connection is established, regardless of the connect or offline mode option values.
• multiple methods allow passing specific volatile data. These volatile data will be merged with the global Kuzzle volatile object when sending the request, with the request specific volatile taking priority over the global ones.
• the queueFilter property is a function taking a JSON object as an argument. This object is the request sent to Kuzzle, following the Kuzzle API format
• if queueTTL is set to 0, requests are kept indefinitely
• The offline buffer acts like a first-in first-out (FIFO) queue, meaning that if the queueMaxSize limit is reached, older requests are discarded to make room for new requests
• if queueMaxSize is set to 0, an unlimited number of requests is kept until the buffer is flushed
• the offlineQueueLoader must be set with a function, taking no argument, and returning an array of objects containing a query member with a Kuzzle query to be replayed, and an optional cb member with the corresponding callback to invoke with the query result
• updates to host, port, autoReconnect, reconnectionDelay and sslConnection properties will only take effect on next connect call

Callback response #

If the connection succeeds, resolves to the Kuzzle object itself. If the connect option is set to manual, the callback will be called after the connect method is resolved.

Usage #

import io.kuzzle.sdk.core.Kuzzle;
import io.kuzzle.sdk.core.Options;
Options options = new Options();
options.setDefaultIndex("some index")
  .setAutoReconnect(true),
  .setHeaders(new JSONObject().put("someheader", "value"))
  .setPort(7512);
Kuzzle kuzzle = new Kuzzle("localhost", options, new ResponseListener<Void>() {
  @Override
  public void onSuccess(Void object) {
    // invoked once connected, object contains the kuzzle instance
  }
  @Override
  public void onError(JSONObject error) {
    // Handle connection error
  }
});