Config file parameters

From WikiSiwenoid
Jump to: navigation, search
Language: English  • magyar

Previous chapter-> First SIWENOID startup

Szerver parancssori paraméterei

A szerver indításához minimálisan a java -jar Siwenoid.jar parancs szükséges. A további paramétereket a java és a -jar közé kell megadni. Főbb beállítási lehetőségek:

  • -Dsiwenoid.registry.port=1099
    A szerver saját magát menedzselő RMI portja, ezen keresztül tudja például ellenőrizni induláskor, hogy fut-e már másik példány a számítógépen. Alapértelmezetten: 1099.
  • -Dhajdbc.home=..path..
    Ezzel a beállítással lehet befolyásolni, hogy a HA-JDBC modul hol keresse a konfigurációs fájlját. (Általában nem kell megváltoztatni az alapértelmezettet.)
  • -Xms128m
    A szerver induláskor ennyi memóriát foglaljon le.
  • -Xmx1024m
    A szerver a futása során legfeljebb ennyi memóriát használhat. Az 1024m azt jelenti, hogy maximum 1024 MB. A javasolt beállítás kisebb rendszereknél -Xmx512m nagyobbaknál -Xmx1024m.

További parancssori argumentumok (a parancs után kell írni őket szóközzel elválasztva):

  • -start
    Elindítja a szervert (ez az alapértelmezett).
  • -stop
    Leállítja a futó szervert.
  • -restart
    Újraindítja a futó szervert.
  • -version
    Kiírja a szerver verziószámát.

Szerver oldali XML konfiguráció

  • Siwenoid
    Gyökér elem, az XML szabvány szempontjából fontos, minden dokumentumnak pontosan egy gyökere van.
    • Services
      A szerver által használt szervízek sorrendhelyes felsorolása. Ez alatt minden egyes elem Tag-je a szervíz osztályának egyszerű neve, tartalma pedig az osztály teljes (minősített) neve. Pl.:
      <CacheService>hu.siwena.services.cache.CacheService</CacheService>
      <DatabaseService>hu.siwena.services.database.DatabaseService</DatabaseService>


  • SmsService
    Az sms küldésért felelős szervíz konfigurációja:

A config elejére(<Services>-be): <SmsService>hu.siwena.module.sms.SmsService</SmsService>

<SmsService>
   	<sendername>Siwenoid</sendername>
   	<pincode>1234</pincode>    A SIM kártya PIN kódja
   	<serialport>2</serialport> Az eszközkezelőből a D-Link HSPA+DataCard NMEA Device után szereplő COM portszám
        <vid>2001</vid>            Az USB modem Vendor ID-ja
        <pid>536512507596720</pid> Az USB modem Serial Number-je
</SmsService>

Amennyiben a COM portszám nagyobb lenne 16-nál, kisebb számra kell átállítani az eszközkezelőből. A vid és pid kiolvasásához ajánlott alkalmazás:http://www.nirsoft.net/utils/usb_devices_view.html
A listából a HSPA USB SCSI CD-ROM USB Device-t kell kiválasztani és ennek az eszköznek az adatait megadni(vid & pid).
A DLink saját alkalmazásának telepítése szükséges, mert az telepíti fel az eszköz Driverét, azonban blokkolja az sms küldő modul működését,
így telepítés után le kell állítani.



    • LoggerService
      A logolásért felelős szervíz konfigurációja, a log4J modulnak megfelelően.1 Legegyszerűbb konfigurációja például:

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
<appender name="root_fileappender" class="org.apache.log4j.DailyRollingFileAppender">
<param name="File" value="log/siwenoid.log"/>
<param name="Append" value="true"/>
<param name="ImmediateFlush" value="true"/>
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="[%d] - %m%n"/> </layout> </appender> <logger name="hu.siwena"> <level value="info"/> <appender-ref ref="root_fileappender"/> </logger> <appender name="dbappender" class="hu.siwena.services.database.synchronization.DatabaseErrorAppender"> <layout class="org.apache.log4j.PatternLayout"> <param name="ConversionPattern" value="%m%n"/> </layout> </appender> <logger name="net.sf.hajdbc"> <level value="debug"/> <appender-ref ref="dbappender"/> </logger> <root> <level value="error"/> </root> </log4j:configuration> DatabaseService
Az adatbázist kezelő szervíz konfigurációja. database (Attribútumok: id=”str” host=”str” port=”num” ) Ilyen Tag-ekkel kell felsorolni a rendszerhez kapcsolódó adatbázisokat, az id tetszőleges, de egyedi kell legyen. torque A Torque modul konfigurációját tartalmazza a szabványnak megfelelően.2 Több adatbázis esetén ez a rész nem szükséges, csak a ha-jdbc. <applicationRoot>.</applicationRoot> Az alkalmazás gyökere, mindig “.” az értéke. defaults Alapértelmezett értékek, konfigurációs beállítások. pool Szálakkal kapcsolatos beállítások. <maxWait>10000</maxWait> Maximum várakozási idő, mielőtt egy kapcsolódás meghiúsulna (milliszekundum). <maxIdle>20</maxIdle> Várakozó szálak maximális száma. <maxActive>50</maxActive>

