Class ConfigFileBackupTask

java.lang.Object
de.bsvrz.puk.config.configFile.fileaccess.ConfigFileBackupTask

public class ConfigFileBackupTask
extends java.lang.Object
Klasse, die Konfigurationsdateien einer Konfiguration sichert.
  • Field Summary

    Fields
    Modifier and Type Field Description
    static int BACKUP_STATE_FINISHED  
    static int BACKUP_STATE_INITIALIZING  
    static int BACKUP_STATE_INPROGRESS  
  • Constructor Summary

    Constructors
    Constructor Description
    ConfigFileBackupTask​(ConfigAuthentication authentication, ConfigDataModel dataModel, java.lang.String target, de.bsvrz.dav.daf.main.config.ConfigurationAuthority configurationAuthority)
    Erstellt einen neuen ConfigFileBackupTask, welches keinerlei Fortschrittsmeldungen sendet.
    ConfigFileBackupTask​(ConfigAuthentication authentication, ConfigDataModel dataModel, java.lang.String target, de.bsvrz.dav.daf.main.config.ConfigurationAuthority configurationAuthority, de.bsvrz.dav.daf.main.config.BackupProgressCallback callback)
    Erstellt einen neuen ConfigFileBackupTask, welches den Fortschritt an ein lokales BackupProgressCallback-Objekt übergibt
    ConfigFileBackupTask​(ConfigAuthentication authentication, ConfigDataModel dataModel, java.lang.String target, de.bsvrz.dav.daf.main.config.ConfigurationAuthority configurationAuthority, de.bsvrz.dav.daf.main.impl.config.request.telegramManager.SenderReceiverCommunication senderReplyAreaTasks, int queryIndex)
    Erstellt einen neuen ConfigFileBackupTask, welches den Fortschritt über den Datenverteiler an ein RemoteRequester übermittelt
  • Method Summary

    Modifier and Type Method Description
    double getFileProgress()
    Gibt den aktuellen Fortschritt der aktuellen Datei zurück
    double getOverallProgress()
    Gibt den aktuellen Gesamt-Fortschritt zurück
    java.lang.String getTargetPath()
    Gibt das Zielverzeichnis zurück
    void startAsync()
    Startet einen Backup-Vorgang asynchron, wartet also nicht auf das Beenden.
    de.bsvrz.dav.daf.main.config.BackupResult startSync()
    Startet einen Backup-Vorgang und wartet auf das Beenden.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • BACKUP_STATE_INITIALIZING

      public static final int BACKUP_STATE_INITIALIZING
      See Also:
      Constant Field Values
    • BACKUP_STATE_INPROGRESS

      public static final int BACKUP_STATE_INPROGRESS
      See Also:
      Constant Field Values
    • BACKUP_STATE_FINISHED

      public static final int BACKUP_STATE_FINISHED
      See Also:
      Constant Field Values
  • Constructor Details

    • ConfigFileBackupTask

      public ConfigFileBackupTask​(ConfigAuthentication authentication, ConfigDataModel dataModel, java.lang.String target, de.bsvrz.dav.daf.main.config.ConfigurationAuthority configurationAuthority, de.bsvrz.dav.daf.main.config.BackupProgressCallback callback) throws java.io.IOException
      Erstellt einen neuen ConfigFileBackupTask, welches den Fortschritt an ein lokales BackupProgressCallback-Objekt übergibt
      Parameters:
      authentication - Klasse von der die benutzerverwaltung.xml gesichert werden soll
      dataModel - Lokale Konfiguration
      target - Zielverzeichnis, welches innerhalb von ConfigDataModel.getBackupBaseDirectory() angelegt werden soll.
      configurationAuthority - Konfigurationsverantwortlicher, dessen Konfigurations-Dateien gesichert werden sollen. Falls null werden alle Dateien gesichert.
      callback - Objekt, das über den Fortschritt des Backup-Vorgangs informiert werden soll.
      Throws:
      java.io.IOException - Wenn das angegebene target-Verzeichnis ungültig ist
    • ConfigFileBackupTask

      public ConfigFileBackupTask​(ConfigAuthentication authentication, ConfigDataModel dataModel, java.lang.String target, de.bsvrz.dav.daf.main.config.ConfigurationAuthority configurationAuthority, de.bsvrz.dav.daf.main.impl.config.request.telegramManager.SenderReceiverCommunication senderReplyAreaTasks, int queryIndex) throws java.io.IOException
      Erstellt einen neuen ConfigFileBackupTask, welches den Fortschritt über den Datenverteiler an ein RemoteRequester übermittelt
      Parameters:
      authentication - Klasse von der die benutzerverwaltung.xml gesichert werden soll
      dataModel - Lokale Konfiguration
      target - Zielverzeichnis, welches innerhalb von ConfigDataModel.getBackupBaseDirectory() angelegt werden soll.
      configurationAuthority - Konfigurationsverantwortlicher, dessen Konfigurations-Dateien gesichert werden sollen. Falls null werden alle Dateien gesichert.
      senderReplyAreaTasks - Verbindung mit dem RemoteRequestManager
      queryIndex - Anfrageindex @throws IOException Wenn das angegebene target-Verzeichnis ungültig ist
      Throws:
      java.io.IOException
    • ConfigFileBackupTask

      public ConfigFileBackupTask​(ConfigAuthentication authentication, ConfigDataModel dataModel, java.lang.String target, de.bsvrz.dav.daf.main.config.ConfigurationAuthority configurationAuthority) throws java.io.IOException
      Erstellt einen neuen ConfigFileBackupTask, welches keinerlei Fortschrittsmeldungen sendet.
      Parameters:
      authentication - Klasse von der die benutzerverwaltung.xml gesichert werden soll. Kann null sein, dann wird keine Benutzerverwaltung gesichert.
      dataModel - Lokale Konfiguration
      target - Zielverzeichnis, welches innerhalb von ConfigDataModel.getBackupBaseDirectory() angelegt werden soll. Falls null oder ein Leerstring angegeben wird, wird anhand des aktuellen Datums, der Uhrzeit und/oder anderen nicht näher spezifizierten Mechanismen ein eindeutiges neues Verzeichnis erstellt. Falls im ConfigDataModel kein Zielverzeichnis über ConfigDataModel.setBackupBaseDirectory(java.io.File) festgelegt wurde kann jedes beliebige absolute oder relative Verzeichnis angegeben werden.
      configurationAuthority - Konfigurationsverantwortlicher, dessen Konfigurations-Dateien gesichert werden sollen. Falls null werden alle Dateien gesichert.
      Throws:
      java.io.IOException - Wenn das angegebene target-Verzeichnis ungültig ist
  • Method Details

    • startAsync

      public void startAsync()
      Startet einen Backup-Vorgang asynchron, wartet also nicht auf das Beenden.
    • startSync

      public de.bsvrz.dav.daf.main.config.BackupResult startSync()
      Startet einen Backup-Vorgang und wartet auf das Beenden.
      Returns:
      Ergebnis des Backupvorgangs
    • getFileProgress

      public double getFileProgress()
      Gibt den aktuellen Fortschritt der aktuellen Datei zurück
      Returns:
      Ein Wert von 0.0 bis 1.0
    • getOverallProgress

      public double getOverallProgress()
      Gibt den aktuellen Gesamt-Fortschritt zurück
      Returns:
      Ein Wert von 0.0 bis 1.0
    • getTargetPath

      public java.lang.String getTargetPath()
      Gibt das Zielverzeichnis zurück
      Returns:
      Das absolute Verzeichnis, in dem das Backup angelegt wird