Essential Classes and Interfaces

Class Name

Description

RemoteServer

A container for server connection parameters (address, port, username and password). An instance of this class is passed to the constructor of RemoteServerController.

RemoteServerController

This class is used to establish and control a connection with the Iotellect Server. It provides access to a ContextManager interface which, in turns, lets you access the server's context tree.

ContextManager

An interface that provides access to the context tree. An instance of the class implementing this interface may be retrieved from the RemoteServerController through the getContextManager() method.

Context

An interface letting you work with a single context. Instances of classes implementing this interface are returned by different methods of ContextManager.

VariableDefinition

Definition of the context variable. Provides access to its properties, format, getter and setter.

FunctionDefinition

Definition of the context function. Provides access to its properties, input/output formats and implementation.

EventDefinition

Definition of the context event. Provides access to its properties and format.

VariableGetter

Implementations of this interface should provide custom variable value reading logic.

VariableSetter

Implementations of this interface should provide custom variable value writing logic.

FunctionImplementation

Implementations of this interface should provide custom function execution logic, i.e. processing of input and generation of output.

ContextEventListener

A base interface for context event listeners. The listener's handle() method is called when event is fired in the context to that the listener was added.

DefaultContextEventListener

Default implementation of ContextEventListener. Generally, most listeners should extend this class.

DataTable

An interface defining the operations applicable to Data Tables, including operations that provide access to the format and records of the table. Instances of this type are returned by getVariable() and callFunction() methods of Context.

AbstractDataTable

A skeletal implementation of DataTable interface. It implements methods, the implementations of which are considered to be common to most Data Tables.

SimpleDataTable

Primary implementation of DataTable. It is based on a list of data records.

DataRecord

Implementation of a single Data Table record.

TableFormat

Class implementing the format of a Data Table. It includes table properties and a list of fields.

FieldFormat

Class implementing the format of a single Data Table field. Defines name, type and other parameters of the field, including validators, selection values etc.

CallerController

The instance of this class is passed to many context operations. It incorporates permissions of the calling side.

UncheckedCallerController

A special type of caller controller that suppress any permission checking, giving full access to the calling side. Should be used for system calls.

Permissions

A list of permissions (Permission objects) what must be satisfied when accessing a certain server resource.

ServerPermissionChecker

This class provides a set of static methods for getting Permissions to assign for newly added variable/function/event definitions.