net.tomp2p.storage

Class Data

java.lang.Object

net.tomp2p.storage.Data

public class Data
extends Object

This class holds the data for the transport. The data is already serialized and a hash may be created. It is reasonable to create the hash on the remote peer, but not on the local peer. The remote peer uses the hash to tell the other peers, which version is stored and its used quite often.

Author:

Thomas Bocek

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Data.Type small means 8 bit, medium is 32bit.

Constructor Summary

Constructors

Constructor and Description
Data()
Data(byte[] buffer)
Data(byte[] buffer, int offest, int length) Creates a data object from an already existing byte buffer.
Data(DataBuffer buffer)
Data(DataBuffer buffer, int length) Create a data object that does have the complete data, but not the complete header
Data(int header, int length) Creates an empty data object.
Data(Object object)

Method Summary

Methods

Modifier and Type	Method and Description
Data	addBasedOn(Number160 basedOn)
Collection<Number160>	basedOnSet()
io.netty.buffer.ByteBuf	buffer() If you use this, make sure you are aware of Nettys reference counting.
boolean	decodeBuffer(io.netty.buffer.ByteBuf buf) Add data to the byte buffer.
boolean	decodeDone(io.netty.buffer.ByteBuf buf, PublicKey publicKey, SignatureFactory signatureFactory)
boolean	decodeDone(io.netty.buffer.ByteBuf buf, SignatureFactory signatureFactory)
static Data	decodeHeader(io.netty.buffer.ByteBuf buf, SignatureFactory signatureFactory) Reads the header.
Data	deleted()
Data	deleted(boolean deleted)
Data	duplicate()
Data	duplicateMeta()
boolean	encodeBuffer(AlternativeCompositeByteBuf buf)
void	encodeDone(io.netty.buffer.ByteBuf buf, SignatureFactory signatureFactory)
void	encodeDone(io.netty.buffer.ByteBuf buf, SignatureFactory signatureFactory, PrivateKey messagePrivateKey)
void	encodeHeader(io.netty.buffer.ByteBuf buf, SignatureFactory signatureFactory) * Header format:
boolean	equals(Object obj)
long	expirationMillis()
Data	flag1()
Data	flag1(boolean flag1)
Data	flag2()
Data	flag2(boolean flag2)
Number160	hash()
int	hashCode()
boolean	hasPrepareFlag()
boolean	hasPublicKey()
boolean	isDeleted()
boolean	isEmpty()
boolean	isFlag1()
boolean	isFlag2()
boolean	isMeta()
boolean	isProtectedEntry()
boolean	isSigned()
int	length()
Data	meta()
Data	meta(boolean meta)
Object	object()
Data	prepareFlag()
Data	prepareFlag(boolean prepareFlag)
PrivateKey	privateKey()
Data	protectEntry()
Data	protectEntry(KeyPair keyPair)
Data	protectEntry(PrivateKey privateKey)
Data	protectEntryNow(KeyPair keyPair, SignatureFactory signatureFactory)
Data	protectEntryNow(PrivateKey privateKey, SignatureFactory signatureFactory)
PublicKey	publicKey()
Data	publicKey(PublicKey publicKey)
Data	publicKeyFlag()
Data	publicKeyFlag(boolean publicKeyFlag)
void	resetAlreadyTransferred()
Data	sign()
Data	sign(KeyPair keyPair)
Data	sign(PrivateKey privateKey)
SignatureCodec	signature()
Data	signature(SignatureCodec signature)
SignatureFactory	signatureFactory()
Data	signatureFactory(SignatureFactory signatureFactory)
Data	signed()
Data	signed(boolean signed)
Data	signNow(KeyPair keyPair, SignatureFactory signatureFactory)
Data	signNow(PrivateKey privateKey, SignatureFactory signatureFactory)
ByteBuffer[]	toByteBuffers()
byte[]	toBytes()
String	toString()
int	ttlSeconds()
Data	ttlSeconds(int ttlSeconds)
static Data.Type	type(int header)
long	validFromMillis()
Data	validFromMillis(long validFromMillis)
boolean	verify(PublicKey publicKey, SignatureFactory signatureFactory)
boolean	verify(SignatureFactory signatureFactory)

