freenet.client

Enum InsertContext.CompatibilityMode

java.lang.Object

java.lang.Enum<InsertContext.CompatibilityMode>

freenet.client.InsertContext.CompatibilityMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<InsertContext.CompatibilityMode>

Enclosing class:

InsertContext

public static enum InsertContext.CompatibilityMode
extends java.lang.Enum<InsertContext.CompatibilityMode>

Compatibility mode. This determines exactly how we insert data, so that we can produce the same CHK when reinserting a key even if it is with a later version of Freenet. It is also important for e.g. auto-update to be able to insert keys compatible with older nodes, but CompatibilityMode's are sometimes backwards compatible, there are separate versioning systems for keys and Metadata, which will be set as appropriate for an insert depending on the CompatibilityMode.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPAT_1250 1250 or previous: Segments up to 128 data 128 check, check <= data.
COMPAT_1250_EXACT Exactly as before 1250: Segments of exactly 128 data, 128 check, check = data
COMPAT_1251 1251/2/3: Basic even splitting, 1 extra check block if data blocks < 128, max 131 data blocks.
COMPAT_1255 1255: Second stage of even splitting, a whole bunch of segments lose one block rather than the last segment losing lots of blocks.
COMPAT_1416 1416: New CHK encryption
COMPAT_1468 1468: Fill in topDontCompress and topCompatibilityMode on splitfiles.
COMPAT_CURRENT No compatibility issues, use the most efficient metadata possible.
COMPAT_UNKNOWN We do not know.

Field Summary

Fields

Modifier and Type	Field and Description
short	code Code used in metadata for this CompatibilityMode.
static InsertContext.CompatibilityMode	COMPAT_DEFAULT The default compatibility mode for new inserts when it is not specified.

Method Summary

Modifier and Type	Method and Description
static InsertContext.CompatibilityMode	byCode(short code)
static boolean	hasCode(short min)
InsertContext.CompatibilityMode	intern() Must be called whenever we accept a CompatibilityMode as e.g.
static InsertContext.CompatibilityMode	latest()
static boolean	maybeFutureCode(short code)
static InsertContext.CompatibilityMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static InsertContext.CompatibilityMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

COMPAT_UNKNOWN

public static final InsertContext.CompatibilityMode COMPAT_UNKNOWN

We do not know.

COMPAT_CURRENT

public static final InsertContext.CompatibilityMode COMPAT_CURRENT

No compatibility issues, use the most efficient metadata possible. Used only in the front-end: MUST NOT be stored: Code should convert this to a specific mode as early as possible, or inserts will break when a new mode is added. InsertContext does this.

COMPAT_1250_EXACT

public static final InsertContext.CompatibilityMode COMPAT_1250_EXACT

Exactly as before 1250: Segments of exactly 128 data, 128 check, check = data

COMPAT_1250

public static final InsertContext.CompatibilityMode COMPAT_1250

1250 or previous: Segments up to 128 data 128 check, check <= data.

COMPAT_1251

public static final InsertContext.CompatibilityMode COMPAT_1251

1251/2/3: Basic even splitting, 1 extra check block if data blocks < 128, max 131 data blocks.

COMPAT_1255

public static final InsertContext.CompatibilityMode COMPAT_1255

1255: Second stage of even splitting, a whole bunch of segments lose one block rather than the last segment losing lots of blocks. And hashes too!

COMPAT_1416

public static final InsertContext.CompatibilityMode COMPAT_1416

1416: New CHK encryption

COMPAT_1468

public static final InsertContext.CompatibilityMode COMPAT_1468

1468: Fill in topDontCompress and topCompatibilityMode on splitfiles. Same blocks, but slightly different metadata.

Field Detail

code

public final short code

Code used in metadata for this CompatibilityMode. Hence we can remove old CompatibilityMode's, and it's also convenient.

COMPAT_DEFAULT

public static final InsertContext.CompatibilityMode COMPAT_DEFAULT

The default compatibility mode for new inserts when it is not specified. Usually this will be COMPAT_CURRENT (it will get converted into a specific mode later), but when a new compatibility mode is deployed we may want to keep this at an earlier version to avoid a period when data inserted with the new/testing builds can't be fetched with earlier versions.

Method Detail

values

public static InsertContext.CompatibilityMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (InsertContext.CompatibilityMode c : InsertContext.CompatibilityMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static InsertContext.CompatibilityMode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

latest

public static InsertContext.CompatibilityMode latest()

intern

public InsertContext.CompatibilityMode intern()

Must be called whenever we accept a CompatibilityMode as e.g. a config option. Converts the pseudo-

byCode

public static InsertContext.CompatibilityMode byCode(short code)

hasCode

public static boolean hasCode(short min)

maybeFutureCode

public static boolean maybeFutureCode(short code)