net.named_data.jndn.encoding

Class WireFormat

java.lang.Object

net.named_data.jndn.encoding.WireFormat

Direct Known Subclasses:

BinaryXmlWireFormat, Tlv0_1_1WireFormat

public class WireFormat
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	ENABLE_NDNX NDNx support and binary XML (ccnb or ndnb) encoding is deprecated and code with throw an exception.

Constructor Summary

Constructors

Constructor and Description
WireFormat()

Method Summary

Methods

Modifier and Type	Method and Description
void	decodeControlParameters(ControlParameters controlParameters, ByteBuffer input) Decode input as a control parameters and set the fields of the controlParameters object.
void	decodeData(Data data, ByteBuffer input) Decode input as a data packet and set the fields in the data object.
void	decodeData(Data data, ByteBuffer input, int[] signedPortionBeginOffset, int[] signedPortionEndOffset) Decode input as a data packet and set the fields in the data object.
void	decodeForwardingEntry(ForwardingEntry forwardingEntry, ByteBuffer input) Decode input as a forwarding entry and set the fields of the forwardingEntry object.
void	decodeInterest(Interest interest, ByteBuffer input) Decode input as an interest and set the fields of the interest object.
void	decodeInterest(Interest interest, ByteBuffer input, int[] signedPortionBeginOffset, int[] signedPortionEndOffset) Decode input as an interest and set the fields of the interest object.
void	decodeLocalControlHeader(LocalControlHeader localControlHeader, ByteBuffer input) Decode input as a LocalControlHeader in NDN-TLV and set the fields of the localControlHeader object.
void	decodeName(Name name, ByteBuffer input) Decode input as a name and set the fields of the Name object.
Signature	decodeSignatureInfoAndValue(ByteBuffer signatureInfo, ByteBuffer signatureValue) Decode signatureInfo as a signature info and signatureValue as the related SignatureValue, and return a new object which is a subclass of Signature.
Blob	encodeControlParameters(ControlParameters controlParameters) Encode controlParameters and return the encoding.
Blob	encodeData(Data data) Encode data and return the encoding.
Blob	encodeData(Data data, int[] signedPortionBeginOffset, int[] signedPortionEndOffset) Encode data and return the encoding.
Blob	encodeForwardingEntry(ForwardingEntry forwardingEntry) Encode forwardingEntry and return the encoding.
Blob	encodeInterest(Interest interest) Encode interest and return the encoding.
Blob	encodeInterest(Interest interest, int[] signedPortionBeginOffset, int[] signedPortionEndOffset) Encode interest and return the encoding.
Blob	encodeLocalControlHeader(LocalControlHeader localControlHeader) Encode the LocalControlHeader in NDN-TLV and return the encoding.
Blob	encodeName(Name name) Encode name and return the encoding.
Blob	encodeSignatureInfo(Signature signature) Encode signature as a SignatureInfo and return the encoding.
Blob	encodeSignatureValue(Signature signature) Encode the signatureValue in the Signature object as a SignatureValue (the signature bits) and return the encoding.
static WireFormat	getDefaultWireFormat() Return the default WireFormat used by default encoding and decoding methods which was set with setDefaultWireFormat.
static void	setDefaultWireFormat(WireFormat wireFormat) Set the static default WireFormat used by default encoding and decoding methods.

Methods inherited from class java.lang.Object

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

Field Detail

ENABLE_NDNX

public static boolean ENABLE_NDNX

NDNx support and binary XML (ccnb or ndnb) encoding is deprecated and code with throw an exception. To enable support while you upgrade your code to use NFD, set WireFormat.ENABLE_NDNX = true . NDNx support will be completely removed in an upcoming release.

Constructor Detail

WireFormat

public WireFormat()

Method Detail

encodeName

public Blob encodeName(Name name)

Encode name and return the encoding. Your derived class should override.

Parameters:

name - The Name object to encode.

Returns:

A Blob containing the encoding.

Throws:

UnsupportedOperationException - for unimplemented if the derived class does not override.

decodeName

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

Decode input as a name and set the fields of the Name object. Your derived class should override.

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.

Throws:

EncodingException - For invalid encoding.

encodeInterest

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

Encode interest and return the encoding. Your derived class should override.

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). If you are not encoding in order to sign, you can call encodeInterest(const Interest& interest) to ignore this returned value.

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). If you are not encoding in order to sign, you can call encodeInterest(const Interest& interest) to ignore this returned value.

Returns:

A Blob containing the encoding.

Throws:

UnsupportedOperationException - for unimplemented if the derived class does not override.

encodeInterest

public final Blob encodeInterest(Interest interest)

Encode interest and return the encoding. Your derived class should override.

Parameters:

interest - The Interest object to encode.

Returns:

A Blob containing the encoding.

Throws:

UnsupportedOperationException - for unimplemented if the derived class does not override.

decodeInterest

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

Decode input as an interest and set the fields of the interest object. Your derived class should override.

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). If you are not decoding in order to verify, you can call decodeInterest(Interest interest, ByteBuffer input) to ignore this returned value.

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). If you are not decoding in order to verify, you can call decodeInterest(Interest interest, ByteBuffer input) to ignore this returned value.

