net.named_data.jndn.encoding

Class Tlv0_2WireFormat

java.lang.Object

net.named_data.jndn.encoding.WireFormat

net.named_data.jndn.encoding.Tlv0_2WireFormat

Direct Known Subclasses:

Tlv0_1_1WireFormat, TlvWireFormat

public class Tlv0_2WireFormat
extends WireFormat

A Tlv0_2WireFormat implements the WireFormat interface for encoding and decoding with the NDN-TLV wire format, version 0.2.

Constructor Summary

Constructors

Constructor and Description
Tlv0_2WireFormat()

Method Summary

Methods

Modifier and Type	Method and Description
void	decodeControlParameters(ControlParameters controlParameters, ByteBuffer input, boolean copy) Decode input as a control parameters in NDN-TLV and set the fields of the controlParameters object.
void	decodeControlResponse(ControlResponse controlResponse, ByteBuffer input, boolean copy) Decode input as a control parameters in NDN-TLV and set the fields of the controlResponse object.
void	decodeData(Data data, ByteBuffer input, int[] signedPortionBeginOffset, int[] signedPortionEndOffset, boolean copy) Decode input as a data packet in NDN-TLV and set the fields in the data object.
void	decodeDelegationSet(DelegationSet delegationSet, ByteBuffer input, boolean copy) Decode input as a sequence of NDN-TLV Delegation and set the fields of the delegationSet object.
void	decodeEncryptedContent(EncryptedContent encryptedContent, ByteBuffer input, boolean copy) Decode input as a EncryptedContent in NDN-TLV and set the fields of the encryptedContent object.
void	decodeInterest(Interest interest, ByteBuffer input, int[] signedPortionBeginOffset, int[] signedPortionEndOffset, boolean copy) Decode input as an interest in NDN-TLV and set the fields of the interest object.
void	decodeLpPacket(LpPacket lpPacket, ByteBuffer input, boolean copy) Decode input as an NDN-TLV LpPacket and set the fields of the lpPacket object.
void	decodeName(Name name, ByteBuffer input, boolean copy) Decode input as a name in NDN-TLV and set the fields of the Name object.
Signature	decodeSignatureInfoAndValue(ByteBuffer signatureInfo, ByteBuffer signatureValue, boolean copy) Decode signatureInfo as an NDN-TLV signature info and signatureValue as the related NDN-TLV SignatureValue, and return a new object which is a subclass of Signature.
Blob	encodeControlParameters(ControlParameters controlParameters) Encode controlParameters in NDN-TLV and return the encoding.
Blob	encodeControlResponse(ControlResponse controlResponse) Encode controlResponse in NDN-TLV and return the encoding.
Blob	encodeData(Data data, int[] signedPortionBeginOffset, int[] signedPortionEndOffset) Encode data in NDN-TLV and return the encoding.
Blob	encodeDelegationSet(DelegationSet delegationSet) Encode delegationSet as a sequence of NDN-TLV Delegation, and return the encoding.
Blob	encodeEncryptedContent(EncryptedContent encryptedContent) Encode the EncryptedContent in NDN-TLV and return the encoding.
Blob	encodeInterest(Interest interest, int[] signedPortionBeginOffset, int[] signedPortionEndOffset) Encode interest using NDN-TLV and return the encoding.
Blob	encodeName(Name name) Encode name in NDN-TLV and return the encoding.
Blob	encodeSignatureInfo(Signature signature) Encode signature as a SignatureInfo in NDN-TLV and return the encoding.
Blob	encodeSignatureValue(Signature signature) Encode the signatureValue in the Signature object as a SignatureValue (the signature bits) in NDN-TLV and return the encoding.
static Tlv0_2WireFormat	get() Get a singleton instance of a Tlv0_2WireFormat.

Methods inherited from class net.named_data.jndn.encoding.WireFormat

decodeControlParameters, decodeControlResponse, decodeData, decodeData, decodeData, decodeDelegationSet, decodeEncryptedContent, decodeInterest, decodeInterest, decodeInterest, decodeLpPacket, decodeName, decodeSignatureInfoAndValue, encodeData, encodeInterest, getDefaultWireFormat, setDefaultWireFormat

Methods inherited from class java.lang.Object

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

Constructor Detail

Tlv0_2WireFormat

public Tlv0_2WireFormat()

Method Detail

encodeName

public Blob encodeName(Name name)

Encode name in NDN-TLV and return the encoding.

Overrides:

encodeName in class WireFormat

Parameters:

name - The Name object to encode.

Returns:

A Blob containing the encoding.

decodeName

public void decodeName(Name name,
              ByteBuffer input,
              boolean copy)
                throws EncodingException

Decode input as a name in NDN-TLV and set the fields of the Name object.

Overrides:

decodeName in class WireFormat

Parameters:

name - The Name object whose fields are updated.

input - The input buffer to decode. This reads from position() to limit(), but does not change the position.

copy - If true, copy from the input when making new Blob values. If false, then Blob values share memory with the input, which must remain unchanged while the Blob values are used.

Throws:

EncodingException - For invalid encoding.

encodeInterest

public Blob encodeInterest(Interest interest,
                  int[] signedPortionBeginOffset,
                  int[] signedPortionEndOffset)

Encode interest using NDN-TLV and return the encoding.

Overrides:

encodeInterest in class WireFormat

Parameters:

interest - The Interest object to encode.

signedPortionBeginOffset - Return the offset in the encoding of the beginning of the signed portion. The signed portion starts from the first name component and ends just before the final name component (which is assumed to be a signature for a signed interest).

signedPortionEndOffset - Return the offset in the encoding of the end of the signed portion. The signed portion starts from the first name component and ends just before the final name component (which is assumed to be a signature for a signed interest).

Returns:

A Blob containing the encoding.

decodeInterest

public void decodeInterest(Interest interest,
                  ByteBuffer input,
                  int[] signedPortionBeginOffset,
                  int[] signedPortionEndOffset,
                  boolean copy)
                    throws EncodingException

Decode input as an interest in NDN-TLV and set the fields of the interest object.

Overrides:

decodeInterest in class WireFormat

Parameters:

interest - The Interest object whose fields are updated.

input - The input buffer to decode. This reads from position() to limit(), but does not change the position.

signedPortionBeginOffset - Return the offset in the encoding of the beginning of the signed portion. The signed portion starts from the first name component and ends just before the final name component (which is assumed to be a signature for a signed interest).

signedPortionEndOffset - Return the offset in the encoding of the end of the signed portion. The signed portion starts from the first name component and ends just before the final name component (which is assumed to be a signature for a signed interest).

copy - If true, copy from the input when making new Blob values. If false, then Blob values share memory with the input, which must remain unchanged while the Blob values are used.

Throws:

EncodingException - For invalid encoding.

encodeData

public Blob encodeData(Data data,
              int[] signedPortionBeginOffset,
              int[] signedPortionEndOffset)

Encode data in NDN-TLV and return the encoding.

Overrides:

encodeData in class WireFormat

Parameters:

data - The Data object to encode.

signedPortionBeginOffset - Return the offset in the encoding of the beginning of the signed portion by setting signedPortionBeginOffset[0]. If you are not encoding in order to sign, you can call encodeData(data) to ignore this returned value.

signedPortionEndOffset - Return the offset in the encoding of the end of the signed portion by setting signedPortionEndOffset[0]. If you are not encoding in order to sign, you can call encodeData(data) to ignore this returned value.

Returns:

A Blob containing the encoding.

decodeData

public void decodeData(Data data,
              ByteBuffer input,
              int[] signedPortionBeginOffset,
              int[] signedPortionEndOffset,
              boolean copy)
                throws EncodingException

Decode input as a data packet in NDN-TLV and set the fields in the data object.

Overrides:

decodeData in class WireFormat

Parameters:

data - The Data object whose fields are updated.

input - The input buffer to decode. This reads from position() to limit(), but does not change the position.

signedPortionBeginOffset - Return the offset in the input buffer of the beginning of the signed portion by setting signedPortionBeginOffset[0]. If you are not decoding in order to verify, you can call decodeData(data, input) to ignore this returned value.

signedPortionEndOffset - Return the offset in the input buffer of the end of the signed portion by setting signedPortionEndOffset[0]. If you are not decoding in order to verify, you can call decodeData(data, input) to ignore this returned value.

copy - If true, copy from the input when making new Blob values. If false, then Blob values share memory with the input, which must remain unchanged while the Blob values are used.

Throws:

EncodingException - For invalid encoding.

encodeControlParameters

public Blob encodeControlParameters(ControlParameters controlParameters)

Encode controlParameters in NDN-TLV and return the encoding.

Overrides:

encodeControlParameters in class WireFormat

Parameters:

controlParameters - The ControlParameters object to encode.

Returns:

A Blob containing the encoding.

decodeControlParameters

public void decodeControlParameters(ControlParameters controlParameters,
                           ByteBuffer input,
                           boolean copy)
                             throws EncodingException

Decode input as a control parameters in NDN-TLV and set the fields of the controlParameters object.

Overrides:

decodeControlParameters in class WireFormat

Parameters:

controlParameters - The ControlParameters object whose fields are updated.

input - The input buffer to decode. This reads from position() to limit(), but does not change the position.

copy - If true, copy from the input when making new Blob values. If false, then Blob values share memory with the input, which must remain unchanged while the Blob values are used.

Throws:

EncodingException - For invalid encoding

encodeControlResponse

public Blob encodeControlResponse(ControlResponse controlResponse)

Encode controlResponse in NDN-TLV and return the encoding.

Overrides:

encodeControlResponse in class WireFormat

Parameters:

controlResponse - The ControlResponse object to encode.

Returns:

A Blob containing the encoding.

decodeControlResponse

public void decodeControlResponse(ControlResponse controlResponse,
                         ByteBuffer input,
                         boolean copy)
                           throws EncodingException

Decode input as a control parameters in NDN-TLV and set the fields of the controlResponse object.

Overrides:

decodeControlResponse in class WireFormat

Parameters:

controlResponse - The ControlResponse object whose fields are updated.

input - The input buffer to decode. This reads from position() to limit(), but does not change the position.

copy - If true, copy from the input when making new Blob values. If false, then Blob values share memory with the input, which must remain unchanged while the Blob values are used.

Throws:

EncodingException - For invalid encoding

encodeSignatureInfo

public Blob encodeSignatureInfo(Signature signature)

Encode signature as a SignatureInfo in NDN-TLV and return the encoding.

Overrides:

encodeSignatureInfo in class WireFormat

Parameters:

signature - An object of a subclass of Signature to encode.

Returns:

A Blob containing the encoding.

decodeSignatureInfoAndValue

public Signature decodeSignatureInfoAndValue(ByteBuffer signatureInfo,
                                    ByteBuffer signatureValue,
                                    boolean copy)
                                      throws EncodingException

Decode signatureInfo as an NDN-TLV signature info and signatureValue as the related NDN-TLV SignatureValue, and return a new object which is a subclass of Signature.

Overrides:

decodeSignatureInfoAndValue in class WireFormat

Parameters:

signatureInfo - The signature info input buffer to decode. This reads from position() to limit(), but does not change the position.

signatureValue - The signature value input buffer to decode. This reads from position() to limit(), but does not change the position.

copy - If true, copy from the input when making new Blob values. If false, then Blob values share memory with the input, which must remain unchanged while the Blob values are used.

Returns:

A new object which is a subclass of Signature.

Throws:

EncodingException - For invalid encoding.

encodeSignatureValue

public Blob encodeSignatureValue(Signature signature)

Encode the signatureValue in the Signature object as a SignatureValue (the signature bits) in NDN-TLV and return the encoding.

Overrides:

encodeSignatureValue in class WireFormat

Parameters:

signature - An object of a subclass of Signature with the signature value to encode.

Returns:

A Blob containing the encoding.

decodeLpPacket

public void decodeLpPacket(LpPacket lpPacket,
                  ByteBuffer input,
                  boolean copy)
                    throws EncodingException

Decode input as an NDN-TLV LpPacket and set the fields of the lpPacket object.

Overrides:

decodeLpPacket in class WireFormat

Parameters:

lpPacket - The LpPacket object whose fields are updated.

input - The input buffer to decode. This reads from position() to limit(), but does not change the position.

copy - If true, copy from the input when making new Blob values. If false, then Blob values share memory with the input, which must remain unchanged while the Blob values are used.

Throws:

EncodingException - For invalid encoding.

encodeDelegationSet

public Blob encodeDelegationSet(DelegationSet delegationSet)

Encode delegationSet as a sequence of NDN-TLV Delegation, and return the encoding. Note that the sequence of Delegation does not have an outer TLV type and length because it is intended to use the type and length of a Data packet's Content.

Overrides:

encodeDelegationSet in class WireFormat

Parameters:

delegationSet - The DelegationSet object to encode.

Returns:

A Blob containing the encoding.

decodeDelegationSet

public void decodeDelegationSet(DelegationSet delegationSet,
                       ByteBuffer input,
                       boolean copy)
                         throws EncodingException

Decode input as a sequence of NDN-TLV Delegation and set the fields of the delegationSet object. Note that the sequence of Delegation does not have an outer TLV type and length because it is intended to use the type and length of a Data packet's Content. This ignores any elements after the sequence of Delegation and before input.limit().

Overrides:

decodeDelegationSet in class WireFormat

Parameters:

delegationSet - The DelegationSet object whose fields are updated.

input - The input buffer to decode. This reads from position() to limit(), but does not change the position.

copy - If true, copy from the input when making new Blob values. If false, then Blob values share memory with the input, which must remain unchanged while the Blob values are used.

Throws:

EncodingException - For invalid encoding.

encodeEncryptedContent

public Blob encodeEncryptedContent(EncryptedContent encryptedContent)

Encode the EncryptedContent in NDN-TLV and return the encoding.

Overrides:

encodeEncryptedContent in class WireFormat

Parameters:

encryptedContent - The EncryptedContent object to encode.

Returns:

A Blob containing the encoding.

decodeEncryptedContent

public void decodeEncryptedContent(EncryptedContent encryptedContent,
                          ByteBuffer input,
                          boolean copy)
                            throws EncodingException

Decode input as a EncryptedContent in NDN-TLV and set the fields of the encryptedContent object.

Overrides:

decodeEncryptedContent in class WireFormat

Parameters:

encryptedContent - The EncryptedContent object whose fields are updated.

input - The input buffer to decode. This reads from position() to limit(), but does not change the position.

copy - If true, copy from the input when making new Blob values. If false, then Blob values share memory with the input, which must remain unchanged while the Blob values are used.

Throws:

EncodingException - For invalid encoding

get

public static Tlv0_2WireFormat get()

Get a singleton instance of a Tlv0_2WireFormat. To always use the preferred version NDN-TLV, you should use TlvWireFormat.get().

Returns:

The singleton instance.