X4 Produktdokumentation

User Session Adapter

Dieser Adapter ermöglicht es, die Daten im Datenstrom in die User Session zu schreiben, Daten aus der User Session zu lesen und aufzulisten und die User Session zu invalidieren.


Eigenschaften (Properties)

Operation

Vom Adapter ausgeführte Operation

Mögliche Werte:

  • Store Content: Schreibt die Daten im Datenstrom in die User Session.

  • Get Content: Gibt den im Parameter key festgelegten Datensatz aus der User Session aus. 

  • List Content: Gibt eine Liste der Daten in der User Session aus.

  • Check User Session: Prüft, ob eine User Session existiert und gibt die User Session ID aus.

  • Clear Session data: Löscht die Daten in der User Session und invalidiert die User Session

Parameter

key

Bei Operation Get User Session: Wird als Filter verwendet.

Bei Operation Store User Session: Wird als Name verwendet, mit dem die Daten im Datenstrom in der User Session gespeichert werden.

Mögliche Werte:

Beliebige Zeichenfolge

sessionIdClaim

Name des Claims, der im Token die Session-ID enthält.

Mögliche Werte:

  • sid (Standard): Claim für die Session-ID für Keycloak

  • Beliebige Zeichenfolge

sessionLifetime

Legt die Lebensdauer der User Session in Minuten fest. Wenn die Session abgelaufen ist, werden alle über die Operation Store Content gespeicherten Daten gelöscht. Der Timer wird bei jedem Zugriff auf die Daten zurückgesetzt.

Mögliche Werte:

Beliebige Ganzzahl über 0 (Standard: 30)

Statuswerte

1

Die Adapter-Operation wurde erfolgreich ausgeführt.

-1

Bei der Ausführung des Adapters ist ein Fehler aufgetreten.

0

Die Adapter-Operation hat keine Ergebnisse geliefert.