Server API

The Iotellect Server open-source Application Programming Interface for Java (Iotellect Server Java API) lets you control, configure and monitor Iotellect Server and all hardware devices that are working within a single Iotellect installation remotely from any application written in the Java programming language.

Using this API, you can:

• Access server resources and connected devices;

• Modify server and device configuration;

• Execute server and device operations;

• Acquire server and device events;

Technically, the Java API provides the following functionality:

• Full access to the server contexts through a so-called proxy context tree;

• Getting and setting values of context variables;

• Calling context functions;

• Listening for context events;

• Creating and manipulating Data Tables;

• Executing context actions

All communications with Iotellect Server are performed over IP, through a single SSL-secured TCP connection using Iotellect Communications Protocol.

This section provides step-by-step instructions for establishing connection with a remote Iotellect Server from a Java application.

Start with creating a RemoteServer object:

RemoteServer rls = new RemoteServer("localhost", RemoteServer.DEFAULT_PORT, "admin", "admin");

You need to specify the following parameters in RemoteServer's constructor:

• IP address of host name of remote Iotellect Server

• Port number to connect to (6460 by default)

• Name of user account to use for authentication (username)

• Password for the user account

Next, create a RemoteServerController. It will be used for managing server connection:

RemoteServerController rlc = new RemoteServerController(rls, true);

Establish a connection with the server by calling connect() method:

rlc.connect();

Connection will fail if:

• Server is not running;

• Server remote API is disabled;

• Address/port are not correct;

• Versions of Iotellect Server and API libraries are not compatible.

At this point, your application has established TCP connection, completed SSL handshake and exchanged basic information with the Iotellect Server. To perform some valuable operations, you need to authorize on the server to obtain a certain permission level. This is carried out by calling login() method of the server controller:

rlc.login();

The call will fail if login/password specified in the RemoteServer constructor are incorrect.

Now it's possible to get an instance of ContextManager from the controller. This is proxy context tree those structure and operation mimics remote Iotellect Server's context tree:

ContextManager cm = rlc.getContextManager();

All further essential Iotellect Server data management operations are performed by calling variable/function/event-related methods of different proxy contexts provided by proxy context manager.

See Working With Contexts for details.

Call disconnect() method of the Iotellect Server controller to close the connection.

Was this page helpful?

Tell us more

Send

Thank you!