Author: cziegeler
Date: Tue May 5 12:56:10 2015
New Revision: 1677811
URL: http://svn.apache.org/r1677811
Log:
Update javadocs
Modified:
sling/whiteboard/cziegeler/api-v3/src/main/java/org/apache/sling/api/resource/provider/ResourceProvider.java
Modified:
sling/whiteboard/cziegeler/api-v3/src/main/java/org/apache/sling/api/resource/provider/ResourceProvider.java
URL:
http://svn.apache.org/viewvc/sling/whiteboard/cziegeler/api-v3/src/main/java/org/apache/sling/api/resource/provider/ResourceProvider.java?rev=1677811&r1=1677810&r2=1677811&view=diff
==============================================================================
---
sling/whiteboard/cziegeler/api-v3/src/main/java/org/apache/sling/api/resource/provider/ResourceProvider.java
(original)
+++
sling/whiteboard/cziegeler/api-v3/src/main/java/org/apache/sling/api/resource/provider/ResourceProvider.java
Tue May 5 12:56:10 2015
@@ -132,12 +132,16 @@ public abstract class ResourceProvider<T
* The returned context object grants access to the provided resources with
* privileges assigned to the service provided by the calling bundle.
* <p>
+ * The <code>authenticationInfo</code> map will in general contain the same
+ * information as provided to the respective {@link ResourceResolver}
+ * method. For
+ * <p>
* The provided {@code authenticationInfo} map may be used to provide
- * additional information such as the {@value #AUTH_SERVICE_BUNDLE}.
+ * additional information such as the {@link #AUTH_SERVICE_BUNDLE}.
* If this property is provided, additional information like
- * {@link ResourceResolverFactory#SUBSERVICE} might be provided. In this
case
- * {@link #USER} and {@link #PASSWORD} properties provided in the map are
- * ignored.
+ * {@link ResourceResolverFactory#SUBSERVICE} might be provided, but the
+ * {@link #USER} and {@link #PASSWORD} properties provided in the map must
+ * be ignored.
* <p>
* The {@link #USER_IMPERSONATION} property is obeyed but requires that the
* authenticated user has permission to impersonate as the requested user.
@@ -154,6 +158,10 @@ public abstract class ResourceProvider<T
* <code>authenticationInfo</code>.
* @throws LoginException If an error occurs authenticating with the
* provided credential data.
+ *
+ * @see <a
+ *
href="http://sling.apache.org/documentation/the-sling-engine/service-authentication.html";>Service
+ * Authentication</a>
*/
@Nonnull T authenticate(final @Nonnull Map<String, Object>
authenticationInfo)
throws LoginException {
