net.named_data.jndn.encrypt

Class EncryptedContent

java.lang.Object

net.named_data.jndn.encrypt.EncryptedContent

public class EncryptedContent
extends Object

An EncryptedContent holds an encryption type, a payload and other fields representing encrypted content.

Note:

This class is an experimental feature. The API may change.

Constructor Summary

Constructors

Constructor and Description
EncryptedContent() Create an EncryptedContent where all the values are unspecified.
EncryptedContent(EncryptedContent encryptedContent) Create an EncryptedContent as a deep copy of the given object.

Method Summary

Methods

Modifier and Type	Method and Description
EncryptAlgorithmType	getAlgorithmType() Get the algorithm type.
Blob	getInitialVector() Get the initial vector.
KeyLocator	getKeyLocator() Get the key locator.
Blob	getPayload() Get the payload.
EncryptedContent	setAlgorithmType(EncryptAlgorithmType algorithmType) Set the algorithm type.
EncryptedContent	setInitialVector(Blob initialVector) Set the initial vector.
EncryptedContent	setKeyLocator(KeyLocator keyLocator) Set the key locator.
EncryptedContent	setPayload(Blob payload) Set the encrypted payload.
void	wireDecode(Blob input) Decode the input the default wire format and update this EncryptedContent.
void	wireDecode(Blob input, WireFormat wireFormat) Decode the input using a particular wire format and update this EncryptedContent.
void	wireDecode(ByteBuffer input) Decode the input wire encoding using the default wire format and update this EncryptedContent.
void	wireDecode(ByteBuffer input, WireFormat wireFormat) Decode the input using a particular wire format and update this EncryptedContent.
Blob	wireEncode() Encode this EncryptedContent for the default wire format.
Blob	wireEncode(WireFormat wireFormat) Encode this EncryptedContent to a wire encoding.

Methods inherited from class java.lang.Object

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

Constructor Detail

EncryptedContent

public EncryptedContent()

Create an EncryptedContent where all the values are unspecified.

EncryptedContent

public EncryptedContent(EncryptedContent encryptedContent)

Create an EncryptedContent as a deep copy of the given object.

Parameters:

encryptedContent - The other encryptedContent to copy.

Method Detail

getAlgorithmType

public final EncryptAlgorithmType getAlgorithmType()

Get the algorithm type.

Returns:

The algorithm type. If not specified, return null.

getKeyLocator

public final KeyLocator getKeyLocator()

Get the key locator.

Returns:

The key locator. If not specified, getType() is KeyLocatorType.NONE.

getInitialVector

public final Blob getInitialVector()

Get the initial vector.

Returns:

The initial vector. If not specified, isNull() is true.

getPayload

public final Blob getPayload()

Get the payload.

Returns:

The payload. If not specified, isNull() is true.

setAlgorithmType

public final EncryptedContent setAlgorithmType(EncryptAlgorithmType algorithmType)

Set the algorithm type.

Parameters:

algorithmType - The algorithm type. If not specified, set to null.

Returns:

This EncryptedContent so that you can chain calls to update values.

setKeyLocator

public final EncryptedContent setKeyLocator(KeyLocator keyLocator)

Set the key locator.

Parameters:

keyLocator - The key locator. This makes a copy of the object. If not specified, set to the default KeyLocator().

Returns:

This EncryptedContent so that you can chain calls to update values.

setInitialVector

public final EncryptedContent setInitialVector(Blob initialVector)

Set the initial vector.

Parameters:

initialVector - The initial vector. If not specified, set to the default Blob() where isNull() is true.

Returns:

This EncryptedContent so that you can chain calls to update values.

setPayload

public final EncryptedContent setPayload(Blob payload)

Set the encrypted payload.

Parameters:

payload - The payload. If not specified, set to the default Blob() where isNull() is true.

Returns:

This EncryptedContent so that you can chain calls to update values.

wireEncode

public final Blob wireEncode(WireFormat wireFormat)

Encode this EncryptedContent to a wire encoding.

Parameters:

wireFormat - A WireFormat object used to encode this EncryptedContent.

Returns:

The encoded byte array as a Blob.

wireEncode

public final Blob wireEncode()

Encode this EncryptedContent for the default wire format.

Returns:

The encoded byte array as a Blob.

wireDecode

public final void wireDecode(ByteBuffer input,
              WireFormat wireFormat)
                      throws EncodingException

Decode the input using a particular wire format and update this EncryptedContent.

Parameters:

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

wireFormat - A WireFormat object used to decode the input.

Throws:

EncodingException - For invalid encoding.

wireDecode

public final void wireDecode(ByteBuffer input)
                      throws EncodingException

Decode the input wire encoding using the default wire format and update this EncryptedContent.

Parameters:

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

Throws:

EncodingException - For invalid encoding.

wireDecode

public final void wireDecode(Blob input,
              WireFormat wireFormat)
                      throws EncodingException

Decode the input using a particular wire format and update this EncryptedContent.

Parameters:

input - The input blob to decode.

wireFormat - A WireFormat object used to decode the input.

Throws:

EncodingException - For invalid encoding.

wireDecode

public final void wireDecode(Blob input)
                      throws EncodingException

Decode the input the default wire format and update this EncryptedContent.

Parameters:

input - The input blob to decode.

Throws:

EncodingException - For invalid encoding.