Index (Codec 0.10.0 API)

A B C D E F G H I J K L M N O P R S T U V W X Z
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

aad(byte[]) - Method in class org.jwcarman.codec.crypto.EnvelopeCodec.Builder: Sets the additional authenticated data (AAD) bound to every message produced by this codec.
acquire(DataKeyProvider) - Method in class org.jwcarman.codec.crypto.BoundedDataKeyStrategy
acquire(DataKeyProvider) - Method in interface org.jwcarman.codec.crypto.DataKeyStrategy: Acquires the data key to use for the next message, consulting the given provider as needed.
acquire(DataKeyProvider) - Method in class org.jwcarman.codec.crypto.DirectDataKeyStrategy
aliasing(Map) - Method in class org.jwcarman.codec.transform.encoding.Base32Codec: The same codec, additionally reading each key of aliases as the alphabet symbol it names — Crockford's I, L → 1 and O → 0, for example.
allowedKeyIds(Predicate) - Method in class org.jwcarman.codec.crypto.EnvelopeCodec.Builder: Sets the predicate used to admit a wire keyId on decode, overriding the provider's DataKeyProvider.allowsKeyId(String).
allowsKeyId(String) - Method in interface org.jwcarman.codec.crypto.DataKeyProvider: Returns whether this provider is willing to unwrap data keys wrapped under the given key id.
allowsKeyId(String) - Method in class org.jwcarman.codec.crypto.JceDataKeyProvider
alphabet() - Method in class org.jwcarman.codec.transform.encoding.Base32Codec: The alphabet, in value order.
andThen(Codec) - Method in interface org.jwcarman.codec.Codec: Layers a byte-level transform (compression, encryption, etc.) onto this codec.

B

Base32Codec - Class in org.jwcarman.codec.transform.encoding: A byte-to-text-safe-byte transform using Base32: eight ASCII symbols per five bytes, over any alphabet of 32 symbols.
Base64Codec - Class in org.jwcarman.codec.transform.encoding: A byte-to-text-safe-byte transform: encodes any bytes as Base64 (RFC 4648) and decodes them back.
basic() - Static method in class org.jwcarman.codec.transform.encoding.Base64Codec: The basic alphabet (A-Za-z0-9+/) with padding.
BoundedDataKeyStrategy - Class in org.jwcarman.codec.crypto: Opt-in DataKeyStrategy that caches a data-encryption key (DEK) and rolls to a fresh one after maxMessages messages or maxAge has elapsed, whichever comes first.
BoundedDataKeyStrategy(long, Duration) - Constructor for class org.jwcarman.codec.crypto.BoundedDataKeyStrategy: Creates a strategy using System.nanoTime() as the monotonic ticker.
BoundedDataKeyStrategy(long, Duration, LongSupplier) - Constructor for class org.jwcarman.codec.crypto.BoundedDataKeyStrategy: Creates a strategy using the given ticker to measure elapsed time.
build() - Method in class org.jwcarman.codec.crypto.EnvelopeCodec.Builder: Builds the EnvelopeCodec.
build() - Method in class org.jwcarman.codec.crypto.JceDataKeyProvider.Builder: Builds the JceDataKeyProvider.
build() - Method in class org.jwcarman.codec.versioned.VersionedCodec.Builder: Builds the codec.
builder() - Static method in class org.jwcarman.codec.versioned.VersionedCodec: Starts building a versioned codec.
builder(String, Map) - Static method in class org.jwcarman.codec.crypto.JceDataKeyProvider: Starts building a JceDataKeyProvider.
builder(DataKeyProvider) - Static method in class org.jwcarman.codec.crypto.EnvelopeCodec: Starts building an EnvelopeCodec backed by the given key provider.

C

Caching contract - Section in interface org.jwcarman.codec.crypto.DataKeyProvider

caseInsensitive() - Method in class org.jwcarman.codec.transform.encoding.Base32Codec

The same alphabet and padding, decoding without regard to letter case: a and A both read as whichever of them is in the alphabet.

ChecksumCodec - Class in org.jwcarman.codec.transform.checksum

A Codec<byte[]> transform that appends a 32-bit checksum (big-endian) on encode and verifies it on decode, rejecting a mismatch with InvalidPayloadException.

ChecksumCodec(Supplier) - Constructor for class org.jwcarman.codec.transform.checksum.ChecksumCodec

Creates a codec over any 32-bit Checksum.

Choosing a message cap - Section in class org.jwcarman.codec.crypto.BoundedDataKeyStrategy

Ciphertext-substitution limitation - Section in class org.jwcarman.codec.crypto.EnvelopeCodec

Codec<T> - Interface in org.jwcarman.codec

Converts values of type T to and from byte[].

CodecDeserializer<T> - Class in org.jwcarman.codec.kafka

Adapts a Codec to Kafka's Deserializer.

CodecDeserializer(Codec) - Constructor for class org.jwcarman.codec.kafka.CodecDeserializer

Creates a deserializer backed by the codec.

CodecException - Exception Class in org.jwcarman.codec

The root of every failure a Codec reports from Codec.encode(T) or Codec.decode(byte[]).

CodecException(String) - Constructor for exception class org.jwcarman.codec.CodecException

Creates a codec failure with the given message; for subclasses.

CodecException(String, Throwable) - Constructor for exception class org.jwcarman.codec.CodecException