Methods inherited from class java.lang.Object

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

Constructor Detail

Data

public Data(DataBuffer buffer)

Data

public Data(DataBuffer buffer,
    int length)

Create a data object that does have the complete data, but not the complete header

Parameters:

length - The expected length of the buffer. This does not include the header + size (2, 5, or 9).

version - The version of a data object, optional

ttlSeconds - The TTL of a data object, optional

hasHash - Indication if a hash should also be transmitted

isProtectedEntry - True if this entry is protected

Data

public Data(int header,
    int length)

Creates an empty data object. The data can be filled at a later stage using #append(ByteBuf).

Parameters:

header - The 8 bit header

length - The length, which depends on the header values

Data

public Data(Object object)
     throws IOException

Throws:

IOException

Data

public Data(byte[] buffer)

Data

public Data()

Data

public Data(byte[] buffer,
    int offest,
    int length)

Creates a data object from an already existing byte buffer.

Parameters:

buffer - The data buffer

version - The version of a data object, optional

ttlSeconds - The ttl of a data object, optional

hasHash - Indication if a hash should also be transmitted

isProtectedEntry - True if this entry is protected

Method Detail

isEmpty

public boolean isEmpty()

decodeHeader

public static Data decodeHeader(io.netty.buffer.ByteBuf buf,
                SignatureFactory signatureFactory)

Reads the header. Does not modify the buffer positions if header could not be fully read. Header format:

 1 byte - header
 1 or 4 bytes - length
 4 or 0 bytes - ttl (hasTTL)
 1 or 0 bytes - number of basedon keys (hasBasedOn)
 n x 20 bytes - basedon keys (hasBasedOn, number of basedon keys)
 2 or 0 bytes - length of public key (hasPublicKey)
 n bytes - public key (hasPublicKey, length of public key)
 

Parameters:

buf - The buffer to read from

Returns:

The data object, may be partially filled

decodeBuffer

public boolean decodeBuffer(io.netty.buffer.ByteBuf buf)

Add data to the byte buffer.

Parameters:

buf - The byte buffer to append

Returns:

True if we are done reading

decodeDone

public boolean decodeDone(io.netty.buffer.ByteBuf buf,
                 SignatureFactory signatureFactory)

decodeDone

public boolean decodeDone(io.netty.buffer.ByteBuf buf,
                 PublicKey publicKey,
                 SignatureFactory signatureFactory)

verify

public boolean verify(SignatureFactory signatureFactory)
               throws InvalidKeyException,
                      SignatureException

Throws:

InvalidKeyException

SignatureException

verify

public boolean verify(PublicKey publicKey,
             SignatureFactory signatureFactory)
               throws InvalidKeyException,
                      SignatureException

Throws:

InvalidKeyException

SignatureException

encodeHeader

public void encodeHeader(io.netty.buffer.ByteBuf buf,
                SignatureFactory signatureFactory)

* Header format:

 1 byte - header
 1 or 4 bytes - length
 4 or 0 bytes - ttl (hasTTL)
 1 or 0 bytes - number of basedon keys (hasBasedOn)
 n x 20 bytes - basedon keys (hasBasedOn, number of basedon keys)
 2 or 0 bytes - length of public key (hasPublicKey)
 n bytes - public key (hasPublicKey, length of public key)
 

Parameters:

buf -

signatureFactory -

encodeBuffer

public boolean encodeBuffer(AlternativeCompositeByteBuf buf)

encodeDone

public void encodeDone(io.netty.buffer.ByteBuf buf,
              SignatureFactory signatureFactory)
                throws InvalidKeyException,
                       SignatureException,
                       IOException

Throws:

InvalidKeyException

SignatureException

IOException

encodeDone

public void encodeDone(io.netty.buffer.ByteBuf buf,
              SignatureFactory signatureFactory,
              PrivateKey messagePrivateKey)
                throws InvalidKeyException,
                       SignatureException,
                       IOException

Throws:

InvalidKeyException

SignatureException

IOException

buffer