Aktív szálak (kapcsolatok) maximális száma. <timeBetweenEvictionRunsMillis>300000</timeBetweenEvictionRunsMillis> <minEvictableIdleTimeMillis>3600000</minEvictableIdleTimeMillis> connection

Az adatbázis kapcsolat beállításai. driver Az adatbáziskezelőhöz tartozó Java Driver. MySQL: com.mysql.jdbc.Driver�PostgreSQL: org.postgresql.Driver url Az adatbáziskezelő JDBC URL-je. MySQL: jdbc:mysql://host:port/adatbazisnev�PostgreSQL: jdbc:postgresql://host:port/adatbazisnev user

Az adatbázishoz csatlakozó felhasználó neve. password Az adatbázishoz csatlakozó felhasználó jelszava. database

Adatbázis tulajdonságai. default

Az alapértelmezett adatbázis (logikai) neve [az_előző_pontban_megadott_név] adapter

Az adatbázist kezelő adapter neve, keresd a Torque dokumentációjában. Leggyakrabban a mysql vagy postgresql adaptereket használjuk. dsfactory

DataSourceFactory - A Torque használja, javasolt az alább Factory használata. [alapértelmezett_adatbazis_neve] <factory>org.apache.torque.dsfactory.SharedPoolDataSourceFactory</factory> <idbroker.clever.quantity>true</idbroker.clever.quantity> <manager.useCache>true</manager.useCache> ha-jdbc (Attríbutuma: cluster=”str” )

Több adatbázis együttes kezelésekor szükséges, a cluster paraméter egy tetszőleges logikai név, pl.: SiwenoidDbCluster. Egy adatbázis esetén ez a rész nem szükséges, de ha ez nincs beállítva, akkor a torque résznek kell megfelelőnek lennie. <sync id="tetszőleges" class="hu.siwena.services.database.synchronization.CustomDifferentialSynchronizationStrategy"/> Adatbázisok szinkronizálását végző osztály konfigurálása. cluster

Az adatbázis cluster konfigurálása. Attribútumai: balancer="simple" default-sync="fentebb megadott sync id attribútumának értéke"

dialect="mysql" lehet pl. postgresql is, lásd a HA-JDBC dokumentációját 3 meta-data-cache="lazy" transaction-mode="parallel" max-threads="5" auto-activate-schedule="0 0/1 * * * ?"

Az adatbázisok aktiválását végző Cron ütemező futási idő konfigurációja.4 failure-detect-schedule="0/15 * * * * ?"

Az adatbázisok kiesését vizsgáló Cron ütemező futási idő konfigurációja.4 Gyerek elemek:

database (Attribútuma: id=”a fentebb megadott id-k egyike” ) Egy-egy adatbázist reprezentáló elem. driver Lásd torque.defaults.connection.driver. url Lásd torque.defaults.connection.url. user Lásd torque.defaults.connection.user. password Lásd torque.defaults.connection.password. database ....

DataPointService Az adatpontokkal kapcsolatos szervíz konfigurációja, ez definiálja a használandó adatpont kezelőket is. rootcontainername A gyökér konténer neve, alapértelmezetten root. systemcontainername A rendszer konténer neve, alapértelmezetten system. pre-cache

