Package de.svws_nrw.data.benutzer

Klasse BenutzerApiPrincipal

java.lang.Object

de.svws_nrw.data.benutzer.BenutzerApiPrincipal

Alle implementierten Schnittstellen:

Serializable, Principal

public final class BenutzerApiPrincipal
extends Object
implements Principal, Serializable

Diese Klasse beinhaltet die Principal-Objekte für den Authentifizierungsprozess über die OpenAPI-Schnittstelle. Sie ist zunächst unabhängig gehalten von der konkret gewählten HTTP-Server-Implementierung. Eine solche HTTP-Server-Implementierung wird ggf. für den internen Gebrauch weitere Principal-Objekte anlegen.

Siehe auch:

• Serialisierte Form

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
String	getName()
Benutzer	getUser()	Gibt das Benutzer-Objekt für den Datenbankzugriff zurück, welches diesem Principal zugeordnet ist.
boolean	isAuthenticated()	Gibt zurück, ob dieser Principal bei der SVWS-Datenbank authentifiziert ist.
static BenutzerApiPrincipal	login(String username, String password, String path)	Prüft, ob der Login mit dem angegebenen Benutzername und dem angegebenen Kennwort bei dem HTTP-Request gültig ist.
String	toString()

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Von Schnittstelle geerbte Methoden java.security.Principal

equals, hashCode, implies

Methodendetails

getUser

public Benutzer getUser()

Gibt das Benutzer-Objekt für den Datenbankzugriff zurück, welches diesem Principal zugeordnet ist.

Gibt zurück:

das Benutzer-Objekt für den Datenbankzugriff

isAuthenticated

public boolean isAuthenticated()

Gibt zurück, ob dieser Principal bei der SVWS-Datenbank authentifiziert ist.

Gibt zurück:

true, falls dieser Principal bei der SVWS-Datenbank authentifiziert ist.

toString

public String toString()

Angegeben von:

toString in Schnittstelle Principal

Setzt außer Kraft:

toString in Klasse Object

getName

public String getName()

Angegeben von:

getName in Schnittstelle Principal

login

public static BenutzerApiPrincipal login(String username,
 String password,
 String path)
                                  throws ApiOperationException

Prüft, ob der Login mit dem angegebenen Benutzername und dem angegebenen Kennwort bei dem HTTP-Request gültig ist.

Parameter:

username - der Benutzername

password - das Kennwort

path - der Pfad aus dem HTTP-Request

Gibt zurück:

der Benutzerprincipal, falls der Login gültig ist, sonst null

Löst aus:

ApiOperationException - im Fehlerfall