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(@NonNull UUID binaryTransferUuid, byte[] bytes, @NonNull String parameterIdentifier) Add a binary into the database
Duration	addBinary(UUID binaryTransferUuid, InputStream stream, @NonNull String parameterIdentifier) Add a binary into the database
static BinaryDatabase	current() Get a reference to the current BinaryDatabase from the Context.current()
Duration	extendBinaryExpiration(UUID binaryTransferUuid) Extend the expiration date of a binary
Binary	getBinary(UUID binaryTransferUuid) Get a binary by its identifier
BinaryInfo	getBinaryInfo(UUID binaryTransferUuid) Get the information of a binary by its identifier
boolean	hasBinary(UUID binaryTransferUuid) Check if the specified binary transfer UUID exists
void	removeAllBinaries() Remove all binaries from the database
void	removeBinary(UUID binaryTransferUuid) Remove a binary from the database

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

current

static BinaryDatabase current()

Get a reference to the current BinaryDatabase from the Context.current()

Returns:

The current BinaryDatabase

getBinary

Binary getBinary(UUID binaryTransferUuid)
          throws BinaryDatabaseException

Get a binary by its identifier

Parameters:

binaryTransferUuid - The binary transfer identifier

Returns:

The binary with the specified identifier

Throws:

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

getBinaryInfo

BinaryInfo getBinaryInfo(UUID binaryTransferUuid)
                  throws BinaryDatabaseException

Get the information of a binary by its identifier

Parameters:

binaryTransferUuid - the binary transfer identifier

Returns:

The information of the binary with the specified identifier

Throws:

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

hasBinary

boolean hasBinary(UUID binaryTransferUuid)
           throws BinaryDatabaseException

Check if the specified binary transfer UUID exists

Parameters:

binaryTransferUuid - the binary transfer identifier

Returns:

True if the binary is present in the database

Throws:

BinaryDatabaseException - if enable to check the existance of the binary in the database

addBinary

Duration addBinary(@NonNull
                   @NonNull UUID binaryTransferUuid,
                   byte[] bytes,
                   @NonNull
                   @NonNull String parameterIdentifier)
            throws BinaryDatabaseException

Add a binary into the database

Parameters:

binaryTransferUuid - The binary transfer identifier

bytes - The data to save in the database

parameterIdentifier - The fully qualified parameter identifier

Returns:

The expiration duration of the binary

Throws:

BinaryDatabaseException - when the binary cannot be added into database

addBinary

Duration addBinary(UUID binaryTransferUuid,
                   InputStream stream,
                   @NonNull
                   @NonNull String parameterIdentifier)
            throws BinaryDatabaseException

Add a binary into the database

Parameters:

binaryTransferUuid - The binary transfer identifier

stream - The data stream to save in the database

parameterIdentifier - The fully qualified parameter identifier

Returns:

The expiration duration of the binary

Throws:

BinaryDatabaseException - when the binary cannot be added into database

extendBinaryExpiration

Duration extendBinaryExpiration(UUID binaryTransferUuid)
                         throws BinaryDatabaseException

Extend the expiration date of a binary

Parameters:

binaryTransferUuid - The binary transfer 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 binaryTransferUuid)
           throws BinaryDatabaseException

Remove a binary from the database

Parameters:

binaryTransferUuid - The binary transfer identifier to remove

Throws:

BinaryDatabaseException - when the binary cannot be removed from the database