[sling-site] branch master updated: clarify authentication info for JcrResourceProvider

[kw...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

kwin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-site.git


The following commit(s) were added to refs/heads/master by this push:
     new 66d9662  clarify authentication info for JcrResourceProvider
66d9662 is described below

commit 66d96623450d1145af021fd914411b36dcded004
Author: Konrad Windszus <kw...@apache.org>
AuthorDate: Tue Jul 9 09:10:59 2019 +0200

    clarify authentication info for JcrResourceProvider
---
 .../jbake/content/documentation/the-sling-engine/resources.md    | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/main/jbake/content/documentation/the-sling-engine/resources.md b/src/main/jbake/content/documentation/the-sling-engine/resources.md
index bfebeb7..85ce6b1 100644
--- a/src/main/jbake/content/documentation/the-sling-engine/resources.md
+++ b/src/main/jbake/content/documentation/the-sling-engine/resources.md
@@ -114,6 +114,15 @@ When accessing a Resource with path `/some/path/resource` the Resource provider
 
 JCR-based Resources are provided with the default `JcrResourceProvider`. This Resource provider is always available and is always asked last. That is Resources provided by other Resource providers may never be overruled by repository based Resources.
 
+These are the authenticationInfo keys (which can be used with [`ResourceResolverFactory.getResourceResolver(java.util.Map authenticationInfo)`](https://sling.apache.org/apidocs/sling11/org/apache/sling/api/resource/ResourceResolverFactory.html#getResourceResolver-java.util.Map-)) which are supported by the `JcrResourceProvider`:
+
+| AuthenticationInfo Key | Type | Description |
+| --- | --- | --- | --- |
+| `user.jcr.session` | `javax.jcr.Session` | The session which is used for the underlying repository access. When calling `close()` on the returned `ResourceResolver` the session will not(!) be closed. |
+| `user.jcr.credentials` | `javax.jcr.Credentials` | The credentials object from which to create the new underlying JCR session
+| `user.name` | String | Optionally used with `user.password` to create simple credentials from which the Session is being created.
+| `user.impersonation` | String | User ID which should be used for impersonation via `javax.jcr.Session.impersonate(...)`. Must be combined with one of the other authentication info keys.
+
 ### Bundle-based Resources
 
 Resources may by provided by OSGi bundles. Providing bundles have a Bundle manifest header `Sling-Bundle-Resources` containing a list of absolute paths provided by the bundle. The path are separated by comma or whitespace (SP, TAB, VTAB, CR, LF).