Throws:

UnsupportedOperationException - for unimplemented if the derived class does not override.

EncodingException - For invalid encoding.

decodeInterest

public final void decodeInterest(Interest interest,
                  ByteBuffer input)
                          throws EncodingException

Decode input as an interest and set the fields of the interest object. Your derived class should override.

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.

Throws:

UnsupportedOperationException - for unimplemented if the derived class does not override.

EncodingException - For invalid encoding.

encodeData

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

Encode data and return the encoding. Your derived class should override.

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.

Throws:

UnsupportedOperationException - for unimplemented if the derived class does not override.

encodeData

public final Blob encodeData(Data data)

Encode data and return the encoding.

Parameters:

data - The Data object to encode.

Returns:

A Blob containing the encoding.

Throws:

UnsupportedOperationException - for unimplemented if the derived class does not override.

decodeData

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

Decode input as a data packet and set the fields in the data object. Your derived class should override.

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.

Throws:

UnsupportedOperationException - for unimplemented if the derived class does not override.

EncodingException - For invalid encoding.

decodeData

public final void decodeData(Data data,
              ByteBuffer input)
                      throws EncodingException

Decode input as a data packet and set the fields in the data object. Your derived class should override.

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.

Throws:

UnsupportedOperationException - for unimplemented if the derived class does not override.

EncodingException - For invalid encoding.

encodeForwardingEntry

public Blob encodeForwardingEntry(ForwardingEntry forwardingEntry)

Encode forwardingEntry and return the encoding. Your derived class should override.

Parameters:

forwardingEntry - The ForwardingEntry object to encode.

Returns:

A Blob containing the encoding.

Throws:

UnsupportedOperationException - for unimplemented if the derived class does not override.

decodeForwardingEntry

public void decodeForwardingEntry(ForwardingEntry forwardingEntry,
                         ByteBuffer input)
                           throws EncodingException

Decode input as a forwarding entry and set the fields of the forwardingEntry object. Your derived class should override.

Parameters:

forwardingEntry - The ForwardingEntry object whose fields are updated.

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

Throws:

UnsupportedOperationException - for unimplemented if the derived class does not override.

EncodingException - For invalid encoding.

encodeControlParameters

public Blob encodeControlParameters(ControlParameters controlParameters)

Encode controlParameters and return the encoding. Your derived class should override.

Parameters:

controlParameters - The ControlParameters object to encode.

Returns:

A Blob containing the encoding.

Throws:

UnsupportedOperationException - for unimplemented if the derived class does not override.

decodeControlParameters

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

Decode input as a control parameters and set the fields of the controlParameters object. Your derived class should override.

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.

Throws:

UnsupportedOperationException - for unimplemented if the derived class does not override.

EncodingException - For invalid encoding.

encodeSignatureInfo

public Blob encodeSignatureInfo(Signature signature)

Encode signature as a SignatureInfo and return the encoding. Your derived class should override.

Parameters:

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

Returns:

A Blob containing the encoding.

Throws:

UnsupportedOperationException - for unimplemented if the derived class does not override.

decodeSignatureInfoAndValue

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

Decode signatureInfo as a signature info and signatureValue as the related SignatureValue, and return a new object which is a subclass of Signature. Your derived class should override.

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.

Returns:

A new object which is a subclass of Signature.

Throws:

UnsupportedOperationException - for unimplemented if the derived class does not override.

EncodingException - For invalid encoding.

encodeSignatureValue

public Blob encodeSignatureValue(Signature signature)

Encode the signatureValue in the Signature object as a SignatureValue (the signature bits) and return the encoding. Your derived class should override.

Parameters:

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

Returns:

A Blob containing the encoding.

Throws:

UnsupportedOperationException - for unimplemented if the derived class does not override.

encodeLocalControlHeader

public Blob encodeLocalControlHeader(LocalControlHeader localControlHeader)

Encode the LocalControlHeader in NDN-TLV and return the encoding. Your derived class should override.

Parameters:

localControlHeader - The LocalControlHeader object to encode.

Returns:

A Blob containing the encoding.

Throws:

UnsupportedOperationException - for unimplemented if the derived class does not override.

decodeLocalControlHeader

public void decodeLocalControlHeader(LocalControlHeader localControlHeader,
                            ByteBuffer input)
                              throws EncodingException

Decode input as a LocalControlHeader in NDN-TLV and set the fields of the localControlHeader object. Your derived class should override.

Parameters:

localControlHeader - The LocalControlHeader object whose fields are updated.

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

Throws:

EncodingException - For invalid encoding

UnsupportedOperationException - for unimplemented if the derived class does not override.

setDefaultWireFormat

public static void setDefaultWireFormat(WireFormat wireFormat)

Set the static default WireFormat used by default encoding and decoding methods.

Parameters:

wireFormat - An object of a subclass of WireFormat. This does not make a copy.

getDefaultWireFormat

public static WireFormat getDefaultWireFormat()

Return the default WireFormat used by default encoding and decoding methods which was set with setDefaultWireFormat.

Returns:

The WireFormat object.