Creates a codec failure with the given message and cause; for subclasses.

CodecFactory - Interface in org.jwcarman.codec

Produces Codec instances for arbitrary types, backed by a serialization library.

CodecRedisCacheAutoConfiguration - Class in org.jwcarman.codec.autoconfigure

Serializes Redis cache values through the application's CodecFactory.

CodecRedisCacheAutoConfiguration() - Constructor for class org.jwcarman.codec.autoconfigure.CodecRedisCacheAutoConfiguration

Creates the auto-configuration.

codecRedisCacheManagerBuilderCustomizer(CodecFactory, CodecRedisCacheProperties) - Method in class org.jwcarman.codec.autoconfigure.CodecRedisCacheAutoConfiguration

Customizes the Redis cache manager so cache values are serialized through the codec factory.

CodecRedisCacheProperties - Class in org.jwcarman.codec.autoconfigure

Settings for serializing Redis cache values through the application's CodecFactory.

CodecRedisCacheProperties() - Constructor for class org.jwcarman.codec.autoconfigure.CodecRedisCacheProperties

Creates the properties with their defaults.

CodecRedisSerializer<T> - Class in org.jwcarman.codec.redis

Adapts a Codec to Spring Data Redis's RedisSerializer, so a codec — with whatever compression or encryption it composes — is what Redis stores:

RedisTemplate<String, Person> template = new RedisTemplate<>();
template.setValueSerializer(CodecRedisSerializer.of(factory, Person.class));

CodecSerde<T> - Class in org.jwcarman.codec.kafka

A Kafka Serde pairing a CodecSerializer and CodecDeserializer over one codec, for Kafka Streams:

KStream<String, Person> people =
    builder.stream("people", Consumed.with(Serdes.String(), new CodecSerde<>(codec)));

CodecSerde(Codec) - Constructor for class org.jwcarman.codec.kafka.CodecSerde

Creates a serde backed by the codec.

CodecSerializer<T> - Class in org.jwcarman.codec.kafka

Adapts a Codec to Kafka's Serializer.

CodecSerializer(Codec) - Constructor for class org.jwcarman.codec.kafka.CodecSerializer

Creates a serializer backed by the codec.

compressing(OutputStream) - Method in class org.jwcarman.codec.lz4.Lz4Codec

compressing(OutputStream) - Method in class org.jwcarman.codec.transform.compress.CompressionStreamCodec

Wraps the sink in a stream that compresses everything written to it.

compressing(OutputStream) - Method in class org.jwcarman.codec.transform.compress.DeflateCodec

compressing(OutputStream) - Method in class org.jwcarman.codec.transform.compress.GzipCodec

compressing(OutputStream) - Method in class org.jwcarman.codec.zstd.ZstdCodec

CompressionStreamCodec - Class in org.jwcarman.codec.transform.compress

Base class for stream-based compression transforms, intended for use with Codec.andThen(Codec).

CompressionStreamCodec(long) - Constructor for class org.jwcarman.codec.transform.compress.CompressionStreamCodec

Creates a codec that refuses to decode payloads expanding beyond the given size.

Concurrency and rolling - Section in class org.jwcarman.codec.crypto.BoundedDataKeyStrategy

Cost of the default strategy - Section in class org.jwcarman.codec.crypto.EnvelopeCodec

crc32c() - Static method in class org.jwcarman.codec.transform.checksum.ChecksumCodec

CRC-32C (Castagnoli), the recommended checksum.

create(Class) - Method in interface org.jwcarman.codec.CodecFactory

Creates a codec for a non-generic class.

create(TypeRef) - Method in interface org.jwcarman.codec.CodecFactory

Creates a codec for the given type reference, supporting full generic types.

create(TypeRef) - Method in class org.jwcarman.codec.fory.ForyCodecFactory

create(TypeRef) - Method in class org.jwcarman.codec.gson.GsonCodecFactory

create(TypeRef) - Method in class org.jwcarman.codec.jackson.JacksonCodecFactory

create(TypeRef) - Method in class org.jwcarman.codec.jackson2.Jackson2CodecFactory

create(TypeRef) - Method in class org.jwcarman.codec.jsonb.JsonbCodecFactory

create(TypeRef) - Method in class org.jwcarman.codec.protobuf.ProtobufCodecFactory

crockford() - Static method in class org.jwcarman.codec.transform.encoding.Base32Codec

Crockford's alphabet (0-9A-Z without I, L, O, U), the encoding of ULIDs: no padding, and decoding that folds case and reads I and L as 1 and O as 0.

cryptographic(Throwable) - Static method in exception class org.jwcarman.codec.crypto.DecryptionException

Creates a cryptographic rejection with the uniform message shared by every tag, unwrap and scheme failure, so that callers cannot distinguish them by content.

D

