Основные классы и интерфейсы

Ниже приведенная таблица кратко описывает самые важные классы и интерфейсы AggreGate SDK.

Имя класса

Описание

RemoteServer

Контейнер для параметров соединения сервера (адрес, порт, имя пользователя и его пароль). Экземпляр этого класса передается в конструктор RemoteServerController.

RemoteServerController

Этот класс используется для установки соединения и осуществления контроля за ним с AggreGate Server. Он предоставляет доступ к интерфейсу ContextManager, который, в свою очередь, предоставляет доступ к контекстному дереву сервера.

ContextManager

Интерфейс, который предоставляет доступ к контекстному дереву. Экземпляр класса, реализующего этот интерфес, можно получить из RemoteServerController посредством метода getContextManager().

Context

Интерфейс, который позволяет работать с отдельным контекстом. Экземпляры классов, реализующих этот интерфейс, возвращаются различными методами ContextManager.

VariableDefinition

Определение переменной контекста. Предоставляет доступ к его свойствам, формату, объектам получения и установки значений.

FunctionDefinition

Определение функции контекста. Предоставляет доступ к его свойствам, форматам ввода/вывода и реализации

EventDefinition

Определение события контекста. Предоставляет доступ к его свойствам и формату.

VariableGetter

Реализация данного интерфейса должна предоставлять логику чтения для значения пользовательской переменной.

VariableSetter

Реализация данного интерфейса должна предоставлять логику записи значения пользовательской переменной.

FunctionImplementation

Реализация данного интерфейса должна предоставлять логику исполнения пользовательской функции, т.е. обработки ввода и генерирования вывода.

ContextEventListener

Основной интерфейс для приемников событий контекста. Метод обращения приемника handle() вызывается, когда событие запускается в контексте, к которому был добавлен приемник.

DefaultContextEventListener

Реализация ContextEventListener по умолчанию. Как правило, большинство приемников должны расширять этот класс.

DataTable

Интерфейс, определяющий операции, применимые к Таблицам данных. Включает операции по предоставлению доступа к формату и записям таблицы. Экземпляры данного класса возвращают методы getVariable() и callFunction() , относящиеся к Context.

AbstractDataTable

Макетная реализация интерфейса DataTable. Реализует методы, которые считаются общими для большинства Таблиц данных.

SimpleDataTable

Первичная реализация DataTable на основе перечня записей данных.

DataRecord

Реализация одной записи Таблицы данных.

TableFormat

Класс, реализующий формат Таблицы данных. Включает свойства таблицы и список полей.

FieldFormat

Класс, реализующий формат отдельного поля Таблицы данных. Определяет имя, тип и другие параметры поля, включая валидаторы, значения выбора и пр.

CallerController

Экземпляр данного класса передается множеству операций контекста. Он включает в себя права доступа запрашивающей стороны.

UncheckedCallerController

Особый тип контроллера запрашиваюшего объекта, который запрещает любую проверку прав доступа, предоставляя полный доступ запрашивающей стороне. Должно использоваться для системных вызовов.

Permissions

Список всех прав доступа (объекты Permission), которые должны быть удовлетворены во время доступа к определенным ресурсам сервера.

ServerPermissionChecker

Этот класс предоставляет набор статических методов для получения Permissions, чтобы назначить для только что добавленных определений переменной/функции/события.