Index

A B C D E F G H I L M N P R S T U V W Z
All Classes and Interfaces|All Packages|Serialized Form

A

addDirectory(long, String) - Method in interface nl.knaw.dans.layerstore.LayerDatabase

Adds a directory to the database.

addDirectory(long, String) - Method in class nl.knaw.dans.layerstore.LayerDatabaseImpl

archive(long, Runnable) - Method in class nl.knaw.dans.layerstore.ConsistencyCheckingAsyncLayerArchiver

archive(long, Runnable) - Method in class nl.knaw.dans.layerstore.DirectLayerArchiver

archive(long, Runnable) - Method in interface nl.knaw.dans.layerstore.LayerArchiver

Archives the specified layer.

Archive - Interface in nl.knaw.dans.layerstore

An archive is a file that contains a collection of files and directories.

archiveFrom(Path) - Method in interface nl.knaw.dans.layerstore.Archive

Archives the given staging directory overwriting the backing file, if it exists.

archiveLayer(long, boolean) - Method in class nl.knaw.dans.layerstore.LayeredItemStore

Requests the archiving of the layer with the specified id.

archiveProvider(ArchiveProvider) - Method in class nl.knaw.dans.layerstore.LayeredItemStore.Builder

ArchiveProvider - Interface in nl.knaw.dans.layerstore

Provides a way to create an Archive.

B

build() - Method in class nl.knaw.dans.layerstore.Item.ItemBuilder

build() - Method in class nl.knaw.dans.layerstore.ItemRecord.ItemRecordBuilder

build() - Method in class nl.knaw.dans.layerstore.LayeredItemStore.Builder

builder() - Static method in class nl.knaw.dans.layerstore.Item

builder() - Static method in class nl.knaw.dans.layerstore.ItemRecord

Builder() - Constructor for class nl.knaw.dans.layerstore.LayeredItemStore.Builder

C

canEqual(Object) - Method in class nl.knaw.dans.layerstore.Item

canEqual(Object) - Method in class nl.knaw.dans.layerstore.ItemRecord

check(long) - Method in interface nl.knaw.dans.layerstore.LayerConsistencyChecker

Checks the consistency of the given layer.

checkExecutableForSecurity(Path) - Static method in class nl.knaw.dans.layerstore.DmfTarRunner

checkExecutableForSecurity(Path) - Static method in class nl.knaw.dans.layerstore.SshRunner

checkLayerItemRecords(long) - Method in class nl.knaw.dans.layerstore.LayeredItemStore

Checks that the items in the database match the items in the layer.

checkRemoteBaseDirForSecurity(String) - Static method in class nl.knaw.dans.layerstore.DmfTarRunner

checkRemoteBaseDirForSecurity(String) - Static method in class nl.knaw.dans.layerstore.SshRunner

checkSameLayersOnStorageAndDb() - Method in class nl.knaw.dans.layerstore.LayeredItemStore

Checks that the layers in the database match the layers in the layer manager.

checkUserOrHostNameForSecurity(String) - Static method in class nl.knaw.dans.layerstore.DmfTarRunner

checkUserOrHostNameForSecurity(String) - Static method in class nl.knaw.dans.layerstore.SshRunner

closeLayer(long) - Method in class nl.knaw.dans.layerstore.LayeredItemStore

Closes the layer with the given id.

ConsistencyCheckingAsyncLayerArchiver - Class in nl.knaw.dans.layerstore

A LayerArchiver that archives layers in a separate thread.

ConsistencyCheckingAsyncLayerArchiver(LayerConsistencyChecker, Executor) - Constructor for class nl.knaw.dans.layerstore.ConsistencyCheckingAsyncLayerArchiver

content(byte[]) - Method in class nl.knaw.dans.layerstore.ItemRecord.ItemRecordBuilder

copyDirectoryOutOf(String, Path) - Method in interface nl.knaw.dans.layerstore.ItemStore

Copies the contents of a specified directory from the store to a given destination outside the store.

copyDirectoryOutOf(String, Path) - Method in class nl.knaw.dans.layerstore.LayeredItemStore

