From d479c8ed4519038d06f25dba97689a031f8b8acb Mon Sep 17 00:00:00 2001 From: Karen Miller Date: Tue, 12 Jan 2021 11:51:36 -0800 Subject: [PATCH] GEODE-8826: State that post processor callback receives a reference --- 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 1275832a6471..c2ccc68f4016 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. +