This is an automated email from the ASF dual-hosted git repository.
kmiller pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/geode.git
The following commit(s) were added to refs/heads/develop by this push:
new 34137ac GEODE-8826: State that post processor callback receives a
reference (#5895)
34137ac is described below
commit 34137acb756d7069df27d67f7d615957f051c7c2
Author: Karen Miller <[email protected]>
AuthorDate: Wed Jan 13 09:16:48 2021 -0800
GEODE-8826: State that post processor callback receives a reference (#5895)
Co-authored-by: Karen Miller <[email protected]>
---
geode-docs/managing/security/post_processing.html.md.erb | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/geode-docs/managing/security/post_processing.html.md.erb
b/geode-docs/managing/security/post_processing.html.md.erb
index 1275832..c2ccc68 100644
--- a/geode-docs/managing/security/post_processing.html.md.erb
+++ b/geode-docs/managing/security/post_processing.html.md.erb
@@ -24,7 +24,7 @@ that is invoked after any and all client and `gfsh`
operations that get data,
but before the data is returned.
It permits the callback to intervene and format the data
that is to be returned.
-The callbacks do not modify the region data,
+The callbacks must not modify the region data,
only the data to be returned.
The `processRegionValue` method is given the principal of the
@@ -35,6 +35,11 @@ the requested operation.
The post processing can therefore format the returned data based
on the identity of the requester (principal).
+By default, the key and value parameters to the `processRegionValue` method
+are references to the region entry.
+Modify copies of these parameters to avoid changing the region entries.
+[Copy on Read
Behavior](../../basic_config/data_entries_custom_classes/copy_on_read.html)
discusses the issue.
+
<!-- GEODE-2153 aims to make this possible:
A use of post processing will be to sanitize or mask out sensitive
region information,
