Index (Codec Parent 0.6.0 API)

A B C D E F G H J K M N O P S T U V W 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
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
andThen(Codec) - Method in interface org.jwcarman.codec.spi.Codec: Layers a byte-level transform (compression, encryption, etc.) onto this codec.

B

Base64Codec - Class in org.jwcarman.codec.transform: 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.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.
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
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.spi: Converts values of type T to and from byte[].
CodecFactory - Interface in org.jwcarman.codec.spi: Produces Codec instances for arbitrary types, backed by a serialization library.
compressing(OutputStream) - Method in class org.jwcarman.codec.transform.CompressionStreamCodec: Wraps the sink in a stream that compresses everything written to it.
compressing(OutputStream) - Method in class org.jwcarman.codec.transform.DeflateCodec
compressing(OutputStream) - Method in class org.jwcarman.codec.transform.GzipCodec
compressing(OutputStream) - Method in class org.jwcarman.codec.zstd.ZstdCodec
CompressionStreamCodec - Class in org.jwcarman.codec.transform: Base class for stream-based compression transforms, intended for use with Codec.andThen(Codec).
CompressionStreamCodec(long) - Constructor for class org.jwcarman.codec.transform.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
create(Class) - Method in interface org.jwcarman.codec.spi.CodecFactory: Creates a codec for a non-generic class.
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
create(TypeRef) - Method in interface org.jwcarman.codec.spi.CodecFactory: Creates a codec for the given type reference, supporting full generic types.
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 class org.jwcarman.codec.crypto.EnvelopeCodec
decode(byte[]) - Method in interface org.jwcarman.codec.spi.Codec: Decodes bytes back into a value.
decode(byte[]) - Method in class org.jwcarman.codec.transform.Base64Codec
decode(byte[]) - Method in class org.jwcarman.codec.transform.CompressionStreamCodec
decompressing(InputStream) - Method in class org.jwcarman.codec.transform.CompressionStreamCodec: Wraps the source in a stream that decompresses everything read from it.
decompressing(InputStream) - Method in class org.jwcarman.codec.transform.DeflateCodec
decompressing(InputStream) - Method in class org.jwcarman.codec.transform.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.CompressionStreamCodec: Default maximum decoded size (64 MiB).
DeflateCodec - Class in org.jwcarman.codec.transform: 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.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.DeflateCodec: Creates a codec with a specific compression level and decoded-size cap.
DeflateCodec(long) - Constructor for class org.jwcarman.codec.transform.DeflateCodec: Creates a codec with the default compression level and a custom decoded-size cap.
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
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.Base64Codec
encode(byte[]) - Method in class org.jwcarman.codec.transform.CompressionStreamCodec
encode(T) - Method in interface org.jwcarman.codec.spi.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.spi.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
foryCodecFactory(ThreadSafeFory) - Method in class org.jwcarman.codec.autoconfigure.ForyCodecAutoConfiguration
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

getType() - Method in class org.jwcarman.codec.spi.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
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: 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.GzipCodec: Creates a codec with the default decoded-size cap of 64 MiB.
GzipCodec(long) - Constructor for class org.jwcarman.codec.transform.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.spi.TypeRef

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
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
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
jsonbCodecFactory(ObjectProvider) - Method in class org.jwcarman.codec.autoconfigure.JsonbCodecAutoConfiguration
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, 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

M

mime() - Static method in class org.jwcarman.codec.transform.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

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, with the given classes registered.
of(Class) - Static method in class org.jwcarman.codec.spi.TypeRef: Creates a type reference for a non-generic class.
Ordering with compression - Section in class org.jwcarman.codec.crypto.EnvelopeCodec
org.jwcarman.codec.autoconfigure - package org.jwcarman.codec.autoconfigure
org.jwcarman.codec.crypto - package org.jwcarman.codec.crypto
org.jwcarman.codec.fory - package org.jwcarman.codec.fory
org.jwcarman.codec.gson - package org.jwcarman.codec.gson
org.jwcarman.codec.jackson - package org.jwcarman.codec.jackson
org.jwcarman.codec.jackson2 - package org.jwcarman.codec.jackson2
org.jwcarman.codec.jsonb - package org.jwcarman.codec.jsonb
org.jwcarman.codec.protobuf - package org.jwcarman.codec.protobuf
org.jwcarman.codec.spi - package org.jwcarman.codec.spi
org.jwcarman.codec.transform - package org.jwcarman.codec.transform
org.jwcarman.codec.zstd - package org.jwcarman.codec.zstd

P

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
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
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 AESWrap 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.

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
strategy(DataKeyStrategy) - Method in class org.jwcarman.codec.crypto.EnvelopeCodec.Builder: Sets the strategy used to acquire the data key for each message.
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.spi.TypeRef
TypeRef<T> - Class in org.jwcarman.codec.spi: Super type token capturing a full generic type at compile time, surviving erasure.
TypeRef() - Constructor for class org.jwcarman.codec.spi.TypeRef: Captures the type argument supplied by the anonymous subclass.

U

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
urlSafe() - Static method in class org.jwcarman.codec.transform.Base64Codec: The URL- and filename-safe alphabet (A-Za-z0-9-_) with padding.
urlSafeWithoutPadding() - Static method in class org.jwcarman.codec.transform.Base64Codec: The URL- and filename-safe alphabet without padding — the form most often wanted for tokens and query-string values.

V

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().

Z

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 J K M N O P S T U V W Z
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form