DataKey - Record Class in org.jwcarman.codec.crypto: A data-encryption key (DEK) acquired from a DataKeyProvider: the plaintext key material used to encrypt or decrypt one message, paired with the id of the key-encryption key (KEK) that wrapped it and the wrapped (ciphertext) form of the key itself.
DataKey(String, SecretKey, byte[]) - Constructor for record class org.jwcarman.codec.crypto.DataKey: Validates the fields and defensively clones wrapped.
DataKeyProvider - Interface in org.jwcarman.codec.crypto: SPI for envelope-encryption key management, implemented by consumers against an in-process key store or a remote KMS (AWS KMS, HashiCorp Vault, GCP Cloud KMS, etc.).
DataKeyStrategy - Interface in org.jwcarman.codec.crypto: Pure lifecycle policy for acquiring the data-encryption key used to encode a message.
decode(byte[]) - Method in interface org.jwcarman.codec.Codec: Decodes bytes back into a value.
decode(byte[]) - Method in class org.jwcarman.codec.crypto.EnvelopeCodec
decode(byte[]) - Method in class org.jwcarman.codec.transform.checksum.ChecksumCodec
decode(byte[]) - Method in class org.jwcarman.codec.transform.compress.CompressionStreamCodec
decode(byte[]) - Method in class org.jwcarman.codec.transform.encoding.Base32Codec
decode(byte[]) - Method in class org.jwcarman.codec.transform.encoding.Base64Codec
decode(byte[]) - Method in class org.jwcarman.codec.transform.encoding.HexCodec
decode(byte[]) - Method in class org.jwcarman.codec.transform.text.StringCodec
decompressing(InputStream) - Method in class org.jwcarman.codec.lz4.Lz4Codec
decompressing(InputStream) - Method in class org.jwcarman.codec.transform.compress.CompressionStreamCodec: Wraps the source in a stream that decompresses everything read from it.
decompressing(InputStream) - Method in class org.jwcarman.codec.transform.compress.DeflateCodec
decompressing(InputStream) - Method in class org.jwcarman.codec.transform.compress.GzipCodec
decompressing(InputStream) - Method in class org.jwcarman.codec.zstd.ZstdCodec
DecryptionException - Exception Class in org.jwcarman.codec.crypto: Exception indicating that the data provided for decryption is invalid or corrupted.
DecryptionException(String) - Constructor for exception class org.jwcarman.codec.crypto.DecryptionException: Creates a structural rejection with a stage-specific message.
DecryptionException(String, Throwable) - Constructor for exception class org.jwcarman.codec.crypto.DecryptionException: Creates a rejection carrying the underlying cause.
DEFAULT_MAX_DECODED_SIZE - Static variable in class org.jwcarman.codec.transform.compress.CompressionStreamCodec: Default maximum decoded size (64 MiB).
DeflateCodec - Class in org.jwcarman.codec.transform.compress: Compresses with the zlib format (RFC 1950): DEFLATE data wrapped in a two-byte header and Adler-32 checksum.
DeflateCodec() - Constructor for class org.jwcarman.codec.transform.compress.DeflateCodec: Creates a codec with the default compression level and decoded-size cap of 64 MiB.
DeflateCodec(int, long) - Constructor for class org.jwcarman.codec.transform.compress.DeflateCodec: Creates a codec with a specific compression level and decoded-size cap.
DeflateCodec(long) - Constructor for class org.jwcarman.codec.transform.compress.DeflateCodec: Creates a codec with the default compression level and a custom decoded-size cap.
deserialize(byte[]) - Method in class org.jwcarman.codec.redis.CodecRedisSerializer
deserialize(String, byte[]) - Method in class org.jwcarman.codec.kafka.CodecDeserializer
deserializer() - Method in class org.jwcarman.codec.kafka.CodecSerde
DirectDataKeyStrategy - Class in org.jwcarman.codec.crypto: Default DataKeyStrategy: acquires a fresh data-encryption key per message.
DirectDataKeyStrategy() - Constructor for class org.jwcarman.codec.crypto.DirectDataKeyStrategy: Creates the strategy.
Duration - Section in class org.jwcarman.codec.crypto.BoundedDataKeyStrategy

E

encode(byte[]) - Method in class org.jwcarman.codec.crypto.EnvelopeCodec
encode(byte[]) - Method in class org.jwcarman.codec.transform.checksum.ChecksumCodec
encode(byte[]) - Method in class org.jwcarman.codec.transform.compress.CompressionStreamCodec
encode(byte[]) - Method in class org.jwcarman.codec.transform.encoding.Base32Codec
encode(byte[]) - Method in class org.jwcarman.codec.transform.encoding.Base64Codec
encode(byte[]) - Method in class org.jwcarman.codec.transform.encoding.HexCodec
encode(String) - Method in class org.jwcarman.codec.transform.text.StringCodec
encode(T) - Method in interface org.jwcarman.codec.Codec: Encodes a value to bytes.
EncryptionException - Exception Class in org.jwcarman.codec.crypto: Exception indicating a failure during the encryption operation.
EncryptionException(String) - Constructor for exception class org.jwcarman.codec.crypto.EncryptionException: Creates an encode-side failure.
EncryptionException(String, Throwable) - Constructor for exception class org.jwcarman.codec.crypto.EncryptionException: Creates an encode-side failure carrying the underlying cause.
EnvelopeCodec - Class in org.jwcarman.codec.crypto: Envelope-encryption Codec for byte[]: encrypts with AES-256-GCM under a per-message data-encryption key (DEK), itself wrapped by a DataKeyProvider and carried alongside the ciphertext.
EnvelopeCodec.Builder - Class in org.jwcarman.codec.crypto: Builder for EnvelopeCodec.
equals(Object) - Method in record class org.jwcarman.codec.crypto.DataKey: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class org.jwcarman.codec.TypeRef
Error contract - Section in interface org.jwcarman.codec.crypto.DataKeyProvider

F

