property

Integrationshandbücher › Referenzhandbuch zur ADL › Syntax des Komponenten-Deskriptors › Entität "property"

Entität "property"

Die Entität "property" definiert eine konfigurierbare Eigenschaft der Komponente. Jeder Parameter, der u. U. konfiguriert werden muss, kann als Eigenschaft definiert werden. Die Werte von Eigenschaften werden für die Software der Komponente auf die folgenden Weisen verfügbar gemacht:

Auf alle Eigenschaften kann von Shellscripts und ausführbaren Dateien über Umgebungsvariablen zugegriffen werden, die in einer Shelldatei definiert sind, Shelldateien werden automatisch im Startvolume der Komponente gespeichert und können von Skript eingebunden werden.
Alle Dateien, in einer Entität "cfgfiles" aufgeführt werden (siehe unten), werden nach speziellem Markup durchsucht, der einen Teil der Datei als entsprechenden Eigenschaftswert identifiziert. Alle übereinstimmenden Instanzen werden automatisch aktualisiert, um den Eigenschaftswert widerzuspiegeln, der im Deskriptor der Komponente konfiguriert oder von einer Assembly, die die Komponente nutzt, überschrieben wird. Es gibt einige Markup-Varianten, bei denen diese Entität als Kommentar zu der Software, die die Datei verwendet, angezeigt werden können, sodass sie vollkommen transparent für den Code der Komponente ist. Weitere Informationen finden Sie im Abschnitt Syntax von Eigenschaftsmarkierungen.

Hinweis: Weil ein Volume als eine konfigurierbare Eigenschaft auf der Grenze angezeigt werden kann, gehören Volumes und Eigenschaften dem gleichen Namespace an und müssen eindeutige Namen haben. Es ist daher nicht möglich, ein Volume und eine Eigenschaft mit dem gleichen Namen zu definieren.

Die Entität "property" hat die folgenden Attribute:

type=	Definiert den Eigenschaftstyp; dieses Attributs muss einen der folgenden Werte haben: string, integer, ip_addr oder IP_owned. Wenn das Attribut "type=" nicht angegeben wird, wird "string" angenommen. Hinweis: Der Typ "IP_owned" ist identisch mit "ip_addr". Er kann eine IPv4- oder IPv6-Adresse enthalten. Wenn "IP_owned" statt "ip_addr" verwendet wird, deutet dies darauf hin, dass die Adresse der Komponente selbst zugewiesen werden wird (das heißt, das IP-Sub-System der Komponente reagiert auf diese Adresse). Adressen, die nicht der Anwendung gehören, aber mit denen die Anwendung eine Verbindung herstellen soll (als externer Service), sollten den Typ "ip_addr" haben. Eine Eigenschaft vom Typ "IP_owned" wird vor dem Anwendungsstart überprüft. Wenn der gegebene Wert nicht innerhalb des für die Anwendungen im Raster zulässigen Bereichs liegt, wird der Anwendungsstart unterbunden. Vorhandene Appliances, die vor der Hinzufügung des Typs "IP_owned" erstellt wurden (und deswegen "ip_addr" verwenden), sind normalerweise lauffähig, können aber nicht die Überprüfung der konfigurierten IP-Adresse(n) vor dem Start nutzen. Wenn sie mit falschen Adressen eingerichtet werden, können sie einfach nicht ordnungsgemäß gestartet werden (Netzwerkpakete mit einer IP-Adresse, die dem Raster "fremd" ist, werden entfernt, bevor sie die Appliance reichen, selbst wenn das BS der Appliance so konfiguriert wird, dass es auf diese Adresse antwortet).
filter=	Ein regulärer Ausdruck, der den Satz zulässiger Werte für die Eigenschaft definiert. Der Ausdruck muss in der von Perl definierten Syntax für den Mustervergleich mit regulären Ausdrücken kodiert werden. Der gesamte Eigenschaftswert wird auf Übereinstimmung geprüft; das heißt, der Vergleich entspricht der Angabe /^expression$/ in einer Perl-Anweisung zum Mustervergleich (wobei expression der Wert des Filterattributs ist. Dieses Attribut ist optional. Wenn nicht angegeben, wird der Wert ".*" angenommen (stimmt mit jeder beliebigen Zeichenfolge überein).
values=	Dieses Attribut kann als Alternative zum Attribut "filter=" verwendet werden. Es wird vom ADL-Compiler genau wie das Filterattribut behandelt, nur dass die Verwendung von "values= expr." statt "filter= expr" dem GUI-Editor angibt, dass der reguläre Ausdruck eine einfache Verkettung von Zeichenfolgen ist, für die der Mustervergleich durchgeführt werden soll und die im Format regulärer Ausdrücke strng1!string2!... vorliegen. Es kann verwendet werden, um eine Dropdown-Liste von Werten auf einer Eigenschaftsseite statt eines Texteingabefelds anzuzeigen.
min= max=	Minimum und Maximalwerte für eine integre Eigenschaft. Wenn das angegebene Eigenschaftstyp "integer" lautet, geben diese optionalen Attribute die Grenzwerte des zulässigen Wertebereichs an. Sie werden zusätzlich zu den regulären Ausdrücken verwendet, die mit dem Attribut " filter=" angegeben werden. Wenn bei einem dieser Werte ein Minus- (-) oder Pluszeichen (+) vorhanden ist, wird genommen, dass der Ganzzahlvergleich im angegebenen Wertbereich für Ganzzahlen mit Vorzeichen durchgeführt werden soll.
Obligatorisch	Wenn dieses Attribut angegeben wird, zeigt es eine Eigenschaft ohne Standardwert an. Wenn die Komponente in einer Assembly verwendet wird, muss ein Wert für die Eigenschaft in der Assembly bereitgestellt werden oder es muss an die Assembly-Begrenzung umgeleitet werden; im letzteren Fall übernimmt die entsprechende Eigenschaft der Assembly auch das Attribut "mandatory". Wenn "mandatory" nicht angegeben wird, sollte ein Standardwert für die Eigenschaft mit dem Attribut "dflt=" angegeben werden (siehe unten).
dflt=	Gibt einen Standardwert für die Eigenschaft an. Dieses Attribut kann nicht zusammen mit dem Attribut "mandatory" verwendet werden.
lowercase	Gibt an, dass der Eigenschaftswert in Kleinbuchstaben konvertiert werden soll, bevor er zum Konfigurieren der Komponente verwendet wird. Dies sollte für Eigenschaften verwendet werden, bei denen der Anwender nicht zwischen Groß- und Kleinschreibung unterscheiden soll, aber der Komponente ein konsistenter Wert bereitgestellt werden muss, bei dessen Mustervergleich zwischen Groß- und Kleinschreibung unterschieden wird. Bei der Konvertierung in Kleinbuchstaben wird das Gebietsschema C zugrunde gelegt.