Skip to content

docs: document the Jackson compression max-decompressed-size limit - #3597

Merged
He-Pin merged 1 commit into
apache:mainfrom
pjfanning:docs-jackson-max-decompressed-size
Oct 9, 2026
Merged

He-Pin merged 1 commit into
apache:mainfrom
pjfanning:docs-jackson-max-decompressed-size

Conversation

@pjfanning

Copy link
Copy Markdown
Member

Motivation

The Compression section of serialization-jackson.md does not mention
compression.max-decompressed-size, which bounds how large a compressed
payload may become when it is decompressed during deserialization.

Modification

Describe the setting: default unlimited (negative values also mean
unlimited), applies to gzip and lz4 payloads regardless of the
algorithm setting, can be set for all bindings or per binding, rejects
oversized payloads with an IllegalArgumentException, exists under
pekko.serialization.jackson3 too, and is separate from
pekko.serialization.max-decompressed-size, which does not apply to the
Jackson serializers.

Result

Users can find and configure the decompression limit for the Jackson
serializers.

Tests

  • Not run - docs only

References

None - found during a review of the docs; checked against the
serialization-jackson and serialization-jackson3 reference.conf and
JacksonSerializer

Motivation:
The Compression section of serialization-jackson.md does not mention
compression.max-decompressed-size, which bounds how large a compressed
payload may become when it is decompressed during deserialization.

Modification:
Describe the setting: default unlimited (negative values also mean
unlimited), applies to gzip and lz4 payloads regardless of the
algorithm setting, can be set for all bindings or per binding, rejects
oversized payloads with an IllegalArgumentException, exists under
pekko.serialization.jackson3 too, and is separate from
pekko.serialization.max-decompressed-size, which does not apply to the
Jackson serializers.

Result:
Users can find and configure the decompression limit for the Jackson
serializers.

Tests:
- Not run - docs only

References:
None - found during a review of the docs; checked against the
serialization-jackson and serialization-jackson3 reference.conf and
JacksonSerializer
@pjfanning pjfanning added this to the 2.0.0-M5 milestone Oct 8, 2026

@He-Pin He-Pin left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@He-Pin
He-Pin merged commit 0caf3de into apache:main Oct 9, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants