jetbrains.exodus.backup

Class BackupStrategy

java.lang.Object

jetbrains.exodus.backup.BackupStrategy

public abstract class BackupStrategy
extends java.lang.Object

Describes how a backup file should be cooked by BackupBean. Only listed by getContents() and accepted by acceptFile(VirtualFileDescriptor) files are put into backup file with defined pre- (beforeBackup()) and postprocessing (afterBackup()).

See Also:

Backupable, BackupBean

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BackupStrategy.FileDescriptor Descriptor of a file to be put into backup file.

Field Summary

Fields

Modifier and Type	Field and Description
static BackupStrategy	EMPTY

Constructor Summary

Constructors

Constructor and Description
BackupStrategy()

Method Summary

Modifier and Type	Method and Description
long	acceptFile(@NotNull java.io.File file) Deprecated.
long	acceptFile(@NotNull VirtualFileDescriptor file)
void	afterBackup() Backup postprocessing procedure.
void	beforeBackup() Backup pre-processing procedure.
java.lang.Iterable<VirtualFileDescriptor>	getContents()
boolean	isInterrupted() Can be used to interrupt backup process.
java.lang.Iterable<BackupStrategy.FileDescriptor>	listFiles() Deprecated.
void	onError(java.lang.Throwable t) Override this method to define custom exception handling.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final BackupStrategy EMPTY

Constructor Detail

BackupStrategy

public BackupStrategy()

Method Detail

beforeBackup

public void beforeBackup()
                  throws java.lang.Exception

Backup pre-processing procedure. E.g., Environment turns database GC off before backup.

Throws:

java.lang.Exception - if something went wrong

getContents

public java.lang.Iterable<VirtualFileDescriptor> getContents()

listFiles

@Deprecated
public java.lang.Iterable<BackupStrategy.FileDescriptor> listFiles()

Deprecated.

afterBackup

public void afterBackup()
                 throws java.lang.Exception

Backup postprocessing procedure. E.g., Environment turns database GC on after backup.

Throws:

java.lang.Exception - if something went wrong

isInterrupted

public boolean isInterrupted()

Can be used to interrupt backup process. After each processed file, BackupBean checks if backup procedure should be interrupted.

Returns:

true if backup should be interrupted.

onError

public void onError(java.lang.Throwable t)

Override this method to define custom exception handling.

Parameters:

t - throwable thrown during backup.

acceptFile

public long acceptFile(@NotNull
                       @NotNull VirtualFileDescriptor file)

Parameters:

file - file to be backed up.

Returns:

the length of specified file that should be put into backup, minimum is taken between the actual file size and the value returned. If the method returns a less than one value the file won't be put into backup.

acceptFile

@Deprecated
public long acceptFile(@NotNull
                                    @NotNull java.io.File file)

Deprecated.

Parameters:

file - file to be backed up.

Returns:

ignored by API

See Also:

acceptFile(VirtualFileDescriptor)