Skip to content

Add ZCCS config properties [DOC-768] #2265

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mscwilson wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add ZCCS config properties [DOC-768] #2265

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions docs/modules/ROOT/pages/system-properties.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1036,6 +1036,41 @@ of setting a result size limit.
|string
|When set to any non-null value, security recommendations are logged at the `INFO` level during the member startup.

|`hazelcast.serialization.compact.allowlist.classes`
|
|string
|Comma-separated list of fully qualified class names to allow for xref:serialization:compact-serialization.adoc[zero-config Compact serialization] (ZCCS). If set, only classes on this list (and not on the blocklist) are eligible for ZCCS. Default is empty.

@k-jamroz k-jamroz Jul 24, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

these properties are available in 5.7 onwards (TBD if we remove them in 6.0) only to allow easier upgrade from <5.7 versions with hardened config.
from 5.7 onwards zero-config-filter XML/YAML config should be recommended


|`hazelcast.serialization.compact.allowlist.packages`
|
|string
|Comma-separated list of package names to allow for ZCCS. Only classes in the exact package (not sub-packages) are matched.

|`hazelcast.serialization.compact.allowlist.prefixes`
|
|string
|Comma-separated list of class-name prefixes to allow for ZCCS.

|`hazelcast.serialization.compact.blocklist.classes`
|
|string
|Comma-separated list of fully qualified class names to block from ZCCS. Default is empty.

|`hazelcast.serialization.compact.blocklist.defaults`
|true
|bool
|Controls whether the default blocklist of known-problematic classes is applied for ZCCS.

@k-jamroz k-jamroz Jul 24, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

unfortunately this property is defaults not defaultsDisabled (like elsewhere) which is different that in config and possible source of mistakes. IMO worth highlighting this fact


|`hazelcast.serialization.compact.blocklist.packages`
|
|string
|Comma-separated list of package names to block from ZCCS. Only classes in the exact package (not sub-packages) are matched.

|`hazelcast.serialization.compact.blocklist.prefixes`
|
|string
|Comma-separated list of class-name prefixes to block from ZCCS.

|`hazelcast.serialization.version`
|
|long
Expand Down