Package com.exedio.cope.vault

Interface VaultService

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

VaultFileService, VaultReferenceService

public interface VaultService
extends AutoCloseable

Implementations of VaultService must conform to the requirements set by Properties.valueService.

It is highly recommended to override toString with a informative message containing essential configuration of the service. For instance, this message is included into the result of ConnectProperties.probe().

All methods are guaranteed not to be called for the empty byte sequence - this special case must be handled by the caller.

Method Summary

Modifier and Type	Method	Description
default void	close()	Overrides method from AutoCloseable to add empty default implementation.
byte[]	get(String hash)
void	get(String hash, OutputStream sink)	Must not close or flush sink.
long	getLength(String hash)
default void	purgeSchema(JobContext ctx)	Gives this service the chance to purge / cleanup whatever it needs to.
boolean	put(String hash, byte[] value, VaultPutInfo info)	Is not called, if service instance was created with VaultServiceParameters.isWritable()==false.
boolean	put(String hash, InputStream value, VaultPutInfo info)	Is not called, if service instance was created with VaultServiceParameters.isWritable()==false.
boolean	put(String hash, Path value, VaultPutInfo info)	The caller must make sure, that value is not modified during the call.

Method Detail

purgeSchema

default void purgeSchema(@Nonnull
                         JobContext ctx)

Gives this service the chance to purge / cleanup whatever it needs to. Is called by Model.purgeSchema(JobContext). The default implementation does nothing.

close

default void close()

Overrides method from AutoCloseable to add empty default implementation. Also requires implementations not to declare any checked exception to be thrown.

Specified by:

close in interface AutoCloseable

getLength

long getLength(@Nonnull
               String hash)
        throws VaultNotFoundException

Throws:

VaultNotFoundException

get

byte[] get(@Nonnull
           String hash)
    throws VaultNotFoundException

Throws:

VaultNotFoundException

get

void get(@Nonnull
         String hash,
         @Nonnull
         OutputStream sink)
  throws VaultNotFoundException,
         IOException

Must not close or flush sink.

If this method throws a VaultNotFoundException, it MUST not have modified sink in any way. In particular it must not have written any byte to sink.

Throws:

VaultNotFoundException

IOException

put

boolean put(@Nonnull
            String hash,
            @Nonnull
            byte[] value,
            @Nonnull
            VaultPutInfo info)

Is not called, if service instance was created with VaultServiceParameters.isWritable()==false.

Returns:

true if hash has been initially stored in the vault by this call. The result is used for statistics only. If the implementation does not have this information available, simply return true.

put

boolean put(@Nonnull
            String hash,
            @Nonnull
            InputStream value,
            @Nonnull
            VaultPutInfo info)
     throws IOException

Is not called, if service instance was created with VaultServiceParameters.isWritable()==false.

Returns:

true if hash has been initially stored in the vault by this call. The result is used for statistics only. If the implementation does not have this information available, simply return true.

Throws:

IOException

put

boolean put(@Nonnull
            String hash,
            @Nonnull
            Path value,
            @Nonnull
            VaultPutInfo info)
     throws IOException

The caller must make sure, that value is not modified during the call. Is not called, if service instance was created with VaultServiceParameters.isWritable()==false.

Returns:

true if hash has been initially stored in the vault by this call. The result is used for statistics only. If the implementation does not have this information available, simply return true.

Throws:

IOException