freenet.store.saltedhash

Class SaltedHashFreenetStore<T extends StorableBlock>

java.lang.Object

freenet.store.saltedhash.SaltedHashFreenetStore<T>

All Implemented Interfaces:

FreenetStore<T>, java.io.Closeable, java.lang.AutoCloseable

public class SaltedHashFreenetStore<T extends StorableBlock>
extends java.lang.Object
implements FreenetStore<T>

Index-less data store based on salted hash. Provide a pseudo-random replacement based on a salt value generated on create. Keys are check against a bloom filter before probing. Data are encrypted using the route key and the salt, so there is no way to recover the data without holding the route key. (For debugging, you can set OPTION_SAVE_PLAINKEY=true in source code)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SaltedHashFreenetStore.ShutdownDB

Nested classes/interfaces inherited from interface freenet.store.FreenetStore

FreenetStore.StoreType

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	NO_CLEANER_SLEEP

Method Summary

Modifier and Type	Method and Description
void	close()
void	close(boolean abort)
static <T extends StorableBlock> SaltedHashFreenetStore<T>	construct(java.io.File baseDir, java.lang.String name, StoreCallback<T> callback, java.util.Random random, long maxKeys, boolean useSlotFilter, SemiOrderedShutdownHook shutdownHook, boolean preallocate, boolean resizeOnStart, Ticker exec, byte[] masterKey)
void	destruct()
T	fetch(byte[] routingKey, byte[] fullKey, boolean dontPromote, boolean canReadClientCache, boolean canReadSlashdotCache, boolean ignoreOldBlocks, BlockMetadata meta) Retrieve a block.
void	forceValidEmpty() Testing only! Force all entries that say empty/unknown on the slot filter to empty/certain.
long	getBloomFalsePositive()
long	getMaxKeys()
StoreAccessStats	getSessionAccessStats()
StoreAccessStats	getTotalAccessStats()
FreenetStore<T>	getUnderlyingStore()
long	hits()
long	keyCount()
long	misses()
boolean	probablyInStore(byte[] routingKey) Check if a routing key probably
void	put(T block, byte[] data, byte[] header, boolean overwrite, boolean isOldBlock) Store a block.
boolean	put(T block, byte[] data, byte[] header, boolean overwrite, boolean isOldBlock, boolean wrongStore)
void	setAltStore(SaltedHashFreenetStore<T> store)
void	setMaxKeys(long newStoreSize, boolean shrinkNow) Change the store size.
void	setPreallocate(boolean preallocate) Set preallocate storage space
void	setUserAlertManager(UserAlertManager userAlertManager)
boolean	slotCacheLikelyMatch(int value, byte[] digestedRoutingKey)
boolean	start(Ticker ticker, boolean longStart) If start can be completed quickly, or longStart is true, then do it.
java.lang.String	toString()
long	writes()

Methods inherited from class java.lang.Object

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

Field Detail

NO_CLEANER_SLEEP

public static boolean NO_CLEANER_SLEEP

Method Detail

setAltStore

public void setAltStore(SaltedHashFreenetStore<T> store)

construct

public static <T extends StorableBlock> SaltedHashFreenetStore<T> construct(java.io.File baseDir,
                                                                            java.lang.String name,
                                                                            StoreCallback<T> callback,
                                                                            java.util.Random random,
                                                                            long maxKeys,
                                                                            boolean useSlotFilter,
                                                                            SemiOrderedShutdownHook shutdownHook,
                                                                            boolean preallocate,
                                                                            boolean resizeOnStart,
                                                                            Ticker exec,
                                                                            byte[] masterKey)
                                                                     throws java.io.IOException

Throws:

java.io.IOException

start

public boolean start(Ticker ticker,
                     boolean longStart)
              throws java.io.IOException

If start can be completed quickly, or longStart is true, then do it. If longStart is false and start cannot be completed quickly, return true. Don't start twice.

Specified by:

start in interface FreenetStore<T extends StorableBlock>

Throws:

java.io.IOException

fetch

public T fetch(byte[] routingKey,
               byte[] fullKey,
               boolean dontPromote,
               boolean canReadClientCache,
               boolean canReadSlashdotCache,
               boolean ignoreOldBlocks,
               BlockMetadata meta)
        throws java.io.IOException