ForyCodecAutoConfiguration - Class in org.jwcarman.codec.autoconfigure: Registers a ForyCodecFactory when the application defines a ThreadSafeFory bean.
ForyCodecAutoConfiguration() - Constructor for class org.jwcarman.codec.autoconfigure.ForyCodecAutoConfiguration: Creates the auto-configuration.
foryCodecFactory(ThreadSafeFory) - Method in class org.jwcarman.codec.autoconfigure.ForyCodecAutoConfiguration: Creates the factory around the application's ThreadSafeFory bean.
ForyCodecFactory - Class in org.jwcarman.codec.fory: A CodecFactory backed by Apache Fory: fast binary serialization for JVM-to-JVM payloads such as cache entries, queue messages and journal records.
ForyCodecFactory(ThreadSafeFory) - Constructor for class org.jwcarman.codec.fory.ForyCodecFactory: Creates a factory over a caller-configured thread-safe Fory instance.

G

geohash() - Static method in class org.jwcarman.codec.transform.encoding.Base32Codec: The geohash alphabet (0-9b-z without a, i, l, o): lower case, no padding, strict decoding.
getCaches() - Method in class org.jwcarman.codec.autoconfigure.CodecRedisCacheProperties: Cache name to the fully qualified class name of the values it holds.
getDefaultType() - Method in class org.jwcarman.codec.autoconfigure.CodecRedisCacheProperties: The value type for caches not listed under CodecRedisCacheProperties.getCaches().
getTargetType() - Method in class org.jwcarman.codec.redis.CodecRedisSerializer
getType() - Method in class org.jwcarman.codec.TypeRef: Returns the captured type.
GsonCodecAutoConfiguration - Class in org.jwcarman.codec.autoconfigure: Auto-configures a GsonCodecFactory when the Gson backend is on the classpath and no other CodecFactory bean exists.
GsonCodecAutoConfiguration() - Constructor for class org.jwcarman.codec.autoconfigure.GsonCodecAutoConfiguration: Creates the auto-configuration.
gsonCodecFactory(ObjectProvider) - Method in class org.jwcarman.codec.autoconfigure.GsonCodecAutoConfiguration: Creates the factory, reusing the application's Gson bean when one exists.
GsonCodecFactory - Class in org.jwcarman.codec.gson: Produces JSON codecs backed by a shared Gson instance.
GsonCodecFactory(Gson) - Constructor for class org.jwcarman.codec.gson.GsonCodecFactory: Creates a factory that uses the given Gson instance for all codecs it produces.
GzipCodec - Class in org.jwcarman.codec.transform.compress: Compresses with the gzip format (RFC 1952): DEFLATE data wrapped in a gzip header and CRC-32 trailer.
GzipCodec() - Constructor for class org.jwcarman.codec.transform.compress.GzipCodec: Creates a codec with the default decoded-size cap of 64 MiB.
GzipCodec(long) - Constructor for class org.jwcarman.codec.transform.compress.GzipCodec: Creates a codec with a custom decoded-size cap.

H

hashCode() - Method in record class org.jwcarman.codec.crypto.DataKey: Combines keyId and wrapped as 31 * keyId.hashCode() + Arrays.hashCode(wrapped), consistent with DataKey.equals(Object) comparing the same two fields.
hashCode() - Method in class org.jwcarman.codec.TypeRef
hex() - Static method in class org.jwcarman.codec.transform.encoding.Base32Codec: The "extended hex" alphabet (0-9A-V) with = padding, whose encoded form sorts in the same order as the bytes it encodes — useful for sortable keys.
HexCodec - Class in org.jwcarman.codec.transform.encoding: A byte-to-text-safe-byte transform using hexadecimal (RFC 4648 base16): two ASCII digits per input byte.
highCompression() - Static method in class org.jwcarman.codec.lz4.Lz4Codec: Creates a codec using the LZ4-HC compressor with the default decoded cap: a better ratio at a slower compression speed, with decompression as fast as ever.
highCompression(long) - Static method in class org.jwcarman.codec.lz4.Lz4Codec: Creates a codec using the LZ4-HC compressor with the given decoded-size cap.

I

InvalidPayloadException - Exception Class in org.jwcarman.codec: The payload handed to Codec.decode(byte[]) is malformed, corrupt, or forged: bad framing, truncation, an authentication-tag or checksum mismatch, text outside an encoding's alphabet, a corrupt compressed stream, a payload that would expand past a size cap, or one that decodes to a type this codec does not produce.
InvalidPayloadException(String) - Constructor for exception class org.jwcarman.codec.InvalidPayloadException: Creates the exception.
InvalidPayloadException(String, Throwable) - Constructor for exception class org.jwcarman.codec.InvalidPayloadException: Creates the exception with the underlying failure as the cause.
InvalidValueException - Exception Class in org.jwcarman.codec: The value handed to Codec.encode(T) cannot be encoded: a type the backend has no serializer for, a cyclic object graph, a class the backend requires to be registered and is not.
InvalidValueException(String) - Constructor for exception class org.jwcarman.codec.InvalidValueException: Creates the exception.
InvalidValueException(String, Throwable) - Constructor for exception class org.jwcarman.codec.InvalidValueException: Creates the exception with the backend's failure as the cause.
isEnabled() - Method in class org.jwcarman.codec.autoconfigure.CodecRedisCacheProperties: Whether codec serializes Redis cache values.

