freenet.store

Class StoreCallback<T extends StorableBlock>

java.lang.Object

freenet.store.StoreCallback<T>

Direct Known Subclasses:

CHKStore, PubkeyStore, SSKStore

public abstract class StoreCallback<T extends StorableBlock>
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected FreenetStore<T>	store

Constructor Summary

Constructors

Constructor and Description
StoreCallback()

Method Summary

Modifier and Type	Method and Description
abstract boolean	collisionPossible() Can the same key be valid for two different StorableBlocks?
abstract T	construct(byte[] data, byte[] headers, byte[] routingKey, byte[] fullKey, boolean canReadClientCache, boolean canReadSlashdotCache, BlockMetadata meta, DSAPublicKey knownPubKey) Construct a StorableBlock from the data, headers, and optionally routing key or full key.
abstract boolean	constructNeedsKey() Whether we need the key in order to reconstruct a block.
abstract int	dataLength() Length of a data block.
abstract int	fullKeyLength() Length of a full key.
long	getBloomFalsePositive()
long	getMaxKeys()
StoreAccessStats	getSessionAccessStats()
FreenetStore<T>	getStore()
StoreAccessStats	getTotalAccessStats() Overall session access stats.
int	getTotalBlockSize()
abstract int	headerLength() Length of a header block.
long	hits()
long	keyCount()
long	misses()
abstract byte[]	routingKeyFromFullKey(byte[] keyBuf) Generate a routing key from a full key
abstract int	routingKeyLength() Length of a routing key.
void	setMaxKeys(long maxStoreKeys, boolean shrinkNow)
void	setStore(FreenetStore<T> store) Called when first connecting to a FreenetStore.
abstract boolean	storeFullKeys() Whether we should create a .keys file to keep full keys in in order to reconstruct.
long	writes()

Methods inherited from class java.lang.Object

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

Field Detail

store

protected FreenetStore<T extends StorableBlock> store

Constructor Detail

StoreCallback

public StoreCallback()

Method Detail

dataLength

public abstract int dataLength()

Length of a data block. Fixed for lifetime of the store.

headerLength

public abstract int headerLength()

Length of a header block. Fixed for the lifetime of the store.

routingKeyLength

public abstract int routingKeyLength()

Length of a routing key. Routing key is what we use to search for a block. Also fixed.

storeFullKeys

public abstract boolean storeFullKeys()

Whether we should create a .keys file to keep full keys in in order to reconstruct.

constructNeedsKey

public abstract boolean constructNeedsKey()

Whether we need the key in order to reconstruct a block.

fullKeyLength

public abstract int fullKeyLength()

Length of a full key. Full keys are stored in the .keys file. Also fixed.

collisionPossible

public abstract boolean collisionPossible()

Can the same key be valid for two different StorableBlocks?

setStore

public void setStore(FreenetStore<T> store)

Called when first connecting to a FreenetStore. If the FreenetStore is a wrapper, it can be called more than once, but the last call will determine which store we use.

getStore

public FreenetStore<T> getStore()

construct

public abstract T construct(byte[] data,
                            byte[] headers,
                            byte[] routingKey,
                            byte[] fullKey,
                            boolean canReadClientCache,
                            boolean canReadSlashdotCache,
                            BlockMetadata meta,
                            DSAPublicKey knownPubKey)
                     throws KeyVerifyException

Construct a StorableBlock from the data, headers, and optionally routing key or full key. IMPORTANT: Using the full key or routing key is OPTIONAL, and if we don't use them, WE DON'T CHECK THEM EITHER! Caller MUST check that the key is the one expected.

Throws:

KeyVerifyException

setMaxKeys

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

Throws:

java.io.IOException

getMaxKeys

public long getMaxKeys()

hits

public long hits()

misses

public long misses()

writes

public long writes()

keyCount

public long keyCount()

getBloomFalsePositive

public long getBloomFalsePositive()

routingKeyFromFullKey

public abstract byte[] routingKeyFromFullKey(byte[] keyBuf)

Generate a routing key from a full key

getSessionAccessStats

public StoreAccessStats getSessionAccessStats()

getTotalAccessStats

public StoreAccessStats getTotalAccessStats()

Overall session access stats. We don't store the uptime in the datastore, so the caller will have to pass in its own estimate of total uptime.

Returns:

Null if not supported.

getTotalBlockSize

public int getTotalBlockSize()

Returns:

The total size in memory of a block with its key and routing key and data and headers.