Description copied from interface: FreenetStore

Retrieve a block. Use the StoreCallback to convert it to the appropriate type of block.

Specified by:

fetch in interface FreenetStore<T extends StorableBlock>

Parameters:

routingKey - The routing key i.e. the database key under which the block is stored.

dontPromote - If true, don't promote the block to the top of the LRU.

canReadClientCache - Whether we can read the client-cache, for purposes of finding the pubkey for an SSK.

Returns:

A StorableBlock, or null if the key cannot be found.

Throws:

java.io.IOException - If a disk I/O error occurs.

put

public void put(T block,
                byte[] data,
                byte[] header,
                boolean overwrite,
                boolean isOldBlock)
         throws java.io.IOException,
                KeyCollisionException

Description copied from interface: FreenetStore

Store a block.

Specified by:

put in interface FreenetStore<T extends StorableBlock>

overwrite - If true, overwrite old content rather than throwing a KeyCollisionException.

isOldBlock - If true, the block really shouldn't be in the datastore, but we are storing it anyway; it should not have the new block flag, so it should be excluded from Bloom filter sharing.

Throws:

KeyCollisionException - If the key already exists and callback.collisionPossible() is true.

java.io.IOException

put

public boolean put(T block,
                   byte[] data,
                   byte[] header,
                   boolean overwrite,
                   boolean isOldBlock,
                   boolean wrongStore)
            throws java.io.IOException,
                   KeyCollisionException

Throws:

java.io.IOException

KeyCollisionException

slotCacheLikelyMatch

public boolean slotCacheLikelyMatch(int value,
                                    byte[] digestedRoutingKey)

setPreallocate

public void setPreallocate(boolean preallocate)

Set preallocate storage space

Parameters:

preallocate -

setUserAlertManager

public void setUserAlertManager(UserAlertManager userAlertManager)

Specified by:

setUserAlertManager in interface FreenetStore<T extends StorableBlock>

setMaxKeys

public void setMaxKeys(long newStoreSize,
                       boolean shrinkNow)
                throws java.io.IOException

Description copied from interface: FreenetStore

Change the store size.

Specified by:

setMaxKeys in interface FreenetStore<T extends StorableBlock>

Parameters:

newStoreSize - The maximum number of keys to be cached.

shrinkNow - If false, don't shrink the store immediately.

Throws:

java.io.IOException

close

public void close()

Specified by:

close in interface FreenetStore<T extends StorableBlock>

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

close

public void close(boolean abort)

hits

public long hits()

Specified by:

hits in interface FreenetStore<T extends StorableBlock>

misses

public long misses()

Specified by:

misses in interface FreenetStore<T extends StorableBlock>

writes

public long writes()

Specified by:

writes in interface FreenetStore<T extends StorableBlock>

keyCount

public long keyCount()

Specified by:

keyCount in interface FreenetStore<T extends StorableBlock>

getMaxKeys

public long getMaxKeys()

Specified by:

getMaxKeys in interface FreenetStore<T extends StorableBlock>

getBloomFalsePositive

public long getBloomFalsePositive()

Specified by:

getBloomFalsePositive in interface FreenetStore<T extends StorableBlock>

probablyInStore

public boolean probablyInStore(byte[] routingKey)

Description copied from interface: FreenetStore

Check if a routing key probably

Specified by:

probablyInStore in interface FreenetStore<T extends StorableBlock>

Returns:

false only if the key does not exist in store.

destruct

public void destruct()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getSessionAccessStats

public StoreAccessStats getSessionAccessStats()

Specified by:

getSessionAccessStats in interface FreenetStore<T extends StorableBlock>

getTotalAccessStats

public StoreAccessStats getTotalAccessStats()

Specified by:

getTotalAccessStats in interface FreenetStore<T extends StorableBlock>

forceValidEmpty

public void forceValidEmpty()

Testing only! Force all entries that say empty/unknown on the slot filter to empty/certain.

getUnderlyingStore

public FreenetStore<T> getUnderlyingStore()

Specified by:

getUnderlyingStore in interface FreenetStore<T extends StorableBlock>