Configuratiebestanden van de agentcontroller
De configuratie van de agentcontroller wordt bepaald door twee sets configuratiebestanden.
De eerste set is de basisconfiguratie die de standaardinstellingen van de engine beschrijft.
De tweede set is de pluginconfiguratie die de specifieke engine-instellingen voor de toepassing beschrijft.
In dit document worden de details van de configuraties besproken en ziet u hoe u configuratie-extensies schrijft.
Waar in dit document naar <installatiedirectory> wordt verwezen, wordt de directory bedoeld waarin de agentcontroller is uitgepakt. Deze directory wordt in de configuratiebestanden ook %RASERVER_HOME% genoemd.
Basisconfiguratie
De basisconfiguratie bestaat uit het bestand <installatiedirectory>/config/serviceconfig.xml dat is opgebouwd met behulp van het XML-schema <installatiedirectory>/config/serviceconfig.xsd.
Hier worden de standaardinstellingen opgegeven, bijvoorbeeld de systeemomgevingsvariabelen, toepassingsconfiguraties en connectiviteit van de agentcontroller. De basisconfiguratie is voor alle configuraties beschikbaar en wordt geladen bij de starten van de engineservice. De ontwikkelaars van de toepassing moeten het basisconfiguratiebestand niet wijzigen, omdat alle wijzigingen in de basisconfiguratie algemeen zijn. De pluginconfiguraties
(hieronder beschreven) moeten worden gebruikt om de instellingen op te geven die specifiek zijn voor de plugin en de toepassing.
Pluginconfiguratie
Voor elke door de gebruiker gedefinieerde toepassing moeten het configuratiebestand en de dependency's in de plugindirectory <installatiedirectory>/plugin/<pluginnaam> worden geplaatst, waarbij <pluginnaam> een unieke naam is die de toepassing aangeeft. Het pluginconfiguratiebestand pluginconfig.xml
moet in de subdirectory config van de plugindirectory worden geplaatst.
Gewoonlijk worden de JAR-bestanden in de subdirectory lib van de plugindirectory geplaatst.
Ontwikkelaars kunnen het XML-schema <installatiedirectory>/config/pluginconfig.xsd gebruiken als hulp bij het maken van het pluginconfiguratiebestand.
Elementen en kenmerken
Element: AgentControllerConfiguration
Dit is het hoofdelement van de basisconfiguratie. De instellingen worden gebruikt voor het starten van de engineservice.
Gebruikt door: Basisconfiguratie
Subelementen: AgentControllerEnvironment, Application, Hosts, Service, Agent, Option, Plugin
Kenmerken:
- activeConfiguration
- De configuratie die bij het starten van de engine moet worden geladen.
- filePort
- De poort die de bestandsoverdrachtservice van de agentcontroller bewaakt. De standaardwaarde is 10005.
- isDataMultiplexed
- Of de profilering en de vastlegging van gegevens moet worden verzonden via het besturingskanaal van de agentcontroller. Standaard gebruikt het gegevenskanaal een willekeurige poort voor gegevensoverdracht, die kan worden geblokkeerd door de aanwezigheid van een firewall. Het overbrengen van gegevens via het besturingskanaal maakt het mogelijk om een aantal vooraf gedefinieerde poorten te openen voor inkomende aanvragen voor verbinding door de firewall heen. Deze poorten zijn onder meer de standaardpoort 10002, de beveiligde poort 10003 en de bestandsserverpoort 10005. De standaardwaarde voor dit kenmerk is false.
- jvm
- Het volledig gekwalificeerde pad van de dynamische runtimebibliotheek van Java Virtual Machine (jvm.dll of libjvm.so).
- loggingDetail
- Als dit kenmerk op HIGH is ingesteld, worden regelnummers in het logboek vastgelegd.
- loggingDirectory
- De directory waarin het enginelogboek servicelog.log is gemaakt.
- loggingLevel
- Een severityfilter voor logboekberichten.
- port
- De engine-poort voor het opvangen van inkomende niet-beveiligde clientverbindingsgegevens.
- processPolling
- Of het actief controleren van de processtatus is ingeschakeld. Dit kenmerk wordt hoofdzakelijk gebruikt op Windows-systemen om ervoor te zorgen dat de agentcontroller iedere keer bericht krijgt als een proces wordt beëindigd. De standaardwaarde is true.
- securedPort
- De engine-poort voor het opvangen van inkomende beveiligde clientverbindingsgegevens.
- version
- De engine-versie.
Element: PluginConfiguration
Dit is het hoofdelement van de pluginconfiguratie. De instellingen worden geladen nadat de basisconfiguratie is geladen.
Gebruikt door: Pluginconfiguratie
Subelementen: AgentControllerEnvironment, Application, Service, Agent, Option
Kenmerken:
- requires
- Een door komma's gescheiden lijst van pluginnamen waarvan deze configuratie afhankelijk is. Vanaf TPTP 4.0 is een achtervoegsel met het versie-ID toegevoegd aan de pluginnamen. Dit bestaat uit het liggende streepje gevolgd door het nummer van de versie. Bijvoorbeeld: org.eclipse.tptp.platform.agentcontroller_4.0.0. Om te zorgen voor plugincompatibiliteit voor toepassingen die afhankelijk zijn van de plug-ins van eerdere versies (plugins die geen achtervoegsel met het versie-ID hebben), kunt u de pluginnaam voor het kenmerk "requires" opgeven zonder versie-ID. In dit geval zal de configuratielader van de agentcontroller eerst proberen de volledige pluginnaam te vinden inclusief een achtervoegsel met het versie-ID.
Als dit niet lukt, zoekt het configuratielader vervolgens naar de pluginnaam zonder het achtervoegsel met het versie-ID. Als er meerdere plugins met dezelfde naam worden aangetroffen , wordt de eerste pluginnaam gebruikt die door door het besturingssysteem is geretourneerd.
Element: AgentControllerEnvironment
Dit is een plaatshouder voor de omgevingsvariabele(n) die door de configuratie is/zijn aangeleverd.
Deze worden gepubliceerd in het systeem en zijn beschikbaar voor alle andere configuraties, inclusief de basisconfiguratie.
Gebruikt door: AgentControllerConfiguration, PluginConfiguration
Subelementen: Variable
Kenmerken:
- configuration
- De naam van de configuratie waaraan de omgevingsvariabelen moeten worden toegevoegd.
Element: Application
Dit is de plaatshouder voor een omgeving die specifiek is voor de toepassing. De instellingen zijn alleen zichtbaar voor deze specifieke toepassing.
Gebruikt door: AgentControllerConfiguration, PluginConfiguration
Subelementen: Variable, Parameter
Kenmerken:
- configuration
- De naam van de configuratie waaraan de toepassing moet worden toegevoegd.
- executable
- De naam waarmee clients de toepassing moeten identificeren.
- path
- Het huidige, volledig gekwalificeerde pad van het programma dat deze toepassing moet uitvoeren.
- location
- De werkdirectory van deze toepassing.
- extends
- De naam van de configuratie waarvan dezelfde toepassing al is gedefinieerd: de huidige instellingen worden bovenaan toegevoegd.
Element: Hosts
Dit is een plaatshouder voor hostgegevens. Deze wordt gebruikt door de engine om voor bepaalde host(s) een verbinding toe te staan of te weigeren.
Gebruikt door: AgentControllerConfiguration
Subelementen: Allow, Deny
Kenmerken:
configurationDe naam van de configuratie die door deze hostgegevens wordt gebruikt.
Element: Allow
Hiermee worden de hosts opgegeven die verbinding met de engine mogen maken.
Gebruikt door: Hosts
Kenmerken:
- host
- De naam of het IP-adres van de host.
- net
- Subnet.
- mask
- Subnetmasker.
Element: Deny
Hiermee worden de hosts opgegeven die geen verbinding met de engine mogen maken.
Gebruikt door: Hosts
Kenmerken:
- host
- De naam of het IP-adres van de host.
- net
- Subnet.
- mask
- Subnetmasker.
Element: Service
Hier wordt bepaald welke door de gebruiker gedefinieerde module moet worden geladen bij het starten van de engine.
Gebruikt door: AgentControllerConfiguration, PluginConfiguration
Subelementen: Option
Kenmerken:
- configuration
- De naam van de configuratie die deze service moet laden.
- name
- De naam van de service.
- path
- Het volledig gekwalificeerde pad van de dynamische laadbibliotheek.
Element: Agent
Hiermee worden agentspecifieke gegevens opgegeven.
Gebruikt door: AgentControllerConfiguration, PluginConfiguration
Subelementen: Option
Kenmerken:
- configuration
- De naam van de configuratie die door deze agentconfiguratie wordt gebruikt.
- name
- De naam van de agent.
- type
- Het type van de agent.
- dataChannelSize
- De hoeveelheid gemeenschappelijk geheugen die wordt toegewezen voor Interprocescommunicatie (IPC).
- logFile
- Het volledig gekwalificeerde pad van het logboek waarin de berichten worden weggeschreven die de agent heeft verzonden.
- client
- Of deze agent dynamisch of headless is.
Element: Option
Dit wordt gebruikt voor het opslaan van een naam en een waarde in een paar.
Gebruikt door: AgentControllerConfiguration, PluginConfiguration, Service, Agent
Kenmerken:
- name
- De naam van de optie (dus naamruimte).
- type
- Het type van de optie (dus optienaam).
- value
- De waarde van de optie.
Element: Plugin
Dit is de directory waarin naar pluginconfiguraties moet worden gezocht.
Gebruikt door: AgentControllerConfiguration
Kenmerken:
pathDe volledig gekwalificeerde directory waarin naar pluginconfiguraties moet worden gezocht.
Element: Variable
Omgevingsvariabele
Gebruikt door: Application, AgentControllerEnvironment
Kenmerken:
- name
- De naam van de omgevingsvariabele (bijvoorbeeld CLASSPATH).
- value
- De waarde van de omgevingsvariabele.
- position
- Of deze waarde voor aan of achter aan de bestaande waarde moet worden toegevoegd of de bestaande waarde moet vervangen.
Element: Parameter
Programmaparameter
Gebruikt door: Application
Kenmerken:
- value
- De waarde van de programmaparameter.
- position
- Of de parameter voor aan of achter aan de bestaande parameter moet worden toegevoegd of de bestaande parameter moet vervangen.