Содержание
Примечание
При упоминании в этом документе расположений файлов и каталогов под <каталогом-установки> понимается каталог, в котором был распакован пакет контроллера агентов.
Файл pluginconfig.xml располагается в каталоге <каталог_установки>\plugins\<plugin-name>\config. Он представляет собой механизм расширения глобальной среды и псевдонимов приложений, заданных в файле serviceconfig.xml, исходя из потребностей отдельно скомпонованных приложений. Расширение параметров среды, заданных в serviceconfig.xml, влияет на все приложения (включая агенты), запущенных контроллером агентов, так как они наследуют эти параметры среды. Это позволяет "встраиваемому модулю" сделать свои приложения доступными для поиска, выполняемого другими процессами, запущенными контроллером агентов (например, добавляя путь к переменной среды CLASSPATH). Расширение списка псевдонимов приложений является способом запуска новых приложений если контроллер агентов настроен для ограничения служб запуска только для этого списка.
Таким образом, pluginconfig.xml предоставляет механизм упаковки дополнительных компонентов, необязательных для базовой установки контроллера агентов. Так как сам файл serviceconfig.xml не изменяется, удаление дополнительных компонентов является довольно простой задачей.
Агентам может потребоваться как pluginconfig.xml, так и agent.xml. Файл agent.xml необходим чтобы задать приложение агента при необходимости обнаружения нового контроллера агентов при поиске доступных агентов (то есть, чтобы он был доступен для обнаружения). Файл pluginconfig.xml необходим если агенту требуется расширить среду serviceconfig.xml или список псевдонимов. Файл agent.xml заменит файл pluginconfig.xml в будущих версиях продукта.
Примечание
Термин "встраиваемый модуль" используется для упоминания модуля Eclipse. Дело в том, что раньше использовались фактические встраиваемые модули. Но сейчас это неактуально, так как данный файл конфигурации может ссылаться на любое приложение без необходимости его размещения в модуле, подходящем для установки в рабочей среде Eclipse.
Файл pluginconfig.xml содержит следующие основные сегменты:
Ниже приведена иерархия элементов файла pluginconfig.xml. Элементы одного уровня могут располагаться в любом порядке. Гиперссылки, указанные в иерархии, ведут к разделу Элементы и атрибуты, где приведено описание формальных элементов.
PluginConfiguration
AgentControllerEnvironment
Variable
Option
Application
Variable
Parameter
Agent
Option
Элемент: PluginConfiguration
Подэлементы: AgentControllerEnvironment
Option
Application
Agent
- requires
- (необязательно) Это строковое значение представляет собой разделенный запятой список имен модулей, от которых зависит данная конфигурация. Начиная с TPTP 4.0 к именам модулей был добавлен идентификационный суффикс. Он состоит из символа подчеркивания, после которого следует номер версии выпуска. Например, org.eclipse.tptp.platform.agentcontroller_4.0.0. Для того чтобы обеспечить совместимость модуля с приложениями, имеющими зависимости от модулей более ранних выпусков (модули без идентификационного суффикса версии), вы можете указать имя модуля для атрибута "requires" без идентификатора версии. В этом случае загрузчик конфигурации контроллера агентов вначале попытается обнаружить полное имя модуля с идентификационным суффиксом версии. В случае неудачи загрузчик конфигурации будет искать имя модуля без идентификационного суффикса версии. Если найдено несколько модулей с одинаковым именем, будет использован первый модуль, возвращенный операционной системой.
Используется PluginConfiguration
Подэлементы: Variable
Элемент Variable задает переменную среды и ее расположение при формировании новой среды по умолчанию для запускаемых приложений и агентов. В рамках элемента AgentControllerEnvironment можно указать несколько элементов Varialbe или не указывать ни одного.
Используется следующими элементами: AgentControllerEnvironment
Атрибуты:
- name
- Задает имя переменной среды.
- значение
- Задает значение переменной среды.
- position
- (необязательно) Это значение может быть "append", "prepend" или "replace". Оно указыает расположение среды по отношению с существующей среде по умолчанию.
Элемент: Option
Option является элементом верхнего уровня в PluginConfiguration и используется для указания произвольных данных конфигурации, передаваемых всем агентам, зарегистрировавшимся в контроллере агентов. Эти сведения добавляются в информацию о свойстве, возвращаемую для всех агентов клиенту. Агент может обработать или нет эту информацию. Сведения об элементе Option передается только агентам, использующим исходный API
(уровни обратной совместимости) контроллера агентов. Воспользуйтесь файлом конфигурации agent.xml для предоставления сведений о конфигурации агенту с помощью нового API.
Элемент: ApplicationИспользуется следующими элементами: Agent
Атрибуты:
- name
- Это значение задает пространство имен для опции.
- тип
- Это значение задает имя опции.
- значение
- Эта строка задает значение опции.
Используется PluginConfiguration
Подэлементы: Variable
- executable
- Это значение задает имя псевдонима для исполняемого файла приложения, указанного в атрибуте path. Клиенты должны использовать это имя для идентификации данного приложения. Если указан атрибут extends, данно е имя должно совпадать с ранее заданным псевдонимом.
- path
- Это значение задает полный путь к каталогу, из которого запускается приложение. Этот путь используется вместо псевдонима при запуске исполняемого файла приложения.
Атрибут игнорируется если указан атрибут extends.- location
- (необязательно) Это значение задает каталог, из которого запускается исполняемый файл. Иногда этот каталог называется рабочим каталогом для исполняемого файла.
- extends
- (необязательно) Это значение задает имя конфигурации для ранее заданного псевдонима приложения. Однако, имена конфигураций не поддерживаются, поэтому значение данного атрибута должно равняться "default". Если атрибут extends задан (вне зависимости от значения), он указывает на то, что информация, содержащаяся в данном элементе Application, должна расширять информацию, ранее заданную в соответствующем псевдониме приложения. Изменять значение path запрещено (то есть запускаемый исполняемый файл). Если соответствия имени исполняемого файла не обнаружены, элемент Application не оказывает никакого воздействия.
Элемент: Variable
Элемент Variable задает переменную среды и ее расположение в среде при запуске приложения.
В рамках элемента Application можно указать несколько элементов Varialbe или не указывать ни одного.
Используется следующими элементами: Application
Атрибуты:
- name
- Задает имя переменной среды.
- значение
- Задает значение переменной среды.
- position
- (необязательно) Это значение может быть "append", "prepend" или "replace". Оно указыает расположение среды по отношению к среде по умолчанию.
Элемент Parameter задает аргумент командной строки, который используется при запуске приложения. В рамках элемента Application можно указать несколько элементов Varialbe или не указывать ни одного.
Используется следующими элементами: Application
Атрибуты:
- значение
- Это значение задает аргумент командной строки.
- position
- (необязательно) Это значение может быть "append", "prepend" или "replace". Оно указывает расположение аргумента по отношению к существующим аргументам командной строки.
Элемент: Agent
Предоставляет информацию о конфигурации для определенного агента. Используется только агентами, применяющими исходный API (уровни обратной совместимости) контроллера агентов. Для предоставления информации о конфигурации для агентов, использующих исходный API, используйте файл конфигурации agent.xml.
Используется PluginConfiguration
Подэлементы: Option
Атрибуты:
- name
- Это значение указывает имя агента, к которому следует применить данную информацию о конфигурации.
- тип
- (необязательно) Это значение задает тип агента.
- dataChannelSize
- (необязательно) Это значение задает объем общей памяти для выделения для взаимодействия между процессами. Это значение равно положительному целому числу с приставкой M или K, указывающими на мегабайты или килобайты, либо вообще без приставки, что указывает на байты. Примерами значений могут быть "16M", "8K" или "16000".
- logFile
- (необязательно) Жто значение указывает полный путь к файлу. Если оно указано, данные, обычно проходящие через канал данных, будут вместо этого записываться в указанный файл.
- client
- (необязательно) Это значение указывает, что данный агент взаимодействует с клиентом. Допустимы значения "DYNAMIC" и "HEADLESS". HEADLESS указывает на отсутствие связанного клиента. По умолчанию используется значение DYNAMIC.
- extends
- (необязательно) Это значение задает имя конфигурации для ранее заданного элемента Agent. Однако, имена конфигураций не поддерживаются, поэтому значение данного атрибута должно равняться "default". При наличии extends (вне зависимости от его значения), он указывает, что информация, имеющаяся для данного элемента Agent, должна расширять ранее заданные сведения конфигурации для соответствующего элемента Agent. Используется для расширения списка элементов Option, связанных с определенным агентом.
Элемент: Option
Подэлемент Option элемента Agent используется чтобы указать данные конфигурации, передаваемые агенту при его регистрации в контроллере агентов. Агент может обрабатывать или нет эту информацию.
Используется следующими элементами: Agent
Атрибуты:
- name
- Произвольное имя опции (например, пространство имен)
- тип
- тип опции (т.е. имя опции)
- значение
- произвольное значение опции
<PluginConfiguration requires="org.eclipse.tptp.platform.collection.framework">
<AgentControllerEnvironment>
<Variable name="CLASSPATH_MY_AGENTS"
position="append"
value="%PLUGINS_HOME%\org.eclipse.tptp.myagents\lib\coreagent.jar"
/>
</AgentControllerEnvironment>
<Application
executable="MyAgent"
location="%SYS_TEMP_DIR%"
path="%JAVA_PATH%">
<Variable name="CLASSPATH"
position="append"
value="%PLUGINS_HOME%\org.eclipse.tptp.myagents\jmx\lib\jmxagent.jar"
/>
<Variable name="CLASSPATH"
position="append"
value="%CLASSPATH_MY_AGENTS%"
/>
<Parameter position="append"
value="-Dapp_home=%MY_HOME%"
/>
<Parameter position="append"
value="-DagentXML=%PLUGINS_HOME%
\org.eclipse.tptp.myagents\jmx\agentXML\MyAgent.xml"
/>
</Application>
<Option name="org.eclipse.tptp.Myagents"
type="version" value="2.0"/>
</PluginConfiguration>
Связанные ссылки
Обзор конфигурации агентов и контроллера агентов
Copyright (C) 2006 Intel Corporation.