Package org.apache.jackrabbit.oak.segment.azure

Class AzureArchiveManager

java.lang.Object

org.apache.jackrabbit.oak.segment.azure.AzureArchiveManager

All Implemented Interfaces:

SegmentArchiveManager

public class AzureArchiveManager
extends Object
implements SegmentArchiveManager

Field Summary

Fields

Modifier and Type	Field	Description
protected IOMonitor	ioMonitor
protected FileStoreMonitor	monitor
protected com.azure.storage.blob.BlobContainerClient	readBlobContainerClient
protected String	rootPrefix
protected com.azure.storage.blob.BlobContainerClient	writeBlobContainerClient

Constructor Summary

Constructors

Constructor	Description
AzureArchiveManager(com.azure.storage.blob.BlobContainerClient readBlobContainerClient, com.azure.storage.blob.BlobContainerClient writeBlobContainerClient, String rootPrefix, IOMonitor ioMonitor, FileStoreMonitor fileStoreMonitor, WriteAccessController writeAccessController)

Method Summary

Modifier and Type	Method	Description
void	backup(@NotNull String archiveName, @NotNull String backupArchiveName, @NotNull Set<UUID> recoveredEntries)	Method is not deleting segments from the directory given with archiveName, if they are in the set of recovered segments.
void	copyFile(String from, String to)	Copies the archive with all the segments.
SegmentArchiveWriter	create(String archiveName)	Creates a new archive.
boolean	delete(String archiveName)	Deletes the archive if exists.
boolean	exists(String archiveName)	Check if archive exists.
SegmentArchiveReader	forceOpen(String archiveName)	Opens an archive that wasn't closed correctly.
protected String	getDirectory(String archiveName)	it must end with "/" otherwise we could overflow to other archives like data00000a.tar.bak
List<String>	listArchives()	List names of the available .tar archives.
SegmentArchiveReader	open(String archiveName)	Opens a given archive for reading.
void	recoverEntries(String archiveName, LinkedHashMap<UUID,byte[]> entries)	Finds all the segments included in the archive.
boolean	renameTo(String from, String to)	Renames the archive.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.jackrabbit.oak.segment.spi.persistence.SegmentArchiveManager

isReadOnly

Field Detail

readBlobContainerClient

protected final com.azure.storage.blob.BlobContainerClient readBlobContainerClient

writeBlobContainerClient

protected final com.azure.storage.blob.BlobContainerClient writeBlobContainerClient

rootPrefix

protected final String rootPrefix

ioMonitor

protected final IOMonitor ioMonitor

monitor

protected final FileStoreMonitor monitor

Constructor Detail

AzureArchiveManager

public AzureArchiveManager(com.azure.storage.blob.BlobContainerClient readBlobContainerClient,
                           com.azure.storage.blob.BlobContainerClient writeBlobContainerClient,
                           String rootPrefix,
                           IOMonitor ioMonitor,
                           FileStoreMonitor fileStoreMonitor,
                           WriteAccessController writeAccessController)

Method Detail

listArchives

public List<String> listArchives()
                          throws IOException

Description copied from interface: SegmentArchiveManager

List names of the available .tar archives.

Specified by:

listArchives in interface SegmentArchiveManager

Returns:

archive list

Throws:

IOException

open

public SegmentArchiveReader open(String archiveName)
                          throws IOException

Description copied from interface: SegmentArchiveManager

Opens a given archive for reading.

Specified by:

open in interface SegmentArchiveManager

Returns:

the archive reader or null if the archive doesn't exist or doesn't have a valid index

Throws:

IOException

forceOpen

public SegmentArchiveReader forceOpen(String archiveName)
                               throws IOException

Description copied from interface: SegmentArchiveManager

Opens an archive that wasn't closed correctly.

Specified by:

forceOpen in interface SegmentArchiveManager

Returns:

the archive reader or null if the implementation doesn't support opening an unclosed archive

Throws:

IOException

create

public SegmentArchiveWriter create(String archiveName)
                            throws IOException

Description copied from interface: SegmentArchiveManager

Creates a new archive.

Specified by:

create in interface SegmentArchiveManager

Returns:

the archive writer

Throws:

IOException

delete

public boolean delete(String archiveName)

Description copied from interface: SegmentArchiveManager

Deletes the archive if exists.

Specified by:

delete in interface SegmentArchiveManager

Returns:

true if the archive was removed, false otherwise

renameTo

public boolean renameTo(String from,
                        String to)

Description copied from interface: SegmentArchiveManager

Renames the archive.

Specified by:

renameTo in interface SegmentArchiveManager

Parameters:

from - the existing archive

to - new name

Returns:

true if the archive was renamed, false otherwise

copyFile

public void copyFile(String from,
                     String to)
              throws IOException

Description copied from interface: SegmentArchiveManager

Copies the archive with all the segments.

Specified by:

copyFile in interface SegmentArchiveManager

Parameters:

from - the existing archive

to - new name

Throws:

IOException

exists

public boolean exists(String archiveName)

Description copied from interface: SegmentArchiveManager

Check if archive exists.

Specified by:

exists in interface SegmentArchiveManager

Parameters:

archiveName - archive to check

Returns:

true if archive exists, false otherwise

recoverEntries

public void recoverEntries(String archiveName,
                           LinkedHashMap<UUID,byte[]> entries)
                    throws IOException

Description copied from interface: SegmentArchiveManager

Finds all the segments included in the archive.

Specified by:

recoverEntries in interface SegmentArchiveManager

Parameters:

archiveName - archive to recover

entries - results will be put there, in the order of presence in the archive

Throws:

IOException

backup

public void backup(@NotNull
                   @NotNull String archiveName,
                   @NotNull
                   @NotNull String backupArchiveName,
                   @NotNull
                   @NotNull Set<UUID> recoveredEntries)
            throws IOException

Method is not deleting segments from the directory given with archiveName, if they are in the set of recovered segments. Reason for that is because during execution of this method, remote repository can be accessed by another application, and deleting a valid segment can cause consistency issues there.

Specified by:

backup in interface SegmentArchiveManager

Throws:

IOException

getDirectory

protected String getDirectory(String archiveName)

it must end with "/" otherwise we could overflow to other archives like data00000a.tar.bak