public abstract class StreamingAeadKey extends Key
| Constructor and Description |
|---|
StreamingAeadKey() |
| Modifier and Type | Method and Description |
|---|---|
Integer |
getIdRequirementOrNull()
Returns null if this key has no id requirement, otherwise the required id.
|
abstract StreamingAeadParameters |
getParameters()
Returns a
Parameters object containing all the information about the key which is not
randomly chosen. |
@Nullable public final Integer getIdRequirementOrNull()
KeySome keys, when they are in a keyset, are required to have a certain ID to work properly.
This comes from the fact that Tink in some cases prefixes ciphertexts or signatures with the
string 0x01<id>, where the ID is encoded in big endian (see the documentation of the
key type for details), in which case the key requires a certain ID.
getIdRequirementOrNull in class Keypublic abstract StreamingAeadParameters getParameters()
KeyParameters object containing all the information about the key which is not
randomly chosen.
Implementations need to ensure that getParameters().hasIdRequirement() returns true
if and only if getIdRequirementOrNull is non-null.
getParameters in class Key