createArchive(long, boolean) - Method in interface nl.knaw.dans.layerstore.ArchiveProvider

Create a new Archive instance for the given layer ID.

createArchive(long, boolean) - Method in class nl.knaw.dans.layerstore.DmfTarArchiveProvider

createArchive(long, boolean) - Method in class nl.knaw.dans.layerstore.TarArchiveProvider

createArchive(long, boolean) - Method in class nl.knaw.dans.layerstore.ZipArchiveProvider

createDirectories(String) - Method in interface nl.knaw.dans.layerstore.ItemStore

Creates the directory at the specified path, including any necessary but nonexistent parent directories.

createDirectories(String) - Method in class nl.knaw.dans.layerstore.LayeredItemStore

D

database(LayerDatabase) - Method in class nl.knaw.dans.layerstore.LayeredItemStore.Builder

databaseBackedContentManager(DatabaseBackedContentManager) - Method in class nl.knaw.dans.layerstore.LayeredItemStore.Builder

DatabaseBackedContentManager - Interface in nl.knaw.dans.layerstore

Controls selecting and pre- and post-processing content for storage in the database.

deleteDirectory(String) - Method in interface nl.knaw.dans.layerstore.ItemStore

Deletes the directory at the given path, including all its contents.

deleteDirectory(String) - Method in class nl.knaw.dans.layerstore.LayeredItemStore

deleteFiles(List<String>) - Method in interface nl.knaw.dans.layerstore.ItemStore

Deletes the files at the given paths.

deleteFiles(List<String>) - Method in class nl.knaw.dans.layerstore.LayeredItemStore

deleteRecordsById(long...) - Method in interface nl.knaw.dans.layerstore.LayerDatabase

Deletes the records with the given ids.

deleteRecordsById(long...) - Method in class nl.knaw.dans.layerstore.LayerDatabaseImpl

deleteRemoteFile(String) - Method in class nl.knaw.dans.layerstore.DmfTarRunner

DirectLayerArchiver - Class in nl.knaw.dans.layerstore

A LayerArchiver that archives layers directly (synchronously), not performing any consistency checks.

DirectLayerArchiver() - Constructor for class nl.knaw.dans.layerstore.DirectLayerArchiver

Directory - Enum constant in enum class nl.knaw.dans.layerstore.Item.Type

A directory.

directoryIsEmpty(String) - Method in interface nl.knaw.dans.layerstore.ItemStore

Returns whether the directory at the given path is empty.

directoryIsEmpty(String) - Method in interface nl.knaw.dans.layerstore.LayerDatabase

Checks whether the directory at directoryPath is empty.

directoryIsEmpty(String) - Method in class nl.knaw.dans.layerstore.LayerDatabaseImpl

directoryIsEmpty(String) - Method in class nl.knaw.dans.layerstore.LayeredItemStore

DmfTarArchiveProvider - Class in nl.knaw.dans.layerstore

An ArchiveProvider that uses the dmftar command line tool to create and read DMF TAR archives.

DmfTarArchiveProvider(DmfTarRunner, SshRunner) - Constructor for class nl.knaw.dans.layerstore.DmfTarArchiveProvider

DmfTarRunner - Class in nl.knaw.dans.layerstore

A runner for the dmftar command line tool, which creates and reads DMF TAR archives on a remote host via SSH.

DmfTarRunner(Path, SshRunner, String, String, Path) - Constructor for class nl.knaw.dans.layerstore.DmfTarRunner

Creates a new DmfTarRunner.

E

equals(Object) - Method in class nl.knaw.dans.layerstore.Item

equals(Object) - Method in class nl.knaw.dans.layerstore.ItemRecord

exists(long) - Method in interface nl.knaw.dans.layerstore.ArchiveProvider

Check if an archive exists at the given path.

exists(long) - Method in class nl.knaw.dans.layerstore.DmfTarArchiveProvider

exists(long) - Method in class nl.knaw.dans.layerstore.TarArchiveProvider

exists(long) - Method in class nl.knaw.dans.layerstore.ZipArchiveProvider

existsPathLike(String) - Method in interface nl.knaw.dans.layerstore.ItemStore

Returns whether a path with the given pattern exists in the store.

existsPathLike(String) - Method in interface nl.knaw.dans.layerstore.LayerDatabase

Returns whether the path pattern matches any path in the database.

existsPathLike(String) - Method in class nl.knaw.dans.layerstore.LayerDatabaseImpl

existsPathLike(String) - Method in class nl.knaw.dans.layerstore.LayeredItemStore

F

File - Enum constant in enum class nl.knaw.dans.layerstore.Item.Type

A file.

fileExists(String) - Method in interface nl.knaw.dans.layerstore.Archive

Returns whether the file exists in the archive.

fileExists(String) - Method in class nl.knaw.dans.layerstore.SshRunner

Checks if the given archive name exists on the remote host.

fileExists(String, String) - Method in class nl.knaw.dans.layerstore.DmfTarRunner

Checks if a file exists in a DMF TAR archive on the remote host.

findLayersContaining(String) - Method in interface nl.knaw.dans.layerstore.LayerDatabase

Finds all the layers that contain the given path.

findLayersContaining(String) - Method in class nl.knaw.dans.layerstore.LayerDatabaseImpl

G

generatedId(Long) - Method in class nl.knaw.dans.layerstore.ItemRecord.ItemRecordBuilder

getAllRecords() - Method in interface nl.knaw.dans.layerstore.LayerDatabase

Retrieves a stream of all the records in the database.

getAllRecords() - Method in class nl.knaw.dans.layerstore.LayerDatabaseImpl

getContent() - Method in class nl.knaw.dans.layerstore.ItemRecord

getGeneratedId() - Method in class nl.knaw.dans.layerstore.ItemRecord

getHost() - Method in class nl.knaw.dans.layerstore.SshRunner

getLayerConsistencyChecker() - Method in class nl.knaw.dans.layerstore.LayeredItemStore

Returns the internal layer consistency checker.

getLayerId() - Method in class nl.knaw.dans.layerstore.ItemRecord

getLayerSizeInBytes(long) - Method in class nl.knaw.dans.layerstore.LayeredItemStore

Returns the size in bytes of the layer with the given id.

getMissingInDb() - Method in exception class nl.knaw.dans.layerstore.ItemsMismatchException

getMissingInDb() - Method in exception class nl.knaw.dans.layerstore.LayerIdsMismatchException

getMissingInStorage() - Method in exception class nl.knaw.dans.layerstore.ItemsMismatchException

getMissingInStorage() - Method in exception class nl.knaw.dans.layerstore.LayerIdsMismatchException

getPath() - Method in class nl.knaw.dans.layerstore.Item

The path of the item.

getPath() - Method in class nl.knaw.dans.layerstore.ItemRecord

getRecordsByLayerId(long) - Method in interface nl.knaw.dans.layerstore.LayerDatabase

Gets all records for the given layer id.

getRecordsByLayerId(long) - Method in class nl.knaw.dans.layerstore.LayerDatabaseImpl

getRecordsByPath(String) - Method in interface nl.knaw.dans.layerstore.LayerDatabase

Returns the records for the given path in any layer.

getRecordsByPath(String) - Method in class nl.knaw.dans.layerstore.LayerDatabaseImpl

getRemoteBaseDir() - Method in class nl.knaw.dans.layerstore.SshRunner

getTopLayerId() - Method in class nl.knaw.dans.layerstore.LayeredItemStore

Returns the id of the top layer, or null if there is no top layer.

getTopLayerSizeInBytes() - Method in class nl.knaw.dans.layerstore.LayeredItemStore

Returns the size in bytes of the top layer.

getType() - Method in class nl.knaw.dans.layerstore.Item

The type of the item.

getType() - Method in class nl.knaw.dans.layerstore.ItemRecord

H

hashCode() - Method in class nl.knaw.dans.layerstore.Item

hashCode() - Method in class nl.knaw.dans.layerstore.ItemRecord

I

isAllowReadingContentFromArchives() - Method in class nl.knaw.dans.layerstore.LayeredItemStore

