Author: angela
Date: Thu Mar 2 13:25:49 2017
New Revision: 1785128
URL: http://svn.apache.org/viewvc?rev=1785128&view=rev
Log:
minor improvement: update restriction documentation wrt to OAK-5784
Modified:
jackrabbit/oak/trunk/oak-doc/src/site/markdown/security/authorization/restriction.md
Modified:
jackrabbit/oak/trunk/oak-doc/src/site/markdown/security/authorization/restriction.md
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/security/authorization/restriction.md?rev=1785128&r1=1785127&r2=1785128&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-doc/src/site/markdown/security/authorization/restriction.md
(original)
+++
jackrabbit/oak/trunk/oak-doc/src/site/markdown/security/authorization/restriction.md
Thu Mar 2 13:25:49 2017
@@ -179,6 +179,10 @@ implementation:
- implement `RestrictionProvider` interface exposing your custom
restriction(s).
- make the provider implementation an OSGi service and make it available to
the Oak repository.
+Please make sure to consider the following recommendations when implementing a
custom `RestrictionProvider`:
+- restrictions are part of the overall permission evaluation and thus may
heavily impact overall read/write performance
+- the hashCode generation of the base implementation
(`RestrictionImpl.hashCode`) relies on `PropertyStateValue.hashCode`, which
includes the internal String representation, which is not optimal for binaries
(see also [OAK-5784])
+
##### Examples
###### Example RestrictionProvider
@@ -285,3 +289,4 @@ The time-based `RestrictionPattern` used
[RestrictionDefinition]:
/oak/docs/apidocs/org/apache/jackrabbit/oak/spi/security/authorization/restriction/RestrictionDefinition.html
[RestrictionPattern]:
/oak/docs/apidocs/org/apache/jackrabbit/oak/spi/security/authorization/restriction/RestrictionPattern.html
[RestrictionProvider]:
/oak/docs/apidocs/org/apache/jackrabbit/oak/spi/security/authorization/restriction/RestrictionProvider.html
+[OAK-5784]: https://issues.apache.org/jira/browse/OAK-5784
