Agent and Agent Controller Configuration Overview
Note
When referring to file and directory locations in this document,
<install-home> is the directory where the Agent Controller package was
unzipped.
Introduction
There are three configuration files used to manage the behavior of the Agent
Controller and agents:
-
The serviceconfig.xml
configuration file is read by the Agent Controller during its startup to
determine connectivity settings, global logging level, and global settings
for application and agent launching. It is also read by agents attempting
to register themselves with a particular Agent Controller.. Each instance of
an Agent Controller running on the same system requires its own
serviceconfig.xml
file with unique connectivity settings.
Refer to
The
serviceconfig.xml File for
reference information on the elements of this configuration file.
-
Static configuration
information for each agent is located in an
agent.xml
file. This file contains information that the
Agent Controller needs to know regarding a particular agent. This
includes how to launch the agent (the executable pathname, command line
arguments, etc.), what command sets (interfaces) the agent supports,
restrictions on how many running instances of this agent are allowed, and
how many simultaneous users of an agent are allowed. The
Agent Controller looks in the directory specified by the Agent
element in the serviceconfig.xml
file (typically defined as
<install-home>\agents)
to find these configuration files. Each agent has a unique directory named for it
and the agent.xml file is located within that directory (e.g.,
<install-home>\agents\org.eclipse.tptp.TimeCollector\agent.xml). When an
agent is requested, the Agent Controller uses the name specified in the agent.xml
configuration file to locate it.
Refer to
The
agent.xml
File for
reference information on the elements of this configuration file.
Note
If the old agent controller
interface is being used to start agents, the presence of an agent.xml has no
effect. With the old interface, the client must know the name of the process it
wants to start, and those names are defined by application aliases. An
application alias must be placed in a pluginconfig.xml or in the
serviceconfig.xml. An application alias defined in an agent.xml will be
ignored.
-
The pluginconfig.xml file is used by any application (including an agent) that
needs to extend the environment settings or application alias list defined
in serviceconfig.xml. The term "plugin" might
mislead, because the
application does not have to be in the form of an Eclipse plug-in, although
that is what was originally used. The Agent Controller looks in the
directory specified by the Plugin
element in the serviceconfig.xml
file (typically defined as
<install-home>\plugins). Each application has a unique
directory named for it and the pluginconfig.xml file must be located
directory directory \config within that directory. Refer to The
pluginconfig.xml File for
reference information on the elements of this configuration file.
-
Dynamic configuration
information for each agent is located in an
agentconfig.xml
file. This file is optional. It is expected to contain
configuration information that an agent uses either during its startup or at
any point during its execution. The contents and use are defined by
the creator of the associated agent. The agentconfig.xml
file is typically located in a \config
directory below the
directory named for the agent of interest (e.g.,
<install-home>\agents\org.eclipse.tptp.TimeCollector\config\agentconfig.xml).
This configuration directory
can be
specified in the
agent.xml
file. Depending on
how the agent itself is implemented, this configuration file might be read
by the agent just once, many times, or even never. The Agent
Controller never reads this file.
Currently, there are no suggested elements for this file, so no reference
example is given.
Related reference
The serviceconfig.xml
File
The
agent.xml
File
The pluginconfig.xml
File
Copyright (C) 2005, 2007 Intel Corporation.