public io.netty.buffer.ByteBuf buffer()

If you use this, make sure you are aware of Nettys reference counting. http://netty.io/wiki/reference-counted-objects.html Once this object is destroyed, the ByteBuf cannot be accessed anymore (unless you use retain/release).

Returns:

object

public Object object()
              throws ClassNotFoundException,
                     IOException

Throws:

ClassNotFoundException

IOException

validFromMillis

public long validFromMillis()

validFromMillis

public Data validFromMillis(long validFromMillis)

signNow

public Data signNow(KeyPair keyPair,
           SignatureFactory signatureFactory)
             throws InvalidKeyException,
                    SignatureException,
                    IOException

Throws:

InvalidKeyException

SignatureException

IOException

protectEntryNow

public Data protectEntryNow(KeyPair keyPair,
                   SignatureFactory signatureFactory)
                     throws InvalidKeyException,
                            SignatureException,
                            IOException

Throws:

InvalidKeyException

SignatureException

IOException

signNow

public Data signNow(PrivateKey privateKey,
           SignatureFactory signatureFactory)
             throws InvalidKeyException,
                    SignatureException,
                    IOException

Throws:

InvalidKeyException

SignatureException

IOException

protectEntryNow

public Data protectEntryNow(PrivateKey privateKey,
                   SignatureFactory signatureFactory)
                     throws InvalidKeyException,
                            SignatureException,
                            IOException

Throws:

InvalidKeyException

SignatureException

IOException

sign

public Data sign(KeyPair keyPair)

protectEntry

public Data protectEntry(KeyPair keyPair)

sign

public Data sign()

sign

public Data sign(PrivateKey privateKey)

protectEntry

public Data protectEntry()

protectEntry

public Data protectEntry(PrivateKey privateKey)

length

public int length()

expirationMillis

public long expirationMillis()

ttlSeconds

public int ttlSeconds()

ttlSeconds

public Data ttlSeconds(int ttlSeconds)

addBasedOn

public Data addBasedOn(Number160 basedOn)

basedOnSet

public Collection<Number160> basedOnSet()

signatureFactory

public SignatureFactory signatureFactory()

signatureFactory

public Data signatureFactory(SignatureFactory signatureFactory)

isProtectedEntry

public boolean isProtectedEntry()

isSigned

public boolean isSigned()

signed

public Data signed(boolean signed)

signed

public Data signed()

isFlag1

public boolean isFlag1()

flag1

public Data flag1(boolean flag1)

flag1

public Data flag1()

isFlag2

public boolean isFlag2()

flag2

public Data flag2(boolean flag2)

flag2

public Data flag2()

hasPrepareFlag

public boolean hasPrepareFlag()

prepareFlag

public Data prepareFlag(boolean prepareFlag)

prepareFlag

public Data prepareFlag()

deleted

public Data deleted()

deleted

public Data deleted(boolean deleted)

isDeleted

public boolean isDeleted()

hasPublicKey

public boolean hasPublicKey()

publicKeyFlag

public Data publicKeyFlag(boolean publicKeyFlag)

publicKeyFlag

public Data publicKeyFlag()

isMeta

public boolean isMeta()

meta

public Data meta(boolean meta)

meta

public Data meta()

toString

public String toString()

Overrides:

toString in class Object

resetAlreadyTransferred

public void resetAlreadyTransferred()

duplicate

public Data duplicate()

Returns:

A shallow copy where the data is shared but the reader and writer index is not shared

duplicateMeta

public Data duplicateMeta()

type

public static Data.Type type(int header)

toBytes

public byte[] toBytes()

Returns:

The byte array that is the payload. Here we copy the buffer

toByteBuffers

public ByteBuffer[] toByteBuffers()

Returns:

The ByteBuffers that is the payload. We do not make a copy here

publicKey

public PublicKey publicKey()

privateKey

public PrivateKey privateKey()

Returns:

A private key if we want to sign it lazy (during encoding).

publicKey

public Data publicKey(PublicKey publicKey)

signature

public SignatureCodec signature()

signature

public Data signature(SignatureCodec signature)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hash

public Number160 hash()