[sling-org-apache-sling-auth-core] branch master updated: SLING-5448 : AuthenticationInfoPostProcessor javadoc misleading

[cz...@apache.org]

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

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


The following commit(s) were added to refs/heads/master by this push:
     new d694e77  SLING-5448 : AuthenticationInfoPostProcessor javadoc misleading
d694e77 is described below

commit d694e77ed01c3369e4f229ebb899a2e2cf522aa4
Author: Carsten Ziegeler <cz...@apache.org>
AuthorDate: Wed Aug 5 15:29:15 2020 +0200

    SLING-5448 : AuthenticationInfoPostProcessor javadoc misleading
---
 .../auth/core/spi/AuthenticationInfoPostProcessor.java      | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)

diff --git a/src/main/java/org/apache/sling/auth/core/spi/AuthenticationInfoPostProcessor.java b/src/main/java/org/apache/sling/auth/core/spi/AuthenticationInfoPostProcessor.java
index ea1376e..9e1a4e2 100644
--- a/src/main/java/org/apache/sling/auth/core/spi/AuthenticationInfoPostProcessor.java
+++ b/src/main/java/org/apache/sling/auth/core/spi/AuthenticationInfoPostProcessor.java
@@ -24,9 +24,16 @@ import org.apache.sling.api.resource.LoginException;
 import org.osgi.annotation.versioning.ConsumerType;
 
 /**
- * Service interface which allows bundles to modify the AuthenticationInfo object
- * after authentication has been performed.
- *
+ * Service interface which allows bundles to modify the {@code AuthenticationInfo} object
+ * right after one {@code AuthenticationHandler} has returned an {{@code AuthenticationInfo}
+ * from the {@link AuthenticationHandler#extractCredentials(HttpServletRequest, HttpServletResponse)}
+ * method or an anonymous {@code AuthenticationInfo} has been created. This service is called
+ * before the {@code ResourceResolver} is created and any login into the resource providers
+ * (such as a JCR repository or other data store) happens. However, the {@code AuthenticationHandler}
+ * might actually do such a login and pass on the information to the resource provider through
+ * the {@code AuthenticationInfo}.
+ * This service interface is useful to access and modify the {{@code AuthenticationInfo} before
+ * it is passed to the {@code ResourceResolverFactory} to create a {@code ResourceResolver}.
  */
 @ConsumerType
 public interface AuthenticationInfoPostProcessor {