Package io.bdeploy.bhive

Class BHive

java.lang.Object

io.bdeploy.bhive.BHive

All Implemented Interfaces:

BHiveExecution, AutoCloseable

public class BHive
extends Object
implements AutoCloseable, BHiveExecution

A high level management layer for storage repositories.

Encapsulates ObjectDatabase and ManifestDatabase, provides over arching functionality.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BHive.Operation<T>	Base class for all operations that need to access internals of the BHive they are executed on.
static class	BHive.TransactedOperation<T>	Base class for operations which require an open transaction, set up by the caller.

Constructor Summary

Constructors

Constructor	Description
BHive(URI uri, Auditor auditor, ActivityReporter reporter)	Creates a new hive instance.

Method Summary

Modifier and Type	Method	Description
void	addSpawnListener(ManifestSpawnListener listener)
void	close()
<T> T	execute(BHive.Operation<T> op)	Execute the given BHive.Operation on this BHive.
Auditor	getAuditor()	Retrieve the auditor for testing.
protected Supplier<String>	getLockContentSupplier()	Get the supplier that provides lock file content
protected Predicate<String>	getLockContentValidator()	Get the predicate that is used to validate an existing lock file.
BHiveTransactions	getTransactions()
URI	getUri()
void	removeSpawnListener(ManifestSpawnListener listener)
void	setLockContentSupplier(Supplier<String> lockContentSupplier)	Sets the supplier that provides the content that is written to a lock file.
void	setLockContentValidator(Predicate<String> lockContentValidator)	Sets the predicate that is used to validate an existing lock file.
void	setParallelism(int parallelism)	Set the amount of threads to use for parallel-capable file operations.

Methods inherited from class java.lang.Object

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

Constructor Details

BHive

public BHive(URI uri,
 Auditor auditor,
 ActivityReporter reporter)

Creates a new hive instance. Supports ZIP and directory hives.

To connect to a remote hive instead, use RemoteBHive.forService(io.bdeploy.common.security.RemoteService, String, ActivityReporter)

Method Details

getUri

public URI getUri()

setParallelism

public void setParallelism(int parallelism)

Set the amount of threads to use for parallel-capable file operations.

getAuditor

public Auditor getAuditor()

Retrieve the auditor for testing.

addSpawnListener

public void addSpawnListener(ManifestSpawnListener listener)

removeSpawnListener

public void removeSpawnListener(ManifestSpawnListener listener)

setLockContentSupplier

public void setLockContentSupplier(Supplier<String> lockContentSupplier)

Sets the supplier that provides the content that is written to a lock file.

setLockContentValidator

public void setLockContentValidator(Predicate<String> lockContentValidator)

Sets the predicate that is used to validate an existing lock file.

getLockContentSupplier

protected Supplier<String> getLockContentSupplier()

Get the supplier that provides lock file content

getLockContentValidator

protected Predicate<String> getLockContentValidator()

Get the predicate that is used to validate an existing lock file.

execute

public <T> T execute(BHive.Operation<T> op)

Execute the given BHive.Operation on this BHive.

Specified by:

execute in interface BHiveExecution

Parameters:

op - the BHive.Operation to execute

Returns:

the BHive.Operations declared return type.

getTransactions

public BHiveTransactions getTransactions()

Specified by:

getTransactions in interface BHiveExecution

Returns:

the BHiveTransactions tracker.

close

public void close()

Specified by:

close in interface AutoCloseable