freenet.client

Class InsertContext

java.lang.Object

freenet.client.InsertContext

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class InsertContext
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

Context object for an insert operation, including both simple and multi-file inserts. WARNING: Changing non-transient members on classes that are Serializable can result in losing uploads.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InsertContext.CompatibilityMode Compatibility mode.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	canWriteClientCache Can this insert write to the client-cache? We don't store all requests in the client cache, in particular big stuff usually isn't written to it, to maximise its effectiveness.
java.lang.String	compressorDescriptor a string that contains the codecs to use/try if the string is null it defaults to COMPRESSOR_TYPES.Values(), so old persistent inserts are not affected after update.
int	consecutiveRNFsCountAsSuccess On a very small network, any insert will RNF.
boolean	dontCompress If true, don't try to compress the data
boolean	earlyEncode If true, try to find the final URI as quickly as possible, and insert the upper layers as soon as we can, rather than waiting for the lower layers.
ClientEventProducer	eventProducer Client events will be published to this, you can subscribe to them
int	extraInsertsSingleBlock Number of extra inserts for a single block inserted on its own.
int	extraInsertsSplitfileHeaderBlock Number of extra inserts for a block inserted above a splitfile.
boolean	forkOnCacheable
boolean	getCHKOnly If true, don't insert, just generate the CHK
boolean	ignoreUSKDatehints Don't insert USK DATEHINTs (and ignore them on polling for maximum edition).
boolean	localRequestOnly
int	maxInsertRetries Maximum number of retries (after the initial attempt) for each block inserted.
int	splitfileSegmentCheckBlocks Maximum number of check blocks per segment for splitfiles.
int	splitfileSegmentDataBlocks Maximum number of data blocks per segment for splitfiles

Constructor Summary

Constructors

Constructor and Description
InsertContext(InsertContext ctx, SimpleEventProducer producer)
InsertContext(int maxRetries, int rnfsToSuccess, int splitfileSegmentDataBlocks, int splitfileSegmentCheckBlocks, ClientEventProducer eventProducer, boolean canWriteClientCache, boolean forkOnCacheable, boolean localRequestOnly, java.lang.String compressorDescriptor, int extraInsertsSingleBlock, int extraInsertsSplitfileHeaderBlock, InsertContext.CompatibilityMode compatibilityMode)

Method Summary

Modifier and Type	Method and Description
InsertContext	clone() Make public, but just call parent for a field for field copy
boolean	equals(java.lang.Object obj) Are two InsertContext's equal? Ignores the EventProducer, compares only the actual config values.
long	getCompatibilityCode()
InsertContext.CompatibilityMode	getCompatibilityMode()
Metadata.SplitfileAlgorithm	getSplitfileAlgorithm()
int	hashCode()
void	onResume() Deprecated.
void	setCompatibilityMode(InsertContext.CompatibilityMode mode)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

dontCompress

public boolean dontCompress

If true, don't try to compress the data

maxInsertRetries

public int maxInsertRetries

Maximum number of retries (after the initial attempt) for each block inserted. -1 = retry forever or until it succeeds (subject to consecutiveRNFsCountAsSuccess) or until a fatal error.

consecutiveRNFsCountAsSuccess

public int consecutiveRNFsCountAsSuccess

On a very small network, any insert will RNF. Therefore we allow some number of RNFs to equal success.

splitfileSegmentDataBlocks

public int splitfileSegmentDataBlocks

Maximum number of data blocks per segment for splitfiles

splitfileSegmentCheckBlocks

public int splitfileSegmentCheckBlocks

Maximum number of check blocks per segment for splitfiles. Will be reduced proportionally if there are fewer data blocks.

eventProducer

public final ClientEventProducer eventProducer

Client events will be published to this, you can subscribe to them

canWriteClientCache

public boolean canWriteClientCache

Can this insert write to the client-cache? We don't store all requests in the client cache, in particular big stuff usually isn't written to it, to maximise its effectiveness. Plus, local inserts are not written to the client-cache by default for privacy reasons.

compressorDescriptor

public java.lang.String compressorDescriptor

a string that contains the codecs to use/try if the string is null it defaults to COMPRESSOR_TYPES.Values(), so old persistent inserts are not affected after update.

See Also:

Compressor.COMPRESSOR_TYPE.getCompressorsArray(String)

forkOnCacheable

public boolean forkOnCacheable

extraInsertsSingleBlock

public int extraInsertsSingleBlock

Number of extra inserts for a single block inserted on its own.

extraInsertsSplitfileHeaderBlock

public int extraInsertsSplitfileHeaderBlock

Number of extra inserts for a block inserted above a splitfile.

localRequestOnly

public boolean localRequestOnly

ignoreUSKDatehints

public boolean ignoreUSKDatehints

Don't insert USK DATEHINTs (and ignore them on polling for maximum edition).

getCHKOnly

public boolean getCHKOnly

If true, don't insert, just generate the CHK

earlyEncode

public boolean earlyEncode

If true, try to find the final URI as quickly as possible, and insert the upper layers as soon as we can, rather than waiting for the lower layers. The default behaviour is safer, because an attacker can usually only identify the datastream once he has the top block, or once you have announced the key.

Constructor Detail

InsertContext

public InsertContext(int maxRetries,
                     int rnfsToSuccess,
                     int splitfileSegmentDataBlocks,
                     int splitfileSegmentCheckBlocks,
                     ClientEventProducer eventProducer,
                     boolean canWriteClientCache,
                     boolean forkOnCacheable,
                     boolean localRequestOnly,
                     java.lang.String compressorDescriptor,
                     int extraInsertsSingleBlock,
                     int extraInsertsSplitfileHeaderBlock,
                     InsertContext.CompatibilityMode compatibilityMode)

InsertContext

public InsertContext(InsertContext ctx,
                     SimpleEventProducer producer)

Method Detail

getCompatibilityMode

public InsertContext.CompatibilityMode getCompatibilityMode()

getCompatibilityCode

public long getCompatibilityCode()

setCompatibilityMode

public void setCompatibilityMode(InsertContext.CompatibilityMode mode)

clone

public InsertContext clone()

Make public, but just call parent for a field for field copy

Overrides:

clone in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Are two InsertContext's equal? Ignores the EventProducer, compares only the actual config values.

Overrides:

equals in class java.lang.Object

getSplitfileAlgorithm

public Metadata.SplitfileAlgorithm getSplitfileAlgorithm()

onResume

@Deprecated
public void onResume()

Deprecated.

Call when migrating from db4o era. FIXME remove.