freenet.store

Interface FreenetStore<T extends StorableBlock>

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

CachingFreenetStore, NullFreenetStore, ProxyFreenetStore, RAMFreenetStore, SaltedHashFreenetStore, SlashdotStore

public interface FreenetStore<T extends StorableBlock>
extends java.io.Closeable

Datastore interface

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FreenetStore.StoreType

Method Summary

Modifier and Type	Method and Description
void	close()
T	fetch(byte[] routingKey, byte[] fullKey, boolean dontPromote, boolean canReadClientCache, boolean canReadSlashdotCache, boolean ignoreOldBlocks, BlockMetadata meta) Retrieve a block.
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 oldBlock) Store a block.
void	setMaxKeys(long maxStoreKeys, boolean shrinkNow) Change the store size.
void	setUserAlertManager(UserAlertManager userAlertManager)
boolean	start(Ticker ticker, boolean longStart)
long	writes()

Method Detail

fetch

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

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

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.

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

canWriteDatastore - Whether we can write the datastore, 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

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

Store a block.

Parameters:

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

oldBlock - 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

setMaxKeys

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

Change the store size.

Parameters:

maxStoreKeys - The maximum number of keys to be cached.

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

Throws:

java.io.IOException

DatabaseException

getMaxKeys

long getMaxKeys()

hits

long hits()

misses

long misses()

writes

long writes()

keyCount

long keyCount()

getBloomFalsePositive

long getBloomFalsePositive()

probablyInStore

boolean probablyInStore(byte[] routingKey)

Check if a routing key probably

Parameters:

routingkey -

Returns:

false only if the key does not exist in store.

getSessionAccessStats

StoreAccessStats getSessionAccessStats()

getTotalAccessStats

StoreAccessStats getTotalAccessStats()

start

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

Throws:

java.io.IOException

close

void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

setUserAlertManager

void setUserAlertManager(UserAlertManager userAlertManager)

getUnderlyingStore

FreenetStore<T> getUnderlyingStore()