Töltse-e be az adatpontokat és gyerek listáikat automatikusan a cache-be induláskor. Az alapértelmezett érték: false. Lehetséges értékek: true vagy false. import-memory-opts Az adatpont importáló alkalmazás indításakor használandó memóriaszabályzó paraméter. Pl. -Xmx512m azt jelenti, hogy az alkalmazás max. 512 MB memóriát fog tudni használni. Az alapértelmezett érték: -Xmx512m.

datapointhandlers Adatpontkezelők felsorolása. Minden “item” Tag-be egy-egy kezelő teljes (minősített) nevét kell írni. item item ... Például: <item>hu.siwena.services.datapoint.handlers.SystemHandler</item> <item>hu.siwena.services.datapoint.handlers.AlgorexHandler</item> SystemHandler


A rendszer-adatpontokat kezelő osztály konfigurációja. type (Attribútumai: id=”adatpont_típus” ) Az adatpont típus lehetséges értékei: 1 szerver 2 adatbázis 16 kliens számláló 17 kliens Az elem tartalma egy eseménykategória azonosítója, ebbe a kategóriába fog tartozni az a treatment, amellyel az adatbont normálistól eltérő állapotai kerülnek. AlgorexHandler és AlgorexMultiportHandler Az Algorex protokollal operáló adatpontok kezelője, illetve ennek a Hot-standby párja konfigurációi. sockettimeout Az alközponthoz kapcsolódás timeout-ja. socketkeepalive Az életjel telegram értéke, minden esetben 0x01. BACnetHandler A BACnet protokollal kommunikáló adatpontok kezelőjének konfigurációja. disabled-types Az import során az itt felsorolt típusú elemek figyelmen kívül hagyja. item Értéke a tiltandó típus neve, pl.: EO_FI_ZoneManualElem item ...

CerbanHandler és CerbanMultiportHandler A Cerban protokollal működő adatpontok kezelője, illetve ennek a Hot-standby párja konfigurációi. sockettimeout

Az alközponthoz kapcsolódás timeout-ja. socketkeepalive

Az életjel telegram értéke, minden esetben 0x01. SIAHandler

A SIA protokolhoz tartozó adatpontok kezelőjének konfigurációja. Egyelőre nincs konfigurációs lehetőség. RmiService

A szerver-kliens kapcsolatokat kezelő szervíz konfigurációja. port

A kapcsolatokat fogadó (Registry) port száma. Alapértelmezett értéke: 1899. sessiontimeout

A kapcsolatok elévülési ideje, ennyi (milliszekundum) inaktivitás után bontja a kapcsolatot a szerver. Alapértelmezetten: 6000. sessioncheckperiod

A kapcsolatok elévülését ellenőrző ütemező periódusideje. Alapértelmezetten: 5000. clientcount

Az egyszerre csatlakozott kliensek elvárt száma. separate-acknowledge Lehetséges értékei: true vagy false, alapértelmezetten: true. Igaz értéke esetén minden kliensen külön-külön le kell nyugtázni egy új eseményt, hamis értéke esetén valamely kliens nyugtája az összes kliensen nyugtázza az eseményt. pre-cache Lehetséges értékei: true vagy false, alapértelmezetten: false. Igaz értéke esetén induláskor betölti cache-be a treatmentek és parancsok listáját. enabled-locales Az engedélyezett nyelvek kódjainak felsorolása. Alapértelmezetten: en és hu.

item item ... event-log Eseménymemóriával kapcsolatos konfiguráció. (Opcionális) limit Az eseménymemória mérethatára, ez felett kerül archiválásra. Alapértelmezetten: 50000. starttime Az eseménymemóri vizsgálatának kezdete naponta (óra:perc). Alapértelmezetten a szerver indulásakor indul az ütemezés. AuthenticationService A felhasználók kezelésével kapcsolatos szervíz konfigurációja. administrator

