Файлы конфигурации контроллера агентов
Конфигурация контроллера агентов задается двумя наборами файлов конфигурации. Один набор задает базовую конфигурацию контроллера агентов,
содержащую параметры по умолчанию. Второй набор представляет собой конфигурацию
встраиваемых модулей, которая описывает параметры контроллера агентов,
относящиеся к встраиваемым модулям. Данный документ содержит подробное
описание обеих конфигураций и рекомендации по созданию расширений конфигурации.
Каталог <install directory> в данном документе соответствует
каталогу, в который распаковывается контроллер агентов. В файлах конфигурации этот каталог обозначается как
%RASERVER_HOME%.
Базовая конфигурация
Базовая конфигурация включает файл
<install directory>/config/serviceconfig.xml, который
создается с помощью схемы XML
<install directory>/config/serviceconfig.xsd. Этот файл
определяет такие параметры по умолчанию, как системные переменные среды,
конфигурации приложений и соединения контроллера агентов. Базовая конфигурация доступна всем конфигурациям и загружается при запуске службы
контроллера агентов. Разработчикам приложений не следует изменять базовую конфигурацию,
поскольку любые ее изменения будут глобальными. Для задания
параметров, характерных для встраиваемых модулей и приложений, должна
использоваться описываемая ниже конфигурации встраиваемых модулей.
Конфигурация встраиваемых модулей
Для каждого пользовательского приложения должны существовать его файл конфигурации и зависимости, помещенные в каталог встраиваемого модуля
<установочный каталог>/модуль/<имя-модуля>, где <имя-модуля> - это уникальное имя, идентифицирующее
приложение. Файл конфигурации встраиваемого модуля pluginconfig.xml должен
находиться в подкаталоге config каталога встраиваемого
модуля. Файлы JAR, как правило размещаются в подкаталоге lib
каталога встраиваемого модуля. При создании файла конфигурации встраиваемых
модулей разработчики могут использовать схему XML <install
directory>/config/pluginconfig.xsd.
Элементы и атрибуты
Элемент: AgentControllerConfiguration
Это корневой элемент базовой конфигурации. Эти параметры используются для
запуска службы контроллера агентов.
Используется следующими элементами: Base Configuration
Подэлементы: AgentControllerEnvironment, Application, Hosts,
Service, Agent, Option, Plugin
Атрибуты:
- activeConfiguration
- указывает, какая конфигурация должна
загружаться при запуске контроллера агентов
- filePort
- укажите порт, по которому слушает служба передачи файлов Контроллера агентов. Значение по умолчанию равно 10005.
- isDataMultiplexed
- укажите следует или нет передавать данные профилирования и протоколов по управляющему каналу Контроллера агентов.
По умолчанию канал данных использует арбитражный порт для передачи данных и может быть заблокирован брандмауэром. При передаче
информации через канал данных открываются предопределенные порты для получения входящих запросов на установку соединения через брандмауэр. Эти порты включают в себя порт по умолчанию 10002, защищенный порт 10003 и порт файлового сервера 10005. Значение по умолчанию данного атрибута равно false.
- jvm
- полный путь для динамически загружаемой библиотеки виртуальной
машины Java (jvm.dll или libjvm.so)
- loggingDetail
- разрешает заносить в протокол номер строки, если
установлен уровень фильтрации HIGH
- loggingDirectory
- каталог, в котором создается файл протокола
контроллера агентов servicelog.log
- loggingLevel
- уровень серьезности для фильтрации сообщений,
помещаемых в протокол
- port
- порт контроллера агентов для входящих незащищенных соединений клиентов
- processPolling
- указывает, включена или нет активная проверка состояния процесса. Этот атрибут в основном используется в системах Windows для проверки оповещения Контроллера агентов о завершении процесса. Значение по умолчанию: true.
- securedPort
- порт контроллера агентов для входящих защищенных соединений клиентов
- version
- версия контроллера агентов
Элемент: PluginConfiguration
Это корневой элемент конфигурации встраиваемого модуля. Его параметры
загружаются после загрузки базовой конфигурации.
Используется следующими элементами: Конфигурация встраиваемого модуля
Подэлементы: AgentControllerEnvironment, Application,
Service, Agent, Option
Атрибуты:
- requires
- разделенный запятой список имен модулей, от которых зависит данная конфигурация. Начиная с TPTP 4.0 к именам модулей
был добавлен идентификационный суффикс. Он состоит из символа подчеркивания, после которого следует номер версии выпуска. Например, org.eclipse.tptp.platform.agentcontroller_4.0.0.
Для того чтобы обеспечить совместимость модуля с приложениями, имеющими зависимости от модулей более ранних выпусков (модули без
идентификационного суффикса версии), вы можете указать имя модуля для атрибута "requires" без идентификатора версии. В этом
случае загрузчик конфигурации контроллера агентов вначале попытается обнаружить полное имя модуля с идентификационным суффиксом версии.
В случае неудачи загрузчик конфигурации будет искать имя модуля без идентификационного суффикса версии. Если найдено несколько модулей с
одинаковым именем, будет использован первый модуль, возвращенный операционной системой.
Элемент: AgentControllerEnvironment
Заменитель для глобальных переменных среды, предоставляемых данной
конфигурацией. Они публикуются в системе и доступны всем другим конфигурациям,
включая базовую.
Используется следующими элементами: AgentControllerConfiguration,
PluginConfiguration
Подэлементы: Variable
Атрибуты:
- расположение конфигурации
- имя конфигурации, в которую должны быть добавлены эти
переменные среды
Элемент: Application
Заменитель для среды приложения. Область видимости параметров, указанных в этом
элементе, ограничена только данным приложением.
Используется следующими элементами: AgentControllerConfiguration,
PluginConfiguration
Подэлементы: Variable, Parameter
Атрибуты:
- расположение конфигурации
- имя конфигурации, в которую должно добавляться
приложение
- executable
- имя приложение, которое должно использоваться клиентами
для его идентификации
- path
- фактический полный путь к программе, которая должна запускать
данное приложение
- location
- рабочий каталог данного приложения
- extends
- имя конфигурации, в которой уже определено это же
приложение; добавляет текущие параметры в начало
Элемент: Hosts
Заменитель для информации о хостах. Используется контроллером агентов для
разрешения /запрета подключения определенных хостов.
Используется следующими элементами: AgentControllerConfiguration
Подэлементы: Allow, Deny
Атрибуты:
расположение конфигурацииимя конфигурации, в которой используется данная информация о
хосте
Элемент: Allow
Указывает, каким хостам разрешено подключаться к контроллеру агентов.
Используется следующими элементами: Hosts
Атрибуты:
- хост
- имя или IP-адрес хоста
- net
- подсеть
- mask
- маска подсети
Элемент: Deny
Указывает, каким хостам запрещено подключаться к контроллеру агентов.
Используется следующими элементами: Hosts
Атрибуты:
- хост
- имя или IP-адрес хоста
- net
- подсеть
- mask
- маска подсети
Элемент: Service
Указывает, какой пользовательский модуль должен загружаться при запуске
контроллера агентов.
Используется следующими элементами: AgentControllerConfiguration,
PluginConfiguration
Подэлементы: Option
Атрибуты:
- расположение конфигурации
- имя конфигурации, с которой должна загружаться
данная служба
- name
- имя службы
- path
- полный путь к динамически загружаемой библиотеке
Элемент: Agent
Задает информацию об агенте.
Используется следующими элементами: AgentControllerConfiguration,
PluginConfiguration
Подэлементы: Option
Атрибуты:
- расположение конфигурации
- имя конфигурации, которую использует конфигурация
данного агента
- name
- имя агента
- тип
- тип агента
- dataChannelSize
- объем общей памяти, выделяемой для взаимодействия
между процессами
- logFile
- полный путь к файлу протокола, предназначенного для записи
сообщений, отправляемых агентом
- client
- указывает, является ли данный агент динамическим или автоматическим
Элемент: Option
Используется для хранения пары имя-значение.
Используется следующими элементами: AgentControllerConfiguration,
PluginConfiguration, Service, Agent
Атрибуты:
- name
- имя опции (т.е. пространство имен)
- тип
- тип опции (т.е. имя опции)
- value
- значение опции
Элемент: Plugin
Каталог для поиска конфигураций встроенных модулей
Используется следующими элементами: AgentControllerConfiguration
Атрибуты:
pathполное имя каталога для поиска конфигураций встроенных модулей
Элемент: Variable
Переменная среды.
Используется следующими элементами: Application,
AgentControllerEnvironment
Атрибуты:
- name
- имя переменной среды (например, CLASSPATH)
- value
- значение переменной среды
- position
- указывает, добавляется ли это значение, или присоединяется
спереди, или заменяет существующее значение
Элемент: Parameter
Параметр программы.
Используется следующими элементами: Application
Атрибуты:
- value
- значение параметра программы
- position
- указывает, добавляется ли этот параметр, или
присоединяется спереди, или заменяет существующий параметр