freenet.keys

Class ClientCHK

java.lang.Object

freenet.keys.BaseClientKey

freenet.keys.ClientKey

freenet.keys.ClientCHK

All Implemented Interfaces:

java.io.Serializable

public class ClientCHK
extends ClientKey
implements java.io.Serializable

Client level CHK. Can be converted into a FreenetURI, can be used to decrypt a CHKBlock, can be produced by a CHKBlock.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static short	CRYPTO_KEY_LENGTH The length of the decryption key
static short	EXTRA_LENGTH The length of the "extra" bytes in the key
static ClientCHK	TEST_KEY Useful for e.g.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClientCHK()
	ClientCHK(byte[] routingKey, byte[] encKey, boolean isControlDocument, byte algo, short compressionAlgorithm)
	ClientCHK(byte[] routingKey, byte[] encKey, byte[] extra)
	ClientCHK(java.io.DataInputStream dis) Create from a raw binary CHK.
	ClientCHK(FreenetURI uri) Create from a URI.

Method Summary

Modifier and Type	Method and Description
ClientCHK	cloneKey()
boolean	equals(java.lang.Object o)
byte	getCryptoAlgorithm()
static byte	getCryptoAlgorithmFromExtra(byte[] extra)
byte[]	getCryptoKey()
byte[]	getExtra()
static byte[]	getExtra(byte cryptoAlgorithm, short compressionAlgorithm, boolean controlDocument)
NodeCHK	getNodeCHK()
Key	getNodeKey(boolean cloneKey)
byte[]	getRoutingKey()
FreenetURI	getURI()
int	hashCode()
static byte[]	internExtra(byte[] extra)
boolean	isCompressed()
boolean	isMetadata()
static ClientCHK	readRawBinaryKey(java.io.DataInputStream dis) Read a raw binary CHK.
java.lang.String	toString()
void	writeRawBinaryKey(java.io.DataOutputStream dos) Write an ultra-compact representation.

Methods inherited from class freenet.keys.ClientKey

getNodeKey

Methods inherited from class freenet.keys.BaseClientKey

getBaseKey

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EXTRA_LENGTH

public static final short EXTRA_LENGTH

The length of the "extra" bytes in the key

See Also:

Constant Field Values

CRYPTO_KEY_LENGTH

public static final short CRYPTO_KEY_LENGTH

The length of the decryption key

See Also:

Constant Field Values

TEST_KEY

public static final ClientCHK TEST_KEY

Useful for e.g. length checks

Constructor Detail

ClientCHK

public ClientCHK(byte[] routingKey,
                 byte[] encKey,
                 boolean isControlDocument,
                 byte algo,
                 short compressionAlgorithm)

Parameters:

routingKey - The routing key. This is the overall hash of the header and content of the key.

encKey - The decryption key. This is not passed to other nodes and is extracted from the URI.

isCompressed - True if the data was gzipped before encoding.

isControlDocument - True if the document is a Control Document. These carry metadata, whereas ordinary keys carry data, and have no type.

algo - The encryption algorithm's identifier. See ALGO_* for values.

ClientCHK

public ClientCHK(byte[] routingKey,
                 byte[] encKey,
                 byte[] extra)
          throws java.net.MalformedURLException

Throws:

java.net.MalformedURLException

ClientCHK

public ClientCHK(FreenetURI uri)
          throws java.net.MalformedURLException

Create from a URI.

Throws:

java.net.MalformedURLException

ClientCHK

public ClientCHK(java.io.DataInputStream dis)
          throws java.io.IOException

Create from a raw binary CHK. This expresses the key information in as few bytes as possible.

Throws:

java.io.IOException

ClientCHK

protected ClientCHK()

Method Detail

writeRawBinaryKey

public void writeRawBinaryKey(java.io.DataOutputStream dos)
                       throws java.io.IOException

Write an ultra-compact representation.

Throws:

java.io.IOException - If a write failed.

getExtra

public byte[] getExtra()

getExtra

public static byte[] getExtra(byte cryptoAlgorithm,
                              short compressionAlgorithm,
                              boolean controlDocument)

getCryptoAlgorithmFromExtra

public static byte getCryptoAlgorithmFromExtra(byte[] extra)

internExtra

public static byte[] internExtra(byte[] extra)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getNodeKey

public Key getNodeKey(boolean cloneKey)

Specified by:

getNodeKey in class ClientKey

Returns:

a NodeCHK corresponding to this key. Basically keep the routingKey and lose everything else.

getNodeCHK

public NodeCHK getNodeCHK()

getURI

public FreenetURI getURI()

Specified by:

getURI in class BaseClientKey

Returns:

URI form of this key.

readRawBinaryKey

public static ClientCHK readRawBinaryKey(java.io.DataInputStream dis)
                                  throws java.io.IOException

Read a raw binary CHK. This is an ultra-compact representation, for splitfile metadata etc.

Throws:

java.io.IOException

isMetadata

public boolean isMetadata()

isCompressed

public boolean isCompressed()

cloneKey

public ClientCHK cloneKey()

Specified by:

cloneKey in class ClientKey

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

getRoutingKey

public byte[] getRoutingKey()

getCryptoKey

public byte[] getCryptoKey()

getCryptoAlgorithm

public byte getCryptoAlgorithm()