sila_java.library.server_base.binary_transfer.database

Interface BinaryDatabase

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

H2BinaryDatabase

public interface BinaryDatabase
extends AutoCloseable

Interface of a binary database

Implementation Note:

The implementer must take care of removing expired entries

Method Summary

Modifier and Type	Method and Description
Duration	addBinary(UUID binaryId, InputStream stream) Add a binary into the database
Duration	extendBinaryExpiration(UUID binaryId) Extend the expiration date of a binary
Binary	getBinary(UUID binaryId) Get a binary by its identifier
BinaryInfo	getBinaryInfo(UUID binaryId) Get the information of a binary by its identifier
void	removeAllBinaries() Remove all binaries from the database
void	removeBinary(UUID binaryId) Remove a binary from the database
void	reserveBytes(long length) Reserve the required resources to store a binary of the specified length

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

getBinary

Binary getBinary(UUID binaryId)
          throws BinaryDatabaseException

Get a binary by its identifier

Parameters:

binaryId - the binary identifier

Returns:

The binary with the specified identifier

Throws:

BinaryDatabaseException - when the binary does not exist or cannot be retrieved

getBinaryInfo

BinaryInfo getBinaryInfo(UUID binaryId)
                  throws BinaryDatabaseException

Get the information of a binary by its identifier

Parameters:

binaryId - the binary identifier

Returns:

The information of the binary with the specified identifier

Throws:

BinaryDatabaseException - when the binary does not exist or cannot be retrieved

addBinary

Duration addBinary(UUID binaryId,
                   InputStream stream)
            throws BinaryDatabaseException

Add a binary into the database

Parameters:

binaryId - the binary identifier

stream - The data stream to save in the database

Returns:

the expiration duration of the binary

Throws:

BinaryDatabaseException - when the binary cannot be added into database

Implementation Note:

The ownership of data stream is given to the implementer and has to take care of closing the stream

extendBinaryExpiration

Duration extendBinaryExpiration(UUID binaryId)
                         throws BinaryDatabaseException

Extend the expiration date of a binary

Parameters:

binaryId - The binary identifier

Returns:

The extended expiration duration

Throws:

BinaryDatabaseException - when the binary expiration cannot be extended

removeAllBinaries

void removeAllBinaries()
                throws BinaryDatabaseException

Remove all binaries from the database

Throws:

BinaryDatabaseException - when the binaries cannot be removed from the database

removeBinary

void removeBinary(UUID binaryId)
           throws BinaryDatabaseException

Remove a binary from the database

Parameters:

binaryId - The binary identifier to remove

Throws:

BinaryDatabaseException - when the binary cannot be removed from the database

reserveBytes

void reserveBytes(long length)
           throws BinaryDatabaseException

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

Parameters:

length - The length of binary to store

Throws:

BinaryDatabaseException - when there is not enough resources available