com.atlassian.jira.index.ha.backup

Class CloseableBackupBuilder

java.lang.Object

com.atlassian.jira.index.ha.backup.CloseableBackupBuilder

All Implemented Interfaces:

BackupBuilder, Closeable, AutoCloseable

public class CloseableBackupBuilder
extends Object
implements Closeable, BackupBuilder

Manages multi-step creation of an archive. Once created, each call of addToBackup(Collection, File) methods adds additional files to the archive. Requires closing to finalize creation of valid archive. Once closed will no longer allow adding any new files, and all methods will throw IOException

Field Summary

Fields inherited from interface com.atlassian.jira.util.Closeable

CLOSE

Method Summary

Modifier and Type	Method and Description
void	addToBackup(Collection<File> files, File rootDirectory) Add files to backup being built.
void	close() Closes this stream and releases any system resources associated with it.
static CloseableBackupBuilder	open(File snapshot, ArchiveUtils.Type archiveType, java.util.function.Consumer<File> filesObserver) Creates a new builder.

Methods inherited from class java.lang.Object

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

Method Detail

open

public static CloseableBackupBuilder open(@Nonnull
                                          File snapshot,
                                          @Nonnull
                                          ArchiveUtils.Type archiveType,
                                          @Nullable
                                          java.util.function.Consumer<File> filesObserver)

Creates a new builder. New builder will write all files to snapshot of type archiveType.

Parameters:

archiveType - path of archive to create, the file should not exist

snapshot - path of archive to create

filesObserver - optional consumer that will have access to all processed files before they're added to archive

addToBackup

public void addToBackup(Collection<File> files,
                        File rootDirectory)

Add files to backup being built. Set their relative paths inside the backup basing on their subpath within rootDirectory

Specified by:

addToBackup in interface BackupBuilder

Parameters:

files - list of existing files to be included to the backup

rootDirectory - determines relative subpaths of files in the archive , must be parent to the files(will throw an exeption otherwise)

close

public void close()

Description copied from interface: Closeable

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable