Integrationshandbücher › Referenzhandbuch zur ADL › Eigenschafts-Markup-Syntax › Allgemeine Anforderungen

Allgemeine Anforderungen

Eine Konfigurationsdatei kann Eigenschafts-Markup einfügen, wenn die Syntax der Datei den folgenden Bedingungen entspricht:

• Es ist eine Klartextdatei, also eine Datei, die mit einem Texteditor geöffnet und bearbeitet werden kann.
• Wenn die Textdatei Multibytezeichen enthält, wird die UTF-8-Kodierung oder eine ähnliche Kodierung verwendet, die als Byte-Strom verarbeitet als Wert im Bereich von 0 bis 127 interpretiert und kontextunabhängig den entsprechenden Latin-ASCII-Zeichen zugeordnet werden kann.
• Das Dateiformat erlaubt es, Kommentare einzufügen, die transparent für den Code der Komponente sind, der die Konfigurationsdatei verwendet. Die Kommentarsyntax ist derart, dass Kommentare so nahe an den Eigenschaftswerten platziert werden können, dass sie hilfreich sein können.
• Innerhalb eines Kommentars dienen die Zeichen ["$: , -\] nicht als Endmarken des Kommentarblocks und werden nicht als Sonderzeichen interpretiert.
• Es müssen keine Eigenschaften konfiguriert werden, damit das Zeichen für den Zeilenumbruch als Teil ihres Wertes zulässig ist.
• Wenn das Zeilenumbruchzeichen die Endmarke für keinen Kommentarblock darstellt, dann muss das Dateiformat es erlauben, dass im normalen Text alle Zeichen, die Teil einer Kommentarendmarke sind, so kodiert werden, dass sie nicht wie eine Kommentarendmarke aussehen.
• Wenn die Datei von einem anderen Programm als dem AppLogic-Dienstprogramm zur Reparatur von Volumes gelesen und geschrieben wird, werden die Markup-Kommentare beibehalten und zusätzliche Zeilenvorschübe werden nicht in einen Eigenschaftswert eingefügt.
• Wenn die Datei von einem anderen Programm als dem AppLogic-Dienstprogramm zur Reparatur von Volumes gelesen und geschrieben wird, dann muss sich sicherstellen lassen, dass beim erneuten Schreiben, kein neuer Text zwischen einen Markup-Kommentar und den zugehörigen Eigenschaftswert eingefügt wird.

Die folgenden Dateiformate erfüllen bekanntermaßen die obigen Anforderungen und sind deswegen wichtig:

• Zeilenorientierte Linux-Konfigurationsdateien (die sich in der Regel im Verzeichnis /etc/ befinden und das Suffix .conf haben), in denen Zeilen, die mit dem Zeichen # anfangen, als Kommentare betrachtet werden
• sh/bash und Perl-Skripten
• Quelldateien in C++ (einschließlich Headerdateien).
• Quelldateien in C, wenn mit GCC oder einem anderen Compiler kompiliert, der einzeilige C++Kommentare (//) zulässt.
• HTML und ähnliche SGML-Dateien

Zur Handhabung nicht instrumenteller Dateien empfiehlt sich, ein bash-Skript (oder Perl-Skript) zu schreiben, das die Konfigurationsdatei beim Starten aktualisiert und das Skript selbst zu nutzen.