Enterprise Services API

Owned by Former user (Deleted)
Juli 12, 2016
1 min read

Übersicht

CLARC Enterprise Services sind Dienste welche als managed Services im Kontext des CLARC ENTERPRISE daemons ausgeführt werden. Ein Beispiel wäre der CLARC ASE daemon.

Jeder Enterprise Service muss eine Reihe von Funktionen und Start-Parametern unterstützen um entsprechend eingebunden werden zu können.

Ein Enterprise Service ist eine Windows-Konsolen-Anwendung.

Start-Parameter

Folgende Start-Parameter müssen von jedem Enterprise Service unterstützt werden:

ParameterBedeutung
instanceidDie fortlaufende Nummer der lokalen Instanz des Services, beginnend bei 0. Wobei 0 die Master-Instanz definiert.
instancetoken32 stellige eindeutige ID welche u.a. intern im Service als Authentifizierungs-Code für Web-Requests verwendet wird.
portPort-Nummer des integrierten Web-Services. Siehe auch Services und Ports.

Aufrufbeispiel:

<clarc>\sys\ccasesrv.exe --instanceid=0 --instancetoken=B87B03B8A2C94E5297F7D372D721B9A6 --port=4410

Web-Service

Jeder Enterprise Service muss einen integrierten Web-Service mitbringen welcher nachfolgende Kommandos unterstützt:

ParameterBedeutung
/CCGETSTATUSXML

Im Ergebnis wird ein XML im Format CLARC Fast XML Format erwartet. Folgende Parameter müssen zurückgeliefert werden:

  • ServerName
  • ServerVersion
  • InstanceId
  • InstanceToken
  • StartDate
  • UpTime
  • HttpRequests
  • CurrentWarnings
  • CurrentErrors
  • CurrentCriticals
  • OverallWarnings
  • OverallErrors
  • OverallCriticals

Weitere Informationsattribute können optional übergeben werden.

/CCGETLOGXMLIm Ergebnis wird ein XML im Format CLARC Fast XML Format erwartet. Jeder Eintrag steht für eine Logzeile im internen Log-Format (siehe Logfiles und Logausgaben). Der Name der Property ist jeweils "Log". Die Anzahl der Logeinträge ist beliebig, wobei eine Menge von 1000 nicht überschritten werden sollte. Standard ist 100.
/CCSHUTDOWNBeim Aufruf dieses Kommandos soll sich der Dienst bei der nächsten Möglichkeit beenden.
/CCREFRESHDer Refresh Aufruf zeigt an, dass Konfigurationsänderungen vorliegen und diese aktualisiert werden sollen.
/CCTRIGGEROptionale Funktion welche als Trigger für interne Prozesse verwendet werden kann.

Alle aufgeführten Funktionen müssen auf einen gültigen Url Parameter "AuthCode" prüfen. Dieser muss mit dem instancetoken übereinstimmen. Ist dies nicht der Fall, muss die Anfrage abgelehnt werden.

Beispielaufruf:

http://localhost:4410/ccgetstatusxml?authcode=B87B03B8A2C94E5297F7D372D721B9A6