Skip to main content
Skip table of contents

Configuration Bean erstellen

Eine Configuration Bean dient falls erforderlich zum Bündeln von Konfigurationsparametern einer Adapterinstanz und enthält Methoden zum Setzen der Konfigurationsparameter. Adapterinstanzen können über die Methode getConfigurationBean() auf das Configuration-Bean-Objekt zugreifen.

Configuration Bean anlegen

So legen Sie eine neue ConfigurationBean-Klasse im Paket an.

  1. Variablen definieren, die als Konfigurationsparameter dienen (nur vom Typ String möglich).

  2. Die Annotation @AdapterParameter deklariert ein Feld als Adapterkonfiguration. Es kann entweder eine eigene Configuration-Bean-Klasse geben, in der alle Parameter definiert sind, oder die Definition kann in der Adapterklasse selbst vorgenommen werden (eine Mischung ist nicht möglich!).

  3. Set/Get-Methoden für jeden Konfigurationsparameter definieren, die nach dem Muster set<Parametername>(<Wert>) bzw. get<Parametername>() benannt sein müssen.
    Das Grundgerüst der Configuration Bean ist nun fertig.

Metadaten für Adapter-Parameter definieren

Um Metadaten für Adapter-Parameter zu definieren, wird die Annotation @AdapterParameter verwendet:

Feld

Beschreibung

Pflicht

description

Textuelle Beschreibung, welchen Zweck der Parameter erfüllt

ja

dataType

Typ des Parameters

Mögliche Werte: PASSWORD, BOOLEAN, STRING, ARRAY, DOUBLE, INTEGER

ja

displayName

Anzeigename der Parameters. Standard ist der Name des Felds

nein

optional

Angabe, ob es sich um ein Pflichtparameter handelt

Mögliche Werte:

  • true: der Parameter ist kein Pflichtparameter

  • false: der Parameter ist ein Pflichtparameter (Standard) 

nein

defaultValue

Setzt einen initialen Wert für den Parameter

nein

Die Annotation @AllowedPropertyValue muss zusätzlich verwendet werden, wenn dataType auf ARRAY gesetzt ist, um die möglichen Werte zu setzen.

Feld

Beschreibung

displayName

Gibt den Anzeigename des Wertes an

value

Technischer Bezeichner, der in das Feld bei Selektion geschrieben wird

Beispiel

JAVA
import de.softproject.integration.adapter.annotations.AdapterParameter;
import de.softproject.integration.adapter.core.AdapterParameterDataType;
 
public class SimpleChartConfiguration {
 
    @AdapterParameter(dataType = AdapterParameterDataType.STRING, description = "set the title of the chart")
    private String chartTitle;
    @AdapterParameter(dataType = AdapterParameterDataType.INTEGER, description = "set the width of the chart", defaultValue = "300")
    private int chartWidth = 300;
 
    public String getChartTitle() {
        return chartTitle;
    }
 
    public void setChartTitle(String chartTitle) {
        this.chartTitle = chartTitle;
    }
 
    public int getChartWidth() {
        return chartWidth;
    }
 
    public void setChartWidth(int chartWidth) {
        this.chartWidth = chartWidth;
    }
}


JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.