Class UserLogin


  • public abstract class UserLogin
    extends java.lang.Object
    Authentifizierungsstatus einer Applikation, Dav-Dav-Verbindung bzw. eines Benutzers
    • Constructor Summary

      Constructors 
      Constructor Description
      UserLogin()  
    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract long getRemoteUserId()
      Gibt die ID des Benutzerobjekts zurück
      abstract boolean isAuthenticated()
      Gibt true zurück, wenn der Benutzer erfolgreich authentifiziert wurde
      abstract boolean isRegularUser()
      Gibt true zurück, wenn es sich um einen normalen Benutzer aus der Konfiguration handelt
      abstract boolean isSystemUser()
      Gibt true zurück, wenn es sich um einen speziellen Systembenutzer handelt.
      static UserLogin notAuthenticated()
      Gibt die Instanz zurück, die angibt, dass der Benutzer (noch) nicht authentifiziert ist
      static UserLogin ofLong​(long l)
      Für Serialisierungszwecke kann ein Long in eine Instanz dieses Objekts umgewandelt werden
      static UserLogin systemUser()
      Gibt die Instanz zurück, die angibt, dass der Benutzer ein Systembenutzer ist, und keine Rechteprüfung durchgeführt wird
      abstract long toLong()
      Konvertiert dieses Objekt für Serialisierungszwecke in ein Long
      static UserLogin user​(long remoteUserId)
      Gibt die Instanz zurück, die angibt, dass es sich um einen normalen Benutzer handelt
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • UserLogin

        public UserLogin()
    • Method Detail

      • notAuthenticated

        public static UserLogin notAuthenticated()
        Gibt die Instanz zurück, die angibt, dass der Benutzer (noch) nicht authentifiziert ist
        Returns:
        Nicht-Authentifiziert-Instanz
      • systemUser

        public static UserLogin systemUser()
        Gibt die Instanz zurück, die angibt, dass der Benutzer ein Systembenutzer ist, und keine Rechteprüfung durchgeführt wird
        Returns:
        Systembenutzer-Instanz
      • user

        public static UserLogin user​(long remoteUserId)
        Gibt die Instanz zurück, die angibt, dass es sich um einen normalen Benutzer handelt
        Parameters:
        remoteUserId - Benutzer-ID
        Returns:
        Instanz
      • ofLong

        public static UserLogin ofLong​(long l)
        Für Serialisierungszwecke kann ein Long in eine Instanz dieses Objekts umgewandelt werden
        Parameters:
        l - Long
        Returns:
        Instanz
      • isAuthenticated

        public abstract boolean isAuthenticated()
        Gibt true zurück, wenn der Benutzer erfolgreich authentifiziert wurde
        Returns:
        true, wenn der Benutzer erfolgreich authentifiziert wurde, sonst false
      • getRemoteUserId

        public abstract long getRemoteUserId()
        Gibt die ID des Benutzerobjekts zurück
        Returns:
        die ID des Benutzerobjekts
        Throws:
        java.lang.IllegalStateException - Wenn Benutzer nicht authentifiziert ist oder er keine ID besitzt (Systembenutzer)
      • isRegularUser

        public abstract boolean isRegularUser()
        Gibt true zurück, wenn es sich um einen normalen Benutzer aus der Konfiguration handelt
        Returns:
        true, wenn es sich um einen normalen Benutzer aus der Konfiguration handelt, sonst false
      • isSystemUser

        public abstract boolean isSystemUser()
        Gibt true zurück, wenn es sich um einen speziellen Systembenutzer handelt. Dies ist beispielsweise der Benutzer, mit die lokale Datenverteilerverbindung und die Konfiguration sich beim Datenverteiler authentifiziert. Für Systembenutzer wird keine Rechteprüfung durchgeführt.
        Returns:
        true, wenn es sich um einen speziellen Systembenutzer handelt, sonst false
      • toLong

        public abstract long toLong()
        Konvertiert dieses Objekt für Serialisierungszwecke in ein Long
        Returns:
        Long-Wert