Global Parameter Management

Dieser Adapter verwaltet die globalen Parameter im definierten Parameterspeicher.

Eigenschaften (Properties)

Operation

Hier legen Sie fest, welche Operation der Adapter ausführt.

Mögliche Werte:

AddKeys: Fügt alle Parameter in den jeweiligen Parametergruppen hinzu
Export: Exportiert alle Parameter aus dem Parameterspeicher (benötigt kein Input-Dokument)
Get: Gibt alle Parameter der angefragten Parametergruppen unter Berücksichtigung des Caches aus
Import: Alle Parameter in den jeweiligen Parametergruppen werden hinzugefügt oder ersetzt
Refresh: Lädt die Parameter aus der Datenbank neu
RemoveKeys: Entfernt alle Parameter in den jeweiligen Parametergruppen
RemoveGroups: Entfernt alle Parametergruppen
ReplaceGroups: Ersetzt alle Parameter in den jeweiligen Parametergruppen

Parameter

Adapter

Hauptklasse des Adapters (nicht verändern!)

Mögliche Werte: de.softproject.x4.plugins.globalparameter.adapter.GlobalParameterStorageAdapter: Hauptklasse (Standard)

Statuswerte

`1 (successful)`	Die Operation war erfolgreich
`-1 (failed)`	Die Operation schlug aufgrund eines technischen Fehlers fehl

Die Dokumentation der ReST-Schnittstelle finden Sie unter http://localhost:8080/X4/X4Api/.

Input

Für die Operationen Get, AddKeys, RemoveKeys, RemoveGroups, ReplaceGroups und Import werden folgende Input-XML-Dokumente erwartet:

Operation Get

Folgende Input-XML-Struktur lädt die Gruppen DEV und DEFAULT aus dem Parameterspeicher:

XML

<?xml version="1.0" encoding="UTF-8"?>
<Placeholder>
	<Group name="DEV"/>
	<Group name="DEFAULT"/>
</Placeholder>

Operation AddKeys & ReplaceGroups & Import

Folgendes XML-Dokument beschreibt Parameter zum Hinzufügen, Ersetzen und Importieren:

XML

<?xml version="1.0" encoding="UTF-8"?>
<Placeholder><!-- Bei Operation Import optionales Attribut (default=false): deleteAndImport=true|false -->
	<Group name="DEV">
		<Key name="message" type="String">Hallo X4 Entwickler!</Key><!--  gültige Typen: String|Password|Boolean|Integer|Decimal|Date -->
	</Group>
	<Group name="DEFAULT">
		<Key name="message" type="String">Hallo Welt!</Key>
		<Key name="endOfTheWorld" type="Date">2012-12-21</Key>
		<Key name="sayHello" type="Boolean">true</Key>
	</Group>
	<Group name="PASSW">
		<Key name="Password" type="Password">MyNewPassword</Key><!--  gültige Typen: String|Password|Boolean|Integer|Decimal|Date -->
	</Group>
</Placeholder>

Eine leere Parametergruppe beim Aufruf der Operation Replace führt dazu, dass die gesamte Parametergruppe geleert wird. Der Aufruf entspricht somit der Operation Remove. Bei der Operation Import ist es optional möglich, die entsprechenden Parametergruppen vor dem Import zu Löschen. Hierfür muss im Wurzel-Knoten das Attribut deleteAndImport auf true gesetzt werden.

Operation RemoveKeys

Folgendes XML-Dokument entfernt einzelne Parameter einer Gruppe:

XML

 <?xml version="1.0" encoding="UTF-8"?>
<Placeholder>
	<Group name="DEFAULT">
		<Key name="endOfTheWorld"/>
	</Group>
</Placeholder>

Operation RemoveGroups

Folgendes XML-Dokument entfernt eine ganze Parametergruppe:

XML

 <?xml version="1.0" encoding="UTF-8"?>
<Placeholder>
	<Group name="DEFAULT" />
</Placeholder>

Output

Die Operation Refresh gibt den aktuellen Status aller Parameter in einem XML-Dokument zurück.

Die Operationen geben die angefragten oder durch die Anfrage geänderten Parametergruppen zurück.

XML

<?xml version="1.0" encoding="UTF-8"?>
<Placeholder>
    <Group name="DEV">
        <Key name="message" type="String">Hallo X4-Entwickler!</Key>
    </Group>
    <Group name="DEFAULT">
        <Key name="message" type="String">Hallo Welt!</Key>
        <Key name="endOfTheWorld" type="Date">2012-12-21</Key>
        <Key name="sayHello" type="Boolean">true</Key>
    </Group>
	<Group name="PASSW">
		<Key name="Password" type="Password">MyNewPassword</Key>
	</Group>
</Placeholder>