[java-identity-provider COMMIT] in /trunk/idp-authn-api/src/main/java/net/shibboleth/idp/authn/context: Authenticatio...

[noreply at shibboleth.net]

Author: scantor
Date: Tue Mar 29 14:25:19 2016
New Revision: 8188

URL: http://svn.shibboleth.net/view/java-identity-provider?rev=8188&view=rev
Log:
Javadoc improvements.

Modified:
    trunk/idp-authn-api/src/main/java/net/shibboleth/idp/authn/context/AuthenticationContext.java
    trunk/idp-authn-api/src/main/java/net/shibboleth/idp/authn/context/AuthenticationErrorContext.java
    trunk/idp-authn-api/src/main/java/net/shibboleth/idp/authn/context/AuthenticationWarningContext.java
    trunk/idp-authn-api/src/main/java/net/shibboleth/idp/authn/context/CertificateContext.java
    trunk/idp-authn-api/src/main/java/net/shibboleth/idp/authn/context/ExternalAuthenticationContext.java
    trunk/idp-authn-api/src/main/java/net/shibboleth/idp/authn/context/KerberosTicketContext.java
    trunk/idp-authn-api/src/main/java/net/shibboleth/idp/authn/context/LDAPResponseContext.java
    trunk/idp-authn-api/src/main/java/net/shibboleth/idp/authn/context/RequestedPrincipalContext.java
    trunk/idp-authn-api/src/main/java/net/shibboleth/idp/authn/context/SubjectCanonicalizationContext.java
    trunk/idp-authn-api/src/main/java/net/shibboleth/idp/authn/context/SubjectContext.java
    trunk/idp-authn-api/src/main/java/net/shibboleth/idp/authn/context/UserAgentContext.java
    trunk/idp-authn-api/src/main/java/net/shibboleth/idp/authn/context/UsernameContext.java
    trunk/idp-authn-api/src/main/java/net/shibboleth/idp/authn/context/UsernamePasswordContext.java

Modified: trunk/idp-authn-api/src/main/java/net/shibboleth/idp/authn/context/AuthenticationContext.java
URL: http://svn.shibboleth.net/view/java-identity-provider/trunk/idp-authn-api/src/main/java/net/shibboleth/idp/authn/context/AuthenticationContext.java?rev=8188&r1=8187&r2=8188&view=diff
==============================================================================
--- trunk/idp-authn-api/src/main/java/net/shibboleth/idp/authn/context/AuthenticationContext.java	(original)
+++ trunk/idp-authn-api/src/main/java/net/shibboleth/idp/authn/context/AuthenticationContext.java	Tue Mar 29 14:25:19 2016
@@ -33,6 +33,7 @@
 import net.shibboleth.utilities.java.support.annotation.constraint.Live;
 import net.shibboleth.utilities.java.support.annotation.constraint.NonNegative;
 import net.shibboleth.utilities.java.support.annotation.constraint.NonnullElements;
+import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
 import net.shibboleth.utilities.java.support.annotation.constraint.Positive;
 import net.shibboleth.utilities.java.support.logic.Constraint;
 import net.shibboleth.utilities.java.support.primitive.StringSupport;
@@ -47,6 +48,13 @@
  * input/output context for the action flow responsible for authentication, and
  * within that flow, the individual flows that carry out a specific kind of
  * authentication.
+ * 
+ * @parent {@link org.opensaml.profile.context.ProfileRequestContext}
+ * @child {@link RequestedPrincipalContext}, {@link net.shibboleth.idp.attribute.context.AttributeContext},
+ *  {@link UsernameContext}, {@link UsernamePasswordContext}, {@link UserAgentContext}, {@link CertificateContext},
+ *  {@link ExternalAuthenticationContext}, {@link KerberosTicketContext}, {@link LDAPResponseContext},
+ *  {@link AuthenticationErrorContext}, {@link AuthenticationWarningContext}
+ * @added Before authentication flow runs
  */
 public final class AuthenticationContext extends BaseContext {
 
@@ -122,7 +130,10 @@
     }
 
     /**
-     * Get the authentication results currently active for the subject.
+     * Get previous authentication results currently active for the subject.
+     * 
+     * <p>These should be used to identify SSO opportunities. Results produced during a particular
+     * authentication run should not be included in this collection.</p>
      * 
      * @return authentication results currently active for the subject
      */
@@ -152,6 +163,9 @@
     /**
      * Get the set of flows that could potentially be used for user authentication.
      * 
+     * <p>Authentication flows supplied by the configuration and gradually filtered down to
+     * a collection that can be used to authenticate the subject.</p>
+     * 
      * @return the potential flows
      */
     @Nonnull @NonnullElements @Live public Map<String,AuthenticationFlowDescriptor> getPotentialFlows() {
@@ -162,6 +176,9 @@
     /**
      * Get the set of flows that have been executed, successfully or otherwise, without producing a completed result.
      * 
+     * <p>This tracks flows that have already been run to avoid unintentional repeated attempts to run the same
+     * flow.</p>
+     * 
      * @return the intermediately executed flows
      */
     @Nonnull @NonnullElements @Live public Map<String,AuthenticationFlowDescriptor> getIntermediateFlows() {
@@ -172,7 +189,7 @@
      * Get the registry of predicate factories for custom principal evaluation.
      * 
      * <p>This object is only needed when evaluating a {@link RequestedPrincipalContext}, so the
-     * presence of it at this level of the tree is historical.

[... 574 lines stripped ...]