Interface AccessControlPlugin

All Known Implementing Classes:
ArchiveAccessControlPlugin, ConfigAccessControlPlugin

public interface AccessControlPlugin
Interface, das Datenverteiler-Zugriffssteuerungs-Plugins implementieren müssen. Diese Plugins diesen dazu den Datenverkehr nach bestimmten Attributgruppenverwendungen zu filtern, sodass weitere Rechteprüfungen durchgeführt werden können (beispielsweise ob ein Benutzer berechtigt ist, Konfigurationsänderungen auszuführen oder Archivanfragen zu stellen. Diese Prüfungen sind in der Konfiguration oder im Archivsystem mangels Authentifizierung nicht möglich).
  • Method Details

    • initialize

      void initialize(de.bsvrz.dav.daf.accessControl.AccessControlManager accessControlManager, de.bsvrz.dav.daf.main.ClientDavInterface clientDavInterface)
      Wird aufgerufen, nachdem das Plugin instantiiert wurde. Hiermit wird dem Plugin eine Verbindung zum Datenverteiler übergeben.
      Parameters:
      accessControlManager - Klasse, die die Standard-Zugriffsrechte verwaltet.
      clientDavInterface - Verbindung zum Datenverteiler
    • getAttributeGroupUsagesToFilter

      Collection<de.bsvrz.dav.daf.main.config.AttributeGroupUsage> getAttributeGroupUsagesToFilter()
      Wird nach initialize(AccessControlManager, de.bsvrz.dav.daf.main.ClientDavInterface) aufgerufen. Die Funktion soll alle Attributgruppenverwendungen zurückgeben, dessen Daten es ansehen und gegebenenfalls verändern will.
      Returns:
      Liste mit Attributgruppenverwendungen
    • handleData

      de.bsvrz.dav.daf.main.Data handleData(long userID, de.bsvrz.dav.daf.communication.lowLevel.telegrams.BaseSubscriptionInfo baseSubscriptionInfo, de.bsvrz.dav.daf.main.Data data)
      Wird aufgerufen wenn ein Datenpaket eintrifft, dass den in getAttributeGroupUsagesToFilter() angegebenen Attributgruppenverwendungen entspricht. Die Funktion kann
      • das Datenpaket unverändert weitergeben
      • das Datenpaket modifizieren
      • ein neues Datenobjekt erstellen
      • das Datenpaket verwerfen
      Parameters:
      userID - Benutzer-ID, von dem das Datenpaket stammt. Ist nicht zwingend der Benutzer, der das Datenpaket abgesendet hat, sondern kann auch der Benutzer des Datenverteilers sein, der das Paket zuletzt verarbeitet hat. Die Standard-Berechtigungen zu diesem Benutzer können mit DafAccessControlManager.getUserPermissions(long) gelesen werden.
      baseSubscriptionInfo - Anmeldung für die das Datenpaket verschickt wurde.
      data - Datenpaket, das gefiltert wurde.
      Returns:
      data
      Wenn das Datenpaket unverändert weitergesendet werden soll, ist der Parameter data zurückzugeben.
      data.createModifiableCopy()
      Wenn das Datenpaket verändert werden soll, kann mit data.createModifiableCopy() eine veränderbare Kopie erzeugt und entsprechend verändert werden. Diese Kopie ist dann zurückzugeben.
      clientDavInterface.createData()
      Mit der in initialize(AccessControlManager, de.bsvrz.dav.daf.main.ClientDavInterface) angegebenen Datenverteilerverbindung kann auch ein neues Data-Objekt erstellt und zurückgegeben werden. Zu beachten ist, dass es dennoch an die ursprüngliche Anmeldung verschickt wird und deshalb die gleiche Attributgruppe benutzen sollte, wie das originale Datenpaket. Ist das nicht der Fall tritt möglicherweise undefiniertes Verhalten auf.
      null
      Wird null zurückgegeben wird das Datenpaket verworfen und nicht weitergesendet. Sollte nur verwendet werden, wenn das Plugin selbst eine Antwort bzw. ein eigenes Datenpaket verschickt, oder wenn das Eintreffen des Datenpakets unwichtig ist und niemand auf eine eventuelle Antwort wartet.