J

Jackson2CodecAutoConfiguration - Class in org.jwcarman.codec.autoconfigure: Auto-configures a Jackson2CodecFactory when the Jackson 2.x backend is on the classpath and no other CodecFactory bean exists.
Jackson2CodecAutoConfiguration() - Constructor for class org.jwcarman.codec.autoconfigure.Jackson2CodecAutoConfiguration: Creates the auto-configuration.
jackson2CodecFactory(ObjectProvider) - Method in class org.jwcarman.codec.autoconfigure.Jackson2CodecAutoConfiguration: Creates the factory, reusing the application's Jackson 2.x ObjectMapper bean when one exists.
Jackson2CodecFactory - Class in org.jwcarman.codec.jackson2: Produces JSON codecs backed by a shared Jackson 2.x ObjectMapper.
Jackson2CodecFactory(ObjectMapper) - Constructor for class org.jwcarman.codec.jackson2.Jackson2CodecFactory: Creates a factory that uses the given mapper for all codecs it produces.
JacksonCodecAutoConfiguration - Class in org.jwcarman.codec.autoconfigure: Auto-configures a JacksonCodecFactory when the Jackson 3.x backend is on the classpath and no other CodecFactory bean exists.
JacksonCodecAutoConfiguration() - Constructor for class org.jwcarman.codec.autoconfigure.JacksonCodecAutoConfiguration: Creates the auto-configuration.
jacksonCodecFactory(ObjectProvider) - Method in class org.jwcarman.codec.autoconfigure.JacksonCodecAutoConfiguration: Creates the factory, reusing the application's ObjectMapper bean when one exists.
JacksonCodecFactory - Class in org.jwcarman.codec.jackson: Produces JSON codecs backed by a shared Jackson 3.x ObjectMapper.
JacksonCodecFactory(ObjectMapper) - Constructor for class org.jwcarman.codec.jackson.JacksonCodecFactory: Creates a factory that uses the given mapper for all codecs it produces.
JceDataKeyProvider - Class in org.jwcarman.codec.crypto: In-process DataKeyProvider for consumers without a KMS, backed by one or more key-encryption keys (KEKs) supplied at construction.
JceDataKeyProvider(String, Map) - Constructor for class org.jwcarman.codec.crypto.JceDataKeyProvider: Creates a provider using a default SecureRandom instance.
JceDataKeyProvider(String, Map, SecureRandom) - Constructor for class org.jwcarman.codec.crypto.JceDataKeyProvider: Creates a provider using the given SecureRandom for data-key generation.
JceDataKeyProvider.Builder - Class in org.jwcarman.codec.crypto: Builder for JceDataKeyProvider.
JsonbCodecAutoConfiguration - Class in org.jwcarman.codec.autoconfigure: Registers a JsonbCodecFactory when the JSON-B backend and API are on the classpath and no other backend has claimed the CodecFactory slot.
JsonbCodecAutoConfiguration() - Constructor for class org.jwcarman.codec.autoconfigure.JsonbCodecAutoConfiguration: Creates the auto-configuration.
jsonbCodecFactory(ObjectProvider) - Method in class org.jwcarman.codec.autoconfigure.JsonbCodecAutoConfiguration: Creates the factory, reusing the application's Jsonb bean when one exists.
JsonbCodecFactory - Class in org.jwcarman.codec.jsonb: A CodecFactory backed by Jakarta JSON Binding (JSON-B).
JsonbCodecFactory(Jsonb) - Constructor for class org.jwcarman.codec.jsonb.JsonbCodecFactory: Creates a factory over the given JSON-B instance.

K

key() - Method in record class org.jwcarman.codec.crypto.DataKey: Returns the value of the key record component.
KeyAccessException - Exception Class in org.jwcarman.codec.crypto: Exception indicating that key infrastructure is unavailable.
KeyAccessException(String) - Constructor for exception class org.jwcarman.codec.crypto.KeyAccessException: Creates a key-infrastructure failure that has no underlying exception: the provider returned normally, but what it returned violates the DataKeyProvider contract.
KeyAccessException(String, Throwable) - Constructor for exception class org.jwcarman.codec.crypto.KeyAccessException: Creates a key-infrastructure availability failure.
keyId() - Method in record class org.jwcarman.codec.crypto.DataKey: Returns the value of the keyId record component.
KeyIds are not secret - Section in class org.jwcarman.codec.crypto.EnvelopeCodec
Key retirement - Section in class org.jwcarman.codec.crypto.BoundedDataKeyStrategy

L

listOf(TypeRef) - Static method in class org.jwcarman.codec.TypeRef: A reference to List<E> built from the reference to E.
lowerCase() - Static method in class org.jwcarman.codec.transform.encoding.HexCodec: Lower-case digits (0-9a-f), the usual convention in Java and most tooling.
Lz4Codec - Class in org.jwcarman.codec.lz4: LZ4 compression as a Codec<byte[]> transform, for use with Codec.andThen.
Lz4Codec() - Constructor for class org.jwcarman.codec.lz4.Lz4Codec: Creates a codec using the fast compressor with the default decoded cap.
Lz4Codec(long) - Constructor for class org.jwcarman.codec.lz4.Lz4Codec: Creates a codec using the fast compressor with the given decoded-size cap.

M

