com.fortanix.sdkms.v1.model

Class EncryptRequestFrame

java.lang.Object

com.fortanix.sdkms.v1.model.EncryptRequestFrame

public class EncryptRequestFrame
extends Object

A single frame of an encrypt request. Each frame is a CBOR map with exactly one string key: \"init\", \"ad\", \"plain\", or \"final\".

Constructor Summary

Constructors

Constructor and Description
EncryptRequestFrame()

Method Summary

Modifier and Type	Method and Description
EncryptRequestFrame	_final(Object _final)
EncryptRequestFrame	ad(byte[] ad)
boolean	equals(Object o)
byte[]	getAd() A chunk of additional data for authentication in AEAD modes.
Object	getFinal() All requests must end with a \"final\" frame.
EncryptRequestFrameInit	getInit() Get init
byte[]	getPlain() A chunk of ciphertext.
int	hashCode()
EncryptRequestFrame	init(EncryptRequestFrameInit init)
EncryptRequestFrame	plain(byte[] plain)
void	setAd(byte[] ad)
void	setFinal(Object _final)
void	setInit(EncryptRequestFrameInit init)
void	setPlain(byte[] plain)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EncryptRequestFrame

public EncryptRequestFrame()

Method Detail

init

public EncryptRequestFrame init(EncryptRequestFrameInit init)

getInit

public EncryptRequestFrameInit getInit()

Get init

Returns:

init

setInit

public void setInit(EncryptRequestFrameInit init)

ad

public EncryptRequestFrame ad(byte[] ad)

getAd

public byte[] getAd()

A chunk of additional data for authentication in AEAD modes. In CBOR, this is encoded directly as a byte string, *not* a UTF-8 string. All \"ad\" frames must come before any \"plain\" frames.

Returns:

ad

setAd

public void setAd(byte[] ad)

plain

public EncryptRequestFrame plain(byte[] plain)

getPlain

public byte[] getPlain()

A chunk of ciphertext. In CBOR, this is encoded directly as a byte string, *not* a UTF-8 string. In addition to the 512 KiB limit on the total size of all frames, the content of this field may be at most 511 KiB.

Returns:

plain

setPlain

public void setPlain(byte[] plain)

_final

public EncryptRequestFrame _final(Object _final)

getFinal

public Object getFinal()

All requests must end with a \"final\" frame. The value is the empty object (a CBOR map with zero items).

Returns:

_final

setFinal

public void setFinal(Object _final)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object