de.bsvrz.ars.ars.backup
Interface BackupModul

All Known Implementing Classes:
DVDBackup, FileSystemBackup

public interface BackupModul

Diese Klasse dient als Interface fuer alle Backup-Module.

Author:
beck et al. projects GmbH, Alexander Schmidt

Field Summary
static String PROP_BACKUP_CONTAINER_PER_ZIP
           
static String PROP_BACKUP_MEDIUMSIZE
           
 
Method Summary
 void backupContainer(int mediumID, long contID, File contFile)
          Mit dieser Methode wird festgelegt, dass ein Container auf dem angegebenen und vorher geöffneten Medium zu speichern ist.
 void closeMediumAfterBackup(int mediumID, File indexFile)
          Sobald auf einem Medium keine Kapazität für weitere Container mehr vorhanden ist, wird der aktuelle Backup-Lauf auf diesem Medium mit dieser Methode abgeschlossen.
 List<String> getAllContFileNames(SuspendableTask task, int mediumID, int maxLimit)
          Liefert die zuletzt gesicherten Container, die sich auf dem Mediums befinden.
 boolean hasMediumCapacity(int mediumID, long containerSize, int mediumIndexSize)
          Liefert true, falls die noch zur Verfügung stehende Kapazität des angegebenen Mediums ausreicht, um einen Container der Größe fileSize und den Medienindex mit der momentanen Größe indexSize zu speichern.
 void initialize(Properties props)
          Diese Methode dient dem Initialisieren des BackupModuls.
 void openMediumBeforeBackup(int mediumID, String backupRunID)
          Diese Methode wird aufgerufen, bevor der erste Container auf dem Medium gesichert wird.
 InputStream restoreContainer(int mediumID, String contFileName)
          Mit dieser Methode wird ein InputStream der Containerdaten des Containers mit Namen contFile auf dem Medium mediumID erzeugt.
 

Field Detail

PROP_BACKUP_CONTAINER_PER_ZIP

static final String PROP_BACKUP_CONTAINER_PER_ZIP
See Also:
Constant Field Values

PROP_BACKUP_MEDIUMSIZE

static final String PROP_BACKUP_MEDIUMSIZE
See Also:
Constant Field Values
Method Detail

initialize

void initialize(Properties props)
                throws Exception
Diese Methode dient dem Initialisieren des BackupModuls. Da die Plugins immer mit leerem Konstruktor initialisiert werden, werden mit dieser Methode die Plugin-spezifischen Einstellungen vorgenommen. Fehlt ein obligatorischer Property-Key, wird eine Exception geworfen.

Parameters:
props -
Throws:
Exception

hasMediumCapacity

boolean hasMediumCapacity(int mediumID,
                          long containerSize,
                          int mediumIndexSize)
                          throws BackupException
Liefert true, falls die noch zur Verfügung stehende Kapazität des angegebenen Mediums ausreicht, um einen Container der Größe fileSize und den Medienindex mit der momentanen Größe indexSize zu speichern. Falls die Gesamtkapazität nicht durch den Medientyp eindeutig festgelegt ist, liefert das Backup-Modul einen sinnvollen Wert. Beispiel: 1 GB pro Aktenschrank in Keydox, jedoch keinesfalls die Größe der gesamten Festplatte. Ist das gewünschte Medium nicht im Zugriff, wird eine entsprechende Ausnahme ausgelöst.

Parameters:
mediumID -
containerSize -
mediumIndexSize -
Returns:
boolean
Throws:
BackupException

openMediumBeforeBackup

void openMediumBeforeBackup(int mediumID,
                            String backupRunID)
                            throws BackupException
Diese Methode wird aufgerufen, bevor der erste Container auf dem Medium gesichert wird. Mit dem Parameter backupRunID können mehrere Backup-Läufe, die dasselbe Medium verwenden, unterschieden werden. Laut Spezifikation in [TanfArS] kann es im Regelfall nicht auftreten, dass ein Container mehrmals auf demselben Medium abgelegt ist, weil bereits gesicherte Container kein zweitesmal gesichert werden. Es ist dennoch notwendig ein Verhalten für diesen Fall vorzugeben. Beim Wiederherstellen eines Containers wird daher der Container des Mediums verwendet, der unter der alphabetisch größten backupRunID abgelegt wurde.

Parameters:
mediumID - ID des Mediums
backupRunID - Zur Identifizierung des Sicherungslaufs falls mehrere Sicherungslaeufe auf einem Medium sind. Bei der Wiederherstellung eines Containers werden die Sicherungslaeufe von der alphabetisch letzten backupRunID beginnend bis zur alphabetisch ersten backupRunID nach dem angeforderten Container durchsucht.
Throws:
BackupException

backupContainer

void backupContainer(int mediumID,
                     long contID,
                     File contFile)
                     throws BackupException
Mit dieser Methode wird festgelegt, dass ein Container auf dem angegebenen und vorher geöffneten Medium zu speichern ist. Ob dies sofort geschieht oder später ist Sache der Implementierung. Das BackupModul kann den Parameter containerID verwenden, um z.B. die Container-Dateien zu sortieren oder um Hilfsdatenstrukturen für einen schnellen Zugriff anzulegen.

Parameters:
mediumID -
contID -
contFile -
Throws:
BackupException

closeMediumAfterBackup

void closeMediumAfterBackup(int mediumID,
                            File indexFile)
                            throws BackupException
Sobald auf einem Medium keine Kapazität für weitere Container mehr vorhanden ist, wird der aktuelle Backup-Lauf auf diesem Medium mit dieser Methode abgeschlossen. Der Parameter übergibt eine Indexdatei, die alle ContainerIDs enthält, die im aktuellen Backup-Lauf auf diesem Medium gesichert wurden. Diese Datei wird auf dem Medium gespeichert. Die weiteren Aufgaben, die einzelne Implementierungen der BackupModule-Schnittstelle hier zu erfüllen haben, sind unterschiedlich. Module, die sofort auf ein Medium schreiben können (Wechselplatten) erfordern keine weiteren Schritte. Für Medien wie DVDs wird in dieser Methode aus den gesammelten Containern ein Image erstellt und auf die DVD gebrannt; bei Keydox wird ein Logout ausgeführt.

Parameters:
mediumID -
indexFile -
Throws:
BackupException

restoreContainer

InputStream restoreContainer(int mediumID,
                             String contFileName)
                             throws BackupException
Mit dieser Methode wird ein InputStream der Containerdaten des Containers mit Namen contFile auf dem Medium mediumID erzeugt. Der BackupManager kopiert die Daten je nach Vorgang ganz oder teilweise in das Archivsystem oder in ein temporäres Verzeichnis. Diese Methode wird zum Wiederherstellen eines Containers, zum Abgleich/Wiederherstellung der Verwaltungsinformation und zur Verifikation verwendet.

Parameters:
mediumID -
contFileName -
Returns:
InputStream
Throws:
BackupException

getAllContFileNames

List<String> getAllContFileNames(SuspendableTask task,
                                 int mediumID,
                                 int maxLimit)
                                 throws BackupException
Liefert die zuletzt gesicherten Container, die sich auf dem Mediums befinden.

Wird fuer den Abgleich von Verwaltungsinformationen (@link HeaderRestoreTask) benoetigt.

Parameters:
task - Wird zum Anhalten des Backups benötigt, falls das Archivsystem in einen kritischen Bereich eintritt.
mediumID - MedienId des Mediums.
maxLimit - maximale Anzahl an zurueckgegebenen Containernamen. Wenn -1, dann ist das Ergebnis unlimitiert.
Returns:
Liste mit den Filenames der Container.
Throws:
BackupException