Class StateSerialization

java.lang.Object

com.kingsrook.qqq.backend.core.state.StateSerialization

public final class StateSerialization
extends Object

Turns state values into the text a shared state provider stores, and back: Java serialization, gzip, then (with a key) AES-256-GCM bound to the state key, then base64. Reading goes through an ObjectInputFilter that allows only java.*, javax.*, com.kingsrook.* and the configured class prefixes, with depth and size limits. Formats: "g1:" + base64(gzip) without a key; "e1:" + base64(nonce + ciphertext) with one. A value written in the other format reads as an error (callers treat it as absent).

Constructor Summary

Constructors

Constructor	Description
StateSerialization(StateProviderMetaData metaData)	Build from meta data (null meta data: no key, the default allow list).

Method Summary

Modifier and Type	Method	Description
Serializable	fromBytes(byte[] bytes)	Un-gzip and deserialize, through the allow-list filter.
boolean	isEncrypted()	Whether stored values are encrypted.
Serializable	read(String stateKey, String stored)	Read a stored value back.
static byte[]	toBytes(Serializable value)	Java-serialize and gzip a value.
String	write(String stateKey, Serializable value)	Serialize a value (bound to its state key when encrypting).

Methods inherited from class java.lang.Object

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

Constructor Details

StateSerialization

public StateSerialization(StateProviderMetaData metaData)
                   throws QException

Build from meta data (null meta data: no key, the default allow list).

Throws:

QException

Method Details

isEncrypted

public boolean isEncrypted()

Whether stored values are encrypted.

write

public String write(String stateKey,
 Serializable value)
             throws QException

Serialize a value (bound to its state key when encrypting).

Throws:

QException

read

public Serializable read(String stateKey,
 String stored)
                  throws QException

Read a stored value back.

Throws:

QException

toBytes

public static byte[] toBytes(Serializable value)
                      throws QException

Java-serialize and gzip a value.

Throws:

QException

fromBytes

public Serializable fromBytes(byte[] bytes)
                       throws QException

Un-gzip and deserialize, through the allow-list filter.

Throws:

QException