Whether to allow reading content from archives.

isArchived() - Method in interface nl.knaw.dans.layerstore.Archive

Returns whether the archive has been created.

Item - Class in nl.knaw.dans.layerstore

A file or directory in the layer store.

Item.ItemBuilder - Class in nl.knaw.dans.layerstore

Item.Type - Enum Class in nl.knaw.dans.layerstore

The type of the item.

ItemRecord - Class in nl.knaw.dans.layerstore

A record in the database that represents a file or directory (i.e., Item) in a layer.

ItemRecord() - Constructor for class nl.knaw.dans.layerstore.ItemRecord

ItemRecord(Long, Long, String, Item.Type, byte[]) - Constructor for class nl.knaw.dans.layerstore.ItemRecord

ItemRecord.ItemRecordBuilder - Class in nl.knaw.dans.layerstore

ItemsMismatchException - Exception Class in nl.knaw.dans.layerstore

Exception thrown when the items in the database and the items in the storage do not match.

ItemsMismatchException(List<Item>, List<Item>) - Constructor for exception class nl.knaw.dans.layerstore.ItemsMismatchException

ItemStore - Interface in nl.knaw.dans.layerstore

An ItemStore stores "Items", which are files and directories.

L

layerArchiver(Function<LayerConsistencyChecker, LayerArchiver>) - Method in class nl.knaw.dans.layerstore.LayeredItemStore.Builder

layerArchiver(LayerArchiver) - Method in class nl.knaw.dans.layerstore.LayeredItemStore.Builder

LayerArchiver - Interface in nl.knaw.dans.layerstore

Interface for scheduling and executing layer archiving.

LayerConsistencyChecker - Interface in nl.knaw.dans.layerstore

Checks the consistency of a layer on storage as compared to the database.

layerConsistencyCheckerProxy(Function<LayerConsistencyChecker, LayerConsistencyChecker>) - Method in class nl.knaw.dans.layerstore.LayeredItemStore.Builder

LayerDatabase - Interface in nl.knaw.dans.layerstore

Provides access to the database that contains an ItemRecord for every file and directory (i.e., Item) stored in the layered storage.

LayerDatabaseImpl - Class in nl.knaw.dans.layerstore

An implementation of LayerDatabase that uses a PersistenceProvider to store ItemRecords.

LayerDatabaseImpl(PersistenceProvider<ItemRecord>) - Constructor for class nl.knaw.dans.layerstore.LayerDatabaseImpl

LayeredItemStore - Class in nl.knaw.dans.layerstore

An implementation of ItemStore that organizes files and directories (Items) in an ordered stack of Layers.

LayeredItemStore.Builder - Class in nl.knaw.dans.layerstore

layerId(Long) - Method in class nl.knaw.dans.layerstore.ItemRecord.ItemRecordBuilder

LayerIdsMismatchException - Exception Class in nl.knaw.dans.layerstore

Exception thrown when the layer ids in the database and the layer ids in the storage do not match.

LayerIdsMismatchException(List<Long>, List<Long>) - Constructor for exception class nl.knaw.dans.layerstore.LayerIdsMismatchException

listAllItems() - Method in interface nl.knaw.dans.layerstore.Archive

Lists all items in the archive.

listDirectory(String) - Method in interface nl.knaw.dans.layerstore.ItemStore

Returns the items in the given directory, taking into account the complete stack of layers.

listDirectory(String) - Method in interface nl.knaw.dans.layerstore.LayerDatabase

Lists the items in directoryPath.

listDirectory(String) - Method in class nl.knaw.dans.layerstore.LayerDatabaseImpl

listDirectory(String) - Method in class nl.knaw.dans.layerstore.LayeredItemStore

listFiles() - Method in class nl.knaw.dans.layerstore.SshRunner

Lists the files in the remote base directory.

listFiles(String) - Method in class nl.knaw.dans.layerstore.DmfTarRunner

Lists the files in a DMF TAR archive on the remote host.

listFiles(String) - Method in class nl.knaw.dans.layerstore.SshRunner

