EncryptedContent (jndn 0.22 API)

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Set all the fields to indicate unspecified values.
`EncryptAlgorithmType`	`getAlgorithmType()` Get the algorithm type.
`Blob`	`getInitialVector()` Get the initial vector.
`KeyLocator`	`getKeyLocator()` Get the key locator.
`Name`	`getKeyLocatorName()` Check that the key locator type is KEYNAME and return the key Name.
`Blob`	`getPayload()` Get the payload.
`Blob`	`getPayloadKey()` Get the encrypted payload key.
`boolean`	`hasInitialVector()` Check if the initial vector is specified.
`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`	`setKeyLocatorName(Name keyName)` Set the key locator type to KeyLocatorType.KEYNAME and set the key Name.
`EncryptedContent`	`setPayload(Blob payload)` Set the encrypted payload.
`EncryptedContent`	`setPayloadKey(Blob payloadKey)` Set the encrypted payload key.
`void`	`wireDecode(Blob input)` Decode the input as an EncryptedContent v1 using the default wire format and update this EncryptedContent.
`void`	`wireDecode(Blob input, WireFormat wireFormat)` Decode the input as an EncryptedContent v1 using a particular wire format and update this EncryptedContent.
`void`	`wireDecode(ByteBuffer input)` Decode the input as an EncryptedContent v1 using the default wire format and update this EncryptedContent.
`void`	`wireDecode(ByteBuffer input, WireFormat wireFormat)` Decode the input as an EncryptedContent v1 using a particular wire format and update this EncryptedContent.
`void`	`wireDecodeV2(Blob input)` Decode the input as an EncryptedContent v2 using the default wire format and update this EncryptedContent.
`void`	`wireDecodeV2(Blob input, WireFormat wireFormat)` Decode the input as an EncryptedContent v2 using a particular wire format and update this EncryptedContent.
`void`	`wireDecodeV2(ByteBuffer input)` Decode the input as an EncryptedContent v2 using the default wire format and update this EncryptedContent.
`void`	`wireDecodeV2(ByteBuffer input, WireFormat wireFormat)` Decode the input as an EncryptedContent v2 using a particular wire format and update this EncryptedContent.
`Blob`	`wireEncode()` Encode this to an EncryptedContent v1 for the default wire format.
`Blob`	`wireEncode(WireFormat wireFormat)` Encode this to an EncryptedContent v1 wire encoding.
`Blob`	`wireEncodeV2()` Encode this to an EncryptedContent v2 for the default wire format.
`Blob`	`wireEncodeV2(WireFormat wireFormat)` Encode this to an EncryptedContent v2 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 EncryptAlgorithmType.NONE.
  - getKeyLocator
```
public final KeyLocator getKeyLocator()
```
    Get the key locator.
    
    Returns:
    
    The key locator. If not specified, getType() is KeyLocatorType.NONE.
  - getKeyLocatorName
```
public final Name getKeyLocatorName()
```
    Check that the key locator type is KEYNAME and return the key Name.
    
    Returns:
    
    The key Name.
    
    Throws:
    
    Error - if the key locator type is not KEYNAME.
  - hasInitialVector
```
public final boolean hasInitialVector()
```
    Check if the initial vector is specified.
    
    Returns:
    
    True if the initial vector is specified.
  - 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.
  - getPayloadKey
```
public final Blob getPayloadKey()
```
    Get the encrypted payload key.
    
    Returns:
    
    The encrypted payload key. 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 EncryptAlgorithmType.NONE.
    
    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.
  - setKeyLocatorName
```
public final EncryptedContent setKeyLocatorName(Name keyName)
```
    Set the key locator type to KeyLocatorType.KEYNAME and set the key Name.
    
    Parameters:
    
    keyName - The key locator Name, which is copied.
    
    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.
  - setPayloadKey
```
public final EncryptedContent setPayloadKey(Blob payloadKey)
```
    Set the encrypted payload key.
    
    Parameters:
    
    payloadKey - The encrypted payload key. If not specified, set to the default Blob() where isNull() is true.
    
    Returns:
    
    This EncryptedContent so that you can chain calls to update values.
  - clear
```
public final void clear()
```
    Set all the fields to indicate unspecified values.
  - wireEncode
```
public final Blob wireEncode(WireFormat wireFormat)
```
    Encode this to an EncryptedContent v1 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 to an EncryptedContent v1 for the default wire format.
    
    Returns:
    
    The encoded byte array as a Blob.
  - wireEncodeV2
```
public final Blob wireEncodeV2(WireFormat wireFormat)
```
    Encode this to an EncryptedContent v2 wire encoding.
    
    Parameters:
    
    wireFormat - A WireFormat object used to encode this EncryptedContent.
    
    Returns:
    
    The encoded byte array as a Blob.
  - wireEncodeV2
```
public final Blob wireEncodeV2()
```
    Encode this to an EncryptedContent v2 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 as an EncryptedContent v1 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 as an EncryptedContent v1 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 as an EncryptedContent v1 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 as an EncryptedContent v1 using the default wire format and update this EncryptedContent.
    
    Parameters:
    
    input - The input blob to decode.
    
    Throws:
    
    EncodingException - For invalid encoding.
  - wireDecodeV2
```
public final void wireDecodeV2(ByteBuffer input,
                               WireFormat wireFormat)
                        throws EncodingException
```
    Decode the input as an EncryptedContent v2 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.
  - wireDecodeV2
```
public final void wireDecodeV2(ByteBuffer input)
                        throws EncodingException
```
    Decode the input as an EncryptedContent v2 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.
  - wireDecodeV2
```
public final void wireDecodeV2(Blob input,
                               WireFormat wireFormat)
                        throws EncodingException
```
    Decode the input as an EncryptedContent v2 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.
  - wireDecodeV2
```
public final void wireDecodeV2(Blob input)
                        throws EncodingException
```
    Decode the input as an EncryptedContent v2 using the default wire format and update this EncryptedContent.
    
    Parameters:
    
    input - The input blob to decode.
    
    Throws:
    
    EncodingException - For invalid encoding.

Class EncryptedContent

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EncryptedContent

EncryptedContent

Method Detail

getAlgorithmType

getKeyLocator

getKeyLocatorName

hasInitialVector

getInitialVector

getPayload

getPayloadKey

setAlgorithmType

setKeyLocator

setKeyLocatorName

setInitialVector

setPayload

setPayloadKey

clear

wireEncode

wireEncode

wireEncodeV2

wireEncodeV2

wireDecode

wireDecode

wireDecode

wireDecode

wireDecodeV2

wireDecodeV2

wireDecodeV2

wireDecodeV2