Package com.exedio.cope.vault

Class VaultReferenceService

java.lang.Object

com.exedio.cope.vault.VaultReferenceService

All Implemented Interfaces:

VaultService, AutoCloseable

public final class VaultReferenceService
extends Object
implements VaultService

Method Summary

Modifier and Type	Method	Description
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)
VaultService	getMainService()
VaultService	getReferenceService()
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.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

purgeSchema

public void purgeSchema(JobContext ctx)

Description copied from interface: VaultService

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

Specified by:

purgeSchema in interface VaultService

close

public void close()

Description copied from interface: VaultService

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

Specified by:

close in interface VaultService

getMainService

public VaultService getMainService()

getReferenceService

public VaultService getReferenceService()

getLength

public long getLength(String hash)
               throws VaultNotFoundException

Specified by:

getLength in interface VaultService

Throws:

VaultNotFoundException

get

public byte[] get(String hash)
           throws VaultNotFoundException

Specified by:

get in interface VaultService

Throws:

VaultNotFoundException

get

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

Description copied from interface: VaultService

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.

Specified by:

get in interface VaultService

Throws:

VaultNotFoundException

IOException

put

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

Description copied from interface: VaultService

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

Specified by:

put in interface VaultService

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

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

Description copied from interface: VaultService

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

Specified by:

put in interface VaultService

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

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

Description copied from interface: VaultService

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.

Specified by:

put in interface VaultService

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

toString

public String toString()

Overrides:

toString in class Object