Az adminisztrátor felhasználóra vonatkozó információk, amennyiben a felhasználó még nem létezik, ezekkel az adatokkal fogja létrehozni. A belépési információkat (felhasználónév, jelszó) első indításkor fogja kérni a szerver. firstname lastname email language A felhasználói felület nyelvének kódja. ScriptService

A scriptek futtatásáért felelős szervíz konfigurációja. categories Script kategóriák felsorolása, lásd a Siwenoid Scripting dokumentációt. item item ...

apis Script API-k felsorolása, lásd a Siwenoid Scripting dokumentációt. item item ...

SignalService

A Hot-standby megoldást implementáló szervíz konfigurációja, illetve a csatlakó JGroups5 modul beállításai. A következő 3 tulajdonság egyikének, illetve a server-list elemnek kell benne lennie: 1) jchannel:file A csatorna konfiguriációját5 tartalmazó fájl útvonala. 2) jchannel:simple A csatorna egyszerű konfigurációját5 tartalmazó szöveg. 3) jchannel:config

A csatorna XML konfigurációja.5 server-list Szerverek listáját felsoroló rész. server (Attribútuma: priority=”num” ) Egy szervert reprezentáló elem. A priority attribútum a szerver prioritását határozza meg, a nagyobb a fontosabb. host A szerver csatorna host címe. port A szerver csatorna portja. License A Licensszel kapcsolatos konfiguráció. stick-serial A mellékelt CodeMeter USB kulcs sorozatszáma. firmcode A gyártó kódja: 101459. productcode A termék kódja: 10. SocketService Az Algorex adatpont kezelőhoz tartozó kommunikációs szervíz konfigurációja. poolsize Párhuzamos szálak száma, események érkezésekor. Alapértelmezetten: 5. BACnetCommunicationService A BACnet adatpont kezelőhoz tartozó kommunikációs szervíz konfigurációja. timeout A BACnet-es kapcsolat timeout-ja. (milliszekundum) Alapértelmezett: 5000. instancenumber A szerver BACnet azonosítója, alapértelmezetten: 100. address Broadcast cím, erre küldi ki a központokat kereső üzeneteket a szerver. Alapértelmezetten: 255.255.255.255 localbindaddress A helyi host címe, alapértelmezetten: 0.0.0.0 port A BACnet port, alapértelmezetten: 47808. CerbanSocketService A Cerban adatpont kezelőhoz tartozó kommunikációs szervíz konfigurációja. poolsize Párhuzamos szálak száma, események érkezésekor. Alapértelmezetten: 5. SIACommunicationService A SIA adatpont kezelőhoz tartozó kommunikációs szervíz konfigurációja. poolsize Párhuzamos szálak száma, események érkezésekor. Alapértelmezetten: 5. AndroidService Az Android klienseket kezelő szervíz konfigurációja. bindaddress A helyi host címe, alapértelmezetten a lokális host. listenport A kapcsolatokat váró port száma, alapértelmezetten: 5559. maxmapsize A térképek maximális mérete (szélesség és magasság), alapértelmezetten: 1024. IECService Az IEC101 protokollal kapcsolatos szervíz konfigurációja. configuration A szükséges beállításokat tartalmazó fájl elérési útja.


1 log4J XML konfiguráció: http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/xml/DOMConfigurator.html

2 Torque konfiguráció: http://db.apache.org/torque/releases/torque-3.3/runtime/reference/initialisation-configuration.html Az itt leírtak a Properties fájlból való konfigurációra vonatkoznak, mely könnyedén átfordítható XML-lé: A tulajdonságokban szereplő pontok az XML-ben egy-egy gyerek elemet jelentenek, pl.: torque.default.connection.driver <> <torque><defaults><connection><driver>...</driver></conn...

3 HA-JDBC dialektusok: http://ha-jdbc.sourceforge.net/doc.html#dialect

4 Cron ütemező konfigurálása: http://www.quartz-scheduler.org/docs/tutorials/crontrigger.html

5 JGroups csatorna konfiguráció: http://www.jgroups.org/manual/html/user-advanced.html#d0e2444 Protokolok listája: http://www.jgroups.org/manual/html/protlist.html Egyéb információ: http://community.jboss.org/wiki/JGroups

Previous chapter-> First SIWENOID startup