sila_java.library.server_base.binary_transfer.database.impl

Class H2BinaryDatabase

java.lang.Object

sila_java.library.server_base.binary_transfer.database.impl.H2BinaryDatabase

All Implemented Interfaces:

AutoCloseable, BinaryDatabase

public class H2BinaryDatabase
extends Object
implements BinaryDatabase

Persisted implementation of BinaryDatabase using H2 database

Constructor Summary

Constructors

Constructor and Description
H2BinaryDatabase(@NonNull UUID serverId) Construct a BinaryDatabase for a specific server.

Method Summary

Modifier and Type	Method and Description
Duration	addBinary(@NonNull UUID binaryId, @NonNull InputStream stream) Save a binary stream to the database
void	close() Cleanup method Delete binaries, close the database and shutdown the cleaner worker
Duration	extendBinaryExpiration(@NonNull UUID binaryId) Extend the binary expiration duration by BINARY_EXTEND_DURATION
Binary	getBinary(@NonNull UUID binaryId) Retrieve a binary from the database
BinaryInfo	getBinaryInfo(@NonNull UUID binaryId) Retrieve a binary binary info
void	removeAllBinaries() Remove the BINARIES table and hence all binaries from the database
void	removeBinary(@NonNull UUID binaryId) Remove the specified binary from the database
void	reserveBytes(long length) Reserve the required resources to store a binary of the specified length

Methods inherited from class java.lang.Object

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

Constructor Detail

H2BinaryDatabase

public H2BinaryDatabase(@NonNull
                        @NonNull UUID serverId)
                 throws SQLException

Construct a BinaryDatabase for a specific server. The default credentials are database user database password The default binary expiration is seconds

Parameters:

serverId - The server UUID

Throws:

SQLException - raised if the SQL_INIT query fails

Method Detail

close

public void close()

Cleanup method Delete binaries, close the database and shutdown the cleaner worker

Specified by:

close in interface AutoCloseable

getBinary

public Binary getBinary(@NonNull
                        @NonNull UUID binaryId)
                 throws BinaryDatabaseException

Retrieve a binary from the database

Specified by:

getBinary in interface BinaryDatabase

Parameters:

binaryId - the binary identifier

Returns:

The binary if it exists

Throws:

BinaryDatabaseException - if the binary does not exist or the database connection failed

getBinaryInfo

public BinaryInfo getBinaryInfo(@NonNull
                                @NonNull UUID binaryId)
                         throws BinaryDatabaseException

Retrieve a binary binary info

Specified by:

getBinaryInfo in interface BinaryDatabase

Parameters:

binaryId - the binary identifier

Returns:

The binary if it exists

Throws:

BinaryDatabaseException - if the binary does not exist or the database connection failed

addBinary

public Duration addBinary(@NonNull
                          @NonNull UUID binaryId,
                          @NonNull
                          @NonNull InputStream stream)
                   throws BinaryDatabaseException

Save a binary stream to the database

Specified by:

addBinary in interface BinaryDatabase

Parameters:

binaryId - the binary identifier

stream - The data stream to save in the database

Returns:

The duration left until the binary expires

Throws:

BinaryDatabaseException - if the binary could not be saved

extendBinaryExpiration

public Duration extendBinaryExpiration(@NonNull
                                       @NonNull UUID binaryId)
                                throws BinaryDatabaseException

Extend the binary expiration duration by BINARY_EXTEND_DURATION

Specified by:

extendBinaryExpiration in interface BinaryDatabase

Parameters:

binaryId - The binary identifier

Returns:

The extended duration left until the binary expires

Throws:

BinaryDatabaseException - if the binary could not be extended

removeAllBinaries

public void removeAllBinaries()
                       throws BinaryDatabaseException

Remove the BINARIES table and hence all binaries from the database

Specified by:

removeAllBinaries in interface BinaryDatabase

Throws:

BinaryDatabaseException - If the removal of the binaries failed

removeBinary

public void removeBinary(@NonNull
                         @NonNull UUID binaryId)
                  throws BinaryDatabaseException

Remove the specified binary from the database

Specified by:

removeBinary in interface BinaryDatabase

Parameters:

binaryId - The binary identifier to remove

Throws:

BinaryDatabaseException - If to binary removal failed

reserveBytes

public void reserveBytes(long length)
                  throws BinaryDatabaseException

Description copied from interface: BinaryDatabase

Reserve the required resources to store a binary of the specified length

Specified by:

reserveBytes in interface BinaryDatabase

Parameters:

length - The length of binary to store

Throws:

BinaryDatabaseException

Implementation Note:

not implemented