Lists the files in the remote base directory with the given flags.

listLayerIds() - Method in interface nl.knaw.dans.layerstore.ArchiveProvider

List all archived layer IDs.

listLayerIds() - Method in class nl.knaw.dans.layerstore.DmfTarArchiveProvider

listLayerIds() - Method in interface nl.knaw.dans.layerstore.LayerDatabase

Lists all layer IDs that are currently in the database.

listLayerIds() - Method in class nl.knaw.dans.layerstore.LayerDatabaseImpl

listLayerIds() - Method in class nl.knaw.dans.layerstore.LayeredItemStore

listLayerIds() - Method in class nl.knaw.dans.layerstore.TarArchiveProvider

listLayerIds() - Method in class nl.knaw.dans.layerstore.ZipArchiveProvider

listRecursive(String) - Method in interface nl.knaw.dans.layerstore.ItemStore

Returns the files and directories in the given directory and its subdirectories.

listRecursive(String) - Method in interface nl.knaw.dans.layerstore.LayerDatabase

Lists the items in directoryPath recursively.

listRecursive(String) - Method in class nl.knaw.dans.layerstore.LayerDatabaseImpl

listRecursive(String) - Method in class nl.knaw.dans.layerstore.LayeredItemStore

M

moveDirectoryInternal(String, String) - Method in interface nl.knaw.dans.layerstore.ItemStore

Moves the directory inside the store to the given destination.

moveDirectoryInternal(String, String) - Method in class nl.knaw.dans.layerstore.LayeredItemStore

moveDirectoryInto(Path, String) - Method in interface nl.knaw.dans.layerstore.ItemStore

Moves the directory outside the store into the given destination.

moveDirectoryInto(Path, String) - Method in class nl.knaw.dans.layerstore.LayeredItemStore

N

newTopLayer() - Method in class nl.knaw.dans.layerstore.LayeredItemStore

Creates a new top layer, archiving any existing top layer.

nl.knaw.dans.layerstore - package nl.knaw.dans.layerstore

NoopDatabaseBackedContentManager - Class in nl.knaw.dans.layerstore

A DatabaseBackedContentManager that does nothing.

NoopDatabaseBackedContentManager() - Constructor for class nl.knaw.dans.layerstore.NoopDatabaseBackedContentManager

P

path(String) - Method in class nl.knaw.dans.layerstore.Item.ItemBuilder

The path of the item.

path(String) - Method in class nl.knaw.dans.layerstore.ItemRecord.ItemRecordBuilder

postRetrieve(String, byte[]) - Method in interface nl.knaw.dans.layerstore.DatabaseBackedContentManager

Process the content after it is retrieved from the database.

postRetrieve(String, byte[]) - Method in class nl.knaw.dans.layerstore.NoopDatabaseBackedContentManager

preStore(String, byte[]) - Method in interface nl.knaw.dans.layerstore.DatabaseBackedContentManager

Process the content before it is stored in the database.

preStore(String, byte[]) - Method in class nl.knaw.dans.layerstore.NoopDatabaseBackedContentManager

R

readFile(String) - Method in interface nl.knaw.dans.layerstore.Archive

Returns an input stream for the file at the given path.

readFile(String) - Method in interface nl.knaw.dans.layerstore.ItemStore

Opens an input stream to the file at the given path.

readFile(String) - Method in class nl.knaw.dans.layerstore.LayeredItemStore

readFile(String, String) - Method in class nl.knaw.dans.layerstore.DmfTarRunner

Reads a file from a DMF TAR archive on the remote host.

renameRemoteFile(String, String) - Method in class nl.knaw.dans.layerstore.DmfTarRunner

runCommand(String) - Method in class nl.knaw.dans.layerstore.SshRunner

S

saveRecords(ItemRecord...) - Method in interface nl.knaw.dans.layerstore.LayerDatabase

Save records to the database.

saveRecords(ItemRecord...) - Method in class nl.knaw.dans.layerstore.LayerDatabaseImpl

setAllowReadingContentFromArchives(boolean) - Method in class nl.knaw.dans.layerstore.LayeredItemStore

Whether to allow reading content from archives.

setContent(byte[]) - Method in class nl.knaw.dans.layerstore.ItemRecord

setGeneratedId(Long) - Method in class nl.knaw.dans.layerstore.ItemRecord

setLayerId(Long) - Method in class nl.knaw.dans.layerstore.ItemRecord

setPath(String) - Method in class nl.knaw.dans.layerstore.ItemRecord

setType(Item.Type) - Method in class nl.knaw.dans.layerstore.ItemRecord

SshRunner - Class in nl.knaw.dans.layerstore

A runner for the ssh command line tool, which executes commands on a remote host via SSH.

SshRunner(Path, String, String, Path) - Constructor for class nl.knaw.dans.layerstore.SshRunner

Creates a new SshRunner.

SshRunner(Path, String, String, Path, int) - Constructor for class nl.knaw.dans.layerstore.SshRunner

Creates a new SshRunner.

stagingRoot(Path) - Method in class nl.knaw.dans.layerstore.LayeredItemStore.Builder

T

TarArchiveProvider - Class in nl.knaw.dans.layerstore

An ArchiveProvider that creates and reads TAR archives.

TarArchiveProvider(Path) - Constructor for class nl.knaw.dans.layerstore.TarArchiveProvider

tarDirectory(Path, String) - Method in class nl.knaw.dans.layerstore.DmfTarRunner

Create a DMF TAR archive from the contents of the given directory.

test(String) - Method in interface nl.knaw.dans.layerstore.DatabaseBackedContentManager

Test if the content at the given path should be stored in the database.

test(String) - Method in class nl.knaw.dans.layerstore.NoopDatabaseBackedContentManager

toItem() - Method in class nl.knaw.dans.layerstore.ItemRecord

toString() - Method in class nl.knaw.dans.layerstore.Item.ItemBuilder

toString() - Method in class nl.knaw.dans.layerstore.Item

toString() - Method in class nl.knaw.dans.layerstore.ItemRecord.ItemRecordBuilder

toString() - Method in class nl.knaw.dans.layerstore.ItemRecord

type(Item.Type) - Method in class nl.knaw.dans.layerstore.Item.ItemBuilder

The type of the item.

type(Item.Type) - Method in class nl.knaw.dans.layerstore.ItemRecord.ItemRecordBuilder

U

unarchiveTo(Path) - Method in interface nl.knaw.dans.layerstore.Archive

Unarchives the archive to the given staging directory.

untarArchive(String, Path) - Method in class nl.knaw.dans.layerstore.DmfTarRunner

Unpack an archive to the specified directory.

V

validateArchiveRoot(boolean) - Method in class nl.knaw.dans.layerstore.LayeredItemStore.Builder

validateRoot() - Method in interface nl.knaw.dans.layerstore.ArchiveProvider

Verifies that the archive root contains only valid archives.

validateRoot() - Method in class nl.knaw.dans.layerstore.DmfTarArchiveProvider

validateRoot() - Method in class nl.knaw.dans.layerstore.TarArchiveProvider

validateRoot() - Method in class nl.knaw.dans.layerstore.ZipArchiveProvider

valueOf(String) - Static method in enum class nl.knaw.dans.layerstore.Item.Type

Returns the enum constant of this class with the specified name.

values() - Static method in enum class nl.knaw.dans.layerstore.Item.Type

Returns an array containing the constants of this enum class, in the order they are declared.

W

writeFile(String, InputStream) - Method in interface nl.knaw.dans.layerstore.ItemStore

Writes the given content to the file at the given path.

writeFile(String, InputStream) - Method in class nl.knaw.dans.layerstore.LayeredItemStore

Z

ZipArchiveProvider - Class in nl.knaw.dans.layerstore

An ArchiveProvider that creates and reads ZIP archives.

ZipArchiveProvider(Path) - Constructor for class nl.knaw.dans.layerstore.ZipArchiveProvider

A B C D E F G H I L M N P R S T U V W Z
All Classes and Interfaces|All Packages|Serialized Form