Besteht eine Verbindung zum Server, muß man sich zuerst anmelden, um weitere Serverkommandos benutzen zu können. Das geschieht mit der Methode login(). Diese Methode benötigt einige Parameter, von denen nur der user Pflicht ist.
Nach erfolgreicher Anmeldung gibt die Methode die vom Server vergebene eindeutige SessionId als String zurück.
| Typ Parameter | Pflicht | Beschreibung |
|---|---|---|
| String user | J | Benutzername |
| String configuration | N | Pfad zur DLE Session Konfigurationsdatei. Keine Angabe verwendet die DLESessionConfig.xml. Ein ~ am Anfang des Dateinamens dient als Platzhalter für das DLE Installationsverzeichnis. Relative Pfade sind nicht erlaubt. Alle anderen Angaben sind relativ zum client/ Verzeichnis der DLE. |
| Locale locale | N | Sprach/Ländereinstellung, die verwendet werden soll. Keine Angabe verwendet die aktuelle Einstellung. |
| Sring businessClientId | N | Die Mandantenkennung, keine Angabe verwendet die 1. |
| String previousSessionId | N | Wurde vorher ein logout() mit keepSession = true gemacht, kann hier die vorher benutzte SessionId übergeben werden. Der Server benutzt dann die zuvor erstellte Session weiter. |
| Map parameters | N | Eine optionale weitere Liste von Parametern. Wird derzeit nicht verwendet. |
Mögliche Exceptions:
- IOException – Kommunikationsfehler
- DLEUnknownMessageTypeException – Server hat eine unbekannte Nachricht erhalten
- DLEServerException – Interner Server Fehler
- DLELoginFailedException – Login ist fehlgeschlagen
- DLEUnexpectedAnswerException – Der Client hat eine unbekannte Antwort erhalten