Note

You are not reading the most recent version of this documentation.

APIClient

public final class APIClient

This class permits users to access the API methods. Note that whilst APIClient is threadsafe, other API objects are not unless they explicitly state otherwise.

Fields

AUTHENTICATION_HEADER_KEY

static final Metadata.Key<String> AUTHENTICATION_HEADER_KEY

Constructors

APIClient

public APIClient()

Methods

addListener

public synchronized void addListener(ServerStatusListener listener)

finalize

public void finalize()

getChannel

public Channel getChannel()

Internal API

getObject

public synchronized Object getObject(long id)

Internal API

markObjectAsDestroyed

public synchronized void markObjectAsDestroyed(long id)

Internal API

recordNewObject

public synchronized void recordNewObject(long id, Object value)

Internal API

removeListener

public synchronized void removeListener(ServerStatusListener listener)

startServer

public void startServer(String serverPath)

Starts the server process on the given path. This must be called before creating any instances of APIClient.

Parameters:
  • serverPath – an absolute path to the coco-platform-server executable. This will be passed directly to the the constructor of ProcessBuilder.
Throws:
  • IOException – if any error is encountered whilst trying to start the server.

stopServer

public synchronized void stopServer()

Shuts down the server cleanly