mapOf(TypeRef, TypeRef) - Static method in class org.jwcarman.codec.TypeRef: A reference to Map<K, V> built from the references to K and V.
mime() - Static method in class org.jwcarman.codec.transform.encoding.Base64Codec: The MIME variant: the basic alphabet with output wrapped at 76 characters using CRLF line separators, as used in email bodies.

N

newDataKey() - Method in interface org.jwcarman.codec.crypto.DataKeyProvider: Generates a fresh data-encryption key and returns it wrapped under this provider's current key-encryption key.
newDataKey() - Method in class org.jwcarman.codec.crypto.JceDataKeyProvider
nullSafe() - Method in interface org.jwcarman.codec.Codec: Wraps this codec so that null passes straight through in both directions: encode(null) returns null and decode(null) returns null, without consulting this codec.

O

of(Class...) - Static method in class org.jwcarman.codec.fory.ForyCodecFactory: Creates a factory over a new thread-safe Fory instance, in Java mode with class registration required, unknown-class deserialization disabled, and Fory's other defaults unchanged, with the given classes registered.
of(Class) - Static method in class org.jwcarman.codec.TypeRef: Creates a type reference for a non-generic class.
of(String) - Static method in class org.jwcarman.codec.transform.encoding.Base32Codec: A strict codec over alphabet with no padding.
of(String, char) - Static method in class org.jwcarman.codec.transform.encoding.Base32Codec: A strict codec over alphabet, padding the output to a whole group of eight symbols with pad.
of(Charset) - Static method in class org.jwcarman.codec.transform.text.StringCodec: Any charset.
of(Codec) - Static method in class org.jwcarman.codec.redis.CodecRedisSerializer: Adapts a codec whose value type is not known statically; CodecRedisSerializer.getTargetType() reports Object.
of(Codec, Class) - Static method in class org.jwcarman.codec.redis.CodecRedisSerializer: Adapts a codec for a known value type, which Spring Data consults through CodecRedisSerializer.getTargetType() and RedisSerializer.canSerialize(Class).
of(CodecFactory, Class) - Static method in class org.jwcarman.codec.redis.CodecRedisSerializer: Creates a codec for the type from the factory and adapts it.
One provider per cached key - Section in class org.jwcarman.codec.crypto.BoundedDataKeyStrategy
optionalOf(TypeRef) - Static method in class org.jwcarman.codec.TypeRef: A reference to Optional<E> built from the reference to E.
Ordering with compression - Section in class org.jwcarman.codec.crypto.EnvelopeCodec
org.jwcarman.codec - package org.jwcarman.codec: The Codec API — the entire contract of codec-core: Codec encodes and decodes one type, CodecFactory produces codecs for any type, and TypeRef captures parameterized types so generics survive erasure.
org.jwcarman.codec.autoconfigure - package org.jwcarman.codec.autoconfigure: Spring Boot auto-configuration for the backends.
org.jwcarman.codec.crypto - package org.jwcarman.codec.crypto: Envelope encryption as a Codec<byte[]> transform: AES-256-GCM over a per-message data key that is itself wrapped by a key-encryption key reached through the DataKeyProvider SPI (in-process JCE or a remote KMS).
org.jwcarman.codec.fory - package org.jwcarman.codec.fory: Apache Fory backend: fast JVM-only binary serialization with mandatory class registration.
org.jwcarman.codec.gson - package org.jwcarman.codec.gson: Gson backend: a CodecFactory over any Gson instance; generics pass through as Gson TypeTokens.
org.jwcarman.codec.jackson - package org.jwcarman.codec.jackson: Jackson 3.x (tools.jackson) backend: a CodecFactory over any ObjectMapper, which makes every Jackson dataformat — CBOR, Smile, YAML, XML — a backend by mapper swap.
org.jwcarman.codec.jackson2 - package org.jwcarman.codec.jackson2: Jackson 2.x (com.fasterxml.jackson) backend: a CodecFactory over any ObjectMapper, which makes every Jackson 2 dataformat — CBOR, Smile, YAML, XML — a backend by mapper swap.
org.jwcarman.codec.jsonb - package org.jwcarman.codec.jsonb: Jakarta JSON Binding (JSON-B) backend: a CodecFactory over any Jsonb instance.
org.jwcarman.codec.kafka - package org.jwcarman.codec.kafka: Apache Kafka integration: CodecSerializer, CodecDeserializer and CodecSerde adapt any Codec<T> to the Kafka client serialization interfaces, for producers, consumers and Kafka Streams.
org.jwcarman.codec.lz4 - package org.jwcarman.codec.lz4: LZ4 frame-format compression as a Codec<byte[]> transform, backed by lz4-java.
org.jwcarman.codec.protobuf - package org.jwcarman.codec.protobuf: Protocol Buffers backend: codecs for generated GeneratedMessage types, resolved through each message's static parser.
org.jwcarman.codec.redis - package org.jwcarman.codec.redis: Spring Data Redis integration: CodecRedisSerializer adapts any Codec<T> to RedisSerializer<T> for RedisTemplate and, through its serialization pair, for the Redis cache abstraction.
org.jwcarman.codec.transform.checksum - package org.jwcarman.codec.transform.checksum: Corruption detection: a Codec<byte[]> stage that appends a checksum on encode and verifies it on decode.
org.jwcarman.codec.transform.compress - package org.jwcarman.codec.transform.compress: Compression transforms: Codec<byte[]> stages that shrink a payload on the way out and inflate it on the way back, for use with Codec.andThen.
org.jwcarman.codec.transform.encoding - package org.jwcarman.codec.transform.encoding: Text-safe encodings: Codec<byte[]> stages whose output is ASCII-only bytes, for payloads that must live in text columns, JSON strings, URLs or configuration.
org.jwcarman.codec.transform.text - package org.jwcarman.codec.transform.text: Text as bytes: the Codec<String> that turns a string into its encoded bytes and back, for payloads that already are text and as a backend-free base for Codec.xmap.
org.jwcarman.codec.versioned - package org.jwcarman.codec.versioned: Format versioning for codecs: a magic-and-version header that lets an application change its storage strategy without rewriting what it has already stored.
org.jwcarman.codec.zstd - package org.jwcarman.codec.zstd: Zstandard compression as a Codec<byte[]> transform, backed by zstd-jni.

P

parameterized(Class, TypeRef...) - Static method in class org.jwcarman.codec.TypeRef: A reference to any generic class applied to the given type arguments — your own Envelope<O> built from a TypeRef<O>, for example.
ProtobufCodecAutoConfiguration - Class in org.jwcarman.codec.autoconfigure: Auto-configures a ProtobufCodecFactory when the Protocol Buffers backend is on the classpath and no other CodecFactory bean exists.
ProtobufCodecAutoConfiguration() - Constructor for class org.jwcarman.codec.autoconfigure.ProtobufCodecAutoConfiguration: Creates the auto-configuration.
protobufCodecFactory() - Method in class org.jwcarman.codec.autoconfigure.ProtobufCodecAutoConfiguration: Creates the factory.
ProtobufCodecFactory - Class in org.jwcarman.codec.protobuf: Produces codecs for Protocol Buffers messages (GeneratedMessage subclasses), using each message type's own Parser.
ProtobufCodecFactory() - Constructor for class org.jwcarman.codec.protobuf.ProtobufCodecFactory: Creates the factory.
provider(Provider) - Method in class org.jwcarman.codec.crypto.EnvelopeCodec.Builder: Sets the Provider used to look up the AES/GCM/NoPadding Cipher for every encode and decode, so a FIPS-validated or otherwise pinned provider can be selected per codec instead of being installed as the JVM's globally highest-priority provider.
provider(Provider) - Method in class org.jwcarman.codec.crypto.JceDataKeyProvider.Builder: Sets the Provider used to look up the AES/KW/NoPadding Cipher for wrapping and unwrapping data keys, so a FIPS-validated or otherwise pinned provider can be selected per provider instance instead of being installed as the JVM's globally highest-priority provider.

R

rawClass() - Method in class org.jwcarman.codec.TypeRef: Returns the erased class of the captured type: List.class for List<String>, the class itself for a non-generic type.

S

secureRandom(SecureRandom) - Method in class org.jwcarman.codec.crypto.EnvelopeCodec.Builder

Sets the source of randomness used to generate nonces.

secureRandom(SecureRandom) - Method in class org.jwcarman.codec.crypto.JceDataKeyProvider.Builder

Sets the source of randomness used to generate data keys.

Security contract (normative) - Section in interface org.jwcarman.codec.crypto.DataKeyProvider

serializationPair() - Method in class org.jwcarman.codec.redis.CodecRedisSerializer

This serializer as the RedisSerializationContext.SerializationPair the cache abstraction expects:

RedisCacheConfiguration.defaultCacheConfig()
    .serializeValuesWith(CodecRedisSerializer.of(factory, Person.class).serializationPair());

serialize(String, T) - Method in class org.jwcarman.codec.kafka.CodecSerializer

serialize(T) - Method in class org.jwcarman.codec.redis.CodecRedisSerializer

serializer() - Method in class org.jwcarman.codec.kafka.CodecSerde

setCaches(Map) - Method in class org.jwcarman.codec.autoconfigure.CodecRedisCacheProperties

Sets the cache name to value type mapping.

setDefaultType(String) - Method in class org.jwcarman.codec.autoconfigure.CodecRedisCacheProperties

Sets the value type for caches not listed under CodecRedisCacheProperties.getCaches().

setEnabled(boolean) - Method in class org.jwcarman.codec.autoconfigure.CodecRedisCacheProperties

Sets whether codec serializes Redis cache values.

setOf(TypeRef) - Static method in class org.jwcarman.codec.TypeRef

A reference to Set<E> built from the reference to E.

standard() - Static method in class org.jwcarman.codec.transform.encoding.Base32Codec

The standard alphabet (A-Z2-7) with = padding, used by TOTP secrets and most Base32 consumers.

strategy(DataKeyStrategy) - Method in class org.jwcarman.codec.crypto.EnvelopeCodec.Builder

Sets the strategy used to acquire the data key for each message.

StringCodec - Class in org.jwcarman.codec.transform.text

A Codec<String> whose bytes are simply the text in a charset — no quoting, no framing.

supports(Class) - Method in class org.jwcarman.codec.fory.ForyCodecFactory

Reports whether this factory's Fory instance will serialize values of the given class.

T

Thread-safety - Section in interface org.jwcarman.codec.crypto.DataKeyProvider
toString() - Method in record class org.jwcarman.codec.crypto.DataKey: Returns a string containing DataKey.keyId() and the length of DataKey.wrapped(), never key material.
toString() - Method in class org.jwcarman.codec.TypeRef
TransientCodecException - Exception Class in org.jwcarman.codec: Something the codec depends on failed, and the input is not at fault: a key-management service timed out or throttled, a JCE provider cannot supply a transform, a compressor failed on valid input, or a provider returned something that violates its contract.
TransientCodecException(String) - Constructor for exception class org.jwcarman.codec.TransientCodecException: Creates the exception.
TransientCodecException(String, Throwable) - Constructor for exception class org.jwcarman.codec.TransientCodecException: Creates the exception with the dependency's failure as the cause.
TypeRef<T> - Class in org.jwcarman.codec: Super type token capturing a full generic type at compile time, surviving erasure.
TypeRef() - Constructor for class org.jwcarman.codec.TypeRef: Captures the type argument supplied by the subclass.

U

UnknownVersionException - Exception Class in org.jwcarman.codec.versioned: Signals that a payload carries valid versioned framing but names a version this codec has no codec registered for.
UnknownVersionException(int) - Constructor for exception class org.jwcarman.codec.versioned.UnknownVersionException: Creates an exception naming the version that could not be dispatched.
UnsupportedFormatException - Exception Class in org.jwcarman.codec: The payload handed to Codec.decode(byte[]) is well-formed, but names a format this reader cannot handle: a version or an algorithm identifier this instance was not built to understand — typically because a newer writer produced it.
UnsupportedFormatException(String) - Constructor for exception class org.jwcarman.codec.UnsupportedFormatException: Creates the exception.
UnsupportedFormatException(String, Throwable) - Constructor for exception class org.jwcarman.codec.UnsupportedFormatException: Creates the exception with an underlying cause.
unwrap(String, byte[]) - Method in interface org.jwcarman.codec.crypto.DataKeyProvider: Recovers the plaintext data-encryption key from its wrapped form.
unwrap(String, byte[]) - Method in class org.jwcarman.codec.crypto.JceDataKeyProvider
upperCase() - Static method in class org.jwcarman.codec.transform.encoding.HexCodec: Upper-case digits (0-9A-F), the form RFC 4648 uses in its examples.
urlSafe() - Static method in class org.jwcarman.codec.transform.encoding.Base64Codec: The URL- and filename-safe alphabet (A-Za-z0-9-_) with padding.
urlSafeWithoutPadding() - Static method in class org.jwcarman.codec.transform.encoding.Base64Codec: The URL- and filename-safe alphabet without padding — the form most often wanted for tokens and query-string values.
utf8() - Static method in class org.jwcarman.codec.transform.text.StringCodec: UTF-8, the right choice unless an external system dictates otherwise.

V

version() - Method in exception class org.jwcarman.codec.versioned.UnknownVersionException: Returns the unrecognized format version read from the payload.
version(int, Codec) - Method in class org.jwcarman.codec.versioned.VersionedCodec.Builder: Registers the codec that reads (and, if named by VersionedCodec.Builder.writing(int), writes) a version.
VersionedCodec - Class in org.jwcarman.codec.versioned: Prefixes every payload with a small self-describing header naming the codec that produced it, and dispatches on that header when decoding — so an application can change its storage strategy without rewriting what it has already stored.
VersionedCodec.Builder<T> - Class in org.jwcarman.codec.versioned: Collects the per-version codecs and the version to write, and validates them.
VersionedFormatException - Exception Class in org.jwcarman.codec.versioned: Signals that a buffer handed to a versioned codec is not a well-formed versioned payload: it is shorter than the three-byte header, or it does not carry the versioned magic.
VersionedFormatException(String) - Constructor for exception class org.jwcarman.codec.versioned.VersionedFormatException: Creates an exception with the given message.
VM snapshot / clone caveat - Section in class org.jwcarman.codec.crypto.BoundedDataKeyStrategy

W

Wire format - Section in class org.jwcarman.codec.crypto.EnvelopeCodec
wrapped() - Method in record class org.jwcarman.codec.crypto.DataKey: Returns the wrapped form of DataKey.key().
writing(int) - Method in class org.jwcarman.codec.versioned.VersionedCodec.Builder: Names the version Codec.encode(T) writes.

X

xmap(Function, Function) - Method in interface org.jwcarman.codec.Codec: Derives a codec for another type from this one, given a conversion in each direction.

Z

zBase32() - Static method in class org.jwcarman.codec.transform.encoding.Base32Codec: z-base-32 (ybndrfg8ejkmcpqxot1uwisza345h769), the alphabet chosen for ease of handwriting and reading aloud, as used by Tahoe-LAFS and Phil Zimmermann's ZRTP: lower case, no padding, strict decoding.
ZstdCodec - Class in org.jwcarman.codec.zstd: Zstandard (RFC 8878) compression as a Codec<byte[]> transform, for use with Codec.andThen.
ZstdCodec() - Constructor for class org.jwcarman.codec.zstd.ZstdCodec: Creates a codec at the library's default compression level with the default decoded cap.
ZstdCodec(int) - Constructor for class org.jwcarman.codec.zstd.ZstdCodec: Creates a codec at the given compression level with the default decoded cap.
ZstdCodec(int, long) - Constructor for class org.jwcarman.codec.zstd.ZstdCodec: Creates a codec at the given compression level and decoded-size cap.

A B C D E F G H I J K L M N O P R S T U V W X Z
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form