Skip to content

Commit

Permalink
GEODE-8826: State that post processor callback receives a reference (a…
Browse files Browse the repository at this point in the history
…pache#5895)

Co-authored-by: Karen Miller <[email protected]>
  • Loading branch information
karensmolermiller and Karen Miller authored Jan 13, 2021
1 parent 9079e40 commit 34137ac
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion geode-docs/managing/security/post_processing.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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,
Expand Down

0 comments on commit 34137ac

Please sign in to comment.