[java-identity-provider] 02/02: Cleanup Javadoc

[Rod Widdowson]

This is an automated email from the git hooks/post-receive script.

rdw pushed a commit to branch master
in repository java-identity-provider.

View the commit online:
http://git.shibboleth.net/view/?p=java-identity-provider.git;a=commit;h=85b9b8830244dbb52fde2695f27cc0f0a39a069d

commit 85b9b8830244dbb52fde2695f27cc0f0a39a069d
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Fri Aug 30 14:52:24 2019 +0100

    Cleanup Javadoc
---
 .../idp/attribute/transcoding/TranscodingRule.java         |  5 +++--
 .../idp/attribute/resolver/PluginDependencySupport.java    | 14 +++++++-------
 .../idp/attribute/resolver/MockDataConnector.java          |  8 --------
 .../net/shibboleth/idp/authn/ExternalAuthentication.java   |  1 +
 .../idp/profile/interceptor/ExternalInterceptor.java       |  2 +-
 5 files changed, 12 insertions(+), 18 deletions(-)

diff --git a/idp-attribute-api/src/main/java/net/shibboleth/idp/attribute/transcoding/TranscodingRule.java b/idp-attribute-api/src/main/java/net/shibboleth/idp/attribute/transcoding/TranscodingRule.java
index 073e31d..37026d7 100644
--- a/idp-attribute-api/src/main/java/net/shibboleth/idp/attribute/transcoding/TranscodingRule.java
+++ b/idp-attribute-api/src/main/java/net/shibboleth/idp/attribute/transcoding/TranscodingRule.java
@@ -39,6 +39,7 @@ import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
 import net.shibboleth.utilities.java.support.annotation.constraint.NotLive;
 import net.shibboleth.utilities.java.support.annotation.constraint.Unmodifiable;
 import net.shibboleth.utilities.java.support.primitive.StringSupport;
+import net.shibboleth.idp.attribute.IdPAttribute;
 
 /**
  * Wrapper around a {@link Map} representing a rule for transcoding, used to
@@ -171,7 +172,7 @@ public class TranscodingRule {
     }
     
     /**
-     * Process any properties that start with {@link AttributeTranscoderRegistry.PROP_DISPLAY_NAME} and
+     * Process any properties that start with {@link AttributeTranscoderRegistry#PROP_DISPLAY_NAME} and
      * create a Locale map around them.
      */
     private void processDisplayNames() {
@@ -201,7 +202,7 @@ public class TranscodingRule {
     }
 
     /**
-     * Process any properties that start with {@link AttributeTranscoderRegistry.PROP_DESCRIPTION} and
+     * Process any properties that start with {@link AttributeTranscoderRegistry#PROP_DESCRIPTION} and
      * create a Locale map around them.
      */
     private void processDescriptions() {
diff --git a/idp-attribute-resolver-api/src/main/java/net/shibboleth/idp/attribute/resolver/PluginDependencySupport.java b/idp-attribute-resolver-api/src/main/java/net/shibboleth/idp/attribute/resolver/PluginDependencySupport.java
index 01c5a6c..8f6cef0 100644
--- a/idp-attribute-resolver-api/src/main/java/net/shibboleth/idp/attribute/resolver/PluginDependencySupport.java
+++ b/idp-attribute-resolver-api/src/main/java/net/shibboleth/idp/attribute/resolver/PluginDependencySupport.java
@@ -36,7 +36,8 @@ import net.shibboleth.idp.attribute.resolver.context.AttributeResolverWorkContex
 import net.shibboleth.utilities.java.support.annotation.constraint.NonnullElements;
 import net.shibboleth.utilities.java.support.logic.Constraint;
 
-/** Support class for working with {@link ResolverPluginDependency}. */
+/** Support class for working with dependencies both {@link ResolverAttributeDefinitionDependency}
+ * and {@link ResolverDataConnectorDependency}. */
 public final class PluginDependencySupport {
 
     /** Log. */
@@ -48,9 +49,8 @@ public final class PluginDependencySupport {
     }
 
     /**
-     * Gets the values, as a single list, from all dependencies. This method only supports dependencies which contain an
-     * attribute specifier (i.e. {@link ResolverPluginDependency#getDependencyAttributeId()} does not equal null). It is
-     * therefore used inside Attribute definitions which only process a single attribute as input.
+     * Gets the values, as a single list, from all dependencies. It is therefore used inside Attribute 
+     * Definitions which only process a single attribute as input.
      * 
      * <p>
      * <strong>NOTE</strong>, this method does *not* actually trigger any attribute definition or data connector
@@ -119,9 +119,9 @@ public final class PluginDependencySupport {
     /**
      * Gets the values from all dependencies. Attributes, with the same identifier but from different resolver plugins,
      * will have their values merged into a single list within this method's returned map. This method is the equivalent
-     * of calling {@link #getMergedAttributeValues(AttributeResolverWorkContext, Collection)} for all attributes
-     * resolved by all the given dependencies. This is therefore used when an attribute definition may have multiple
-     * input attributes (for instance scripted or templated definitions).
+     * of calling {@link #getMergedAttributeValues(AttributeResolverWorkContext, Collection, Collection, String)} for
+     * all  attributes resolved by all the given dependencies. This is therefore used when an attribute definition may 
+     * have multiple input attributes (for instance scripted or templated definitions).
      * 
      * <p>
      * <strong>NOTE</strong>, this method does *not* actually trigger any attribute definition or data connector
diff --git a/idp-attribute-resolver-api/src/test/java/net/shibboleth/idp/attribute/resolver/MockDataConnector.java b/idp-attribute-resolver-api/src/test/java/net/shibboleth/idp/attribute/resolver/MockDataConnector.java
index 09744f3..8c0c4e3 100644
--- a/idp-attribute-resolver-api/src/test/java/net/shibboleth/idp/attribute/resolver/MockDataConnector.java
+++ b/idp-attribute-resolver-api/src/test/java/net/shibboleth/idp/attribute/resolver/MockDataConnector.java
@@ -57,14 +57,6 @@ public class MockDataConnector extends AbstractDataConnector {
         values = connectorValues;
     }
 
-    /**
-     * Constructor.
-     *
-     * @param id
-     * @param connectorValues
-     * @param newHashSet
-     * @throws ComponentInitializationException 
-     */
     public MockDataConnector(String id, 
             Map<String, IdPAttribute> connectorValues, 
             Set<ResolverAttributeDefinitionDependency> attrDepends, 
diff --git a/idp-authn-api/src/main/java/net/shibboleth/idp/authn/ExternalAuthentication.java b/idp-authn-api/src/main/java/net/shibboleth/idp/authn/ExternalAuthentication.java
index a0814b7..77de137 100644
--- a/idp-authn-api/src/main/java/net/shibboleth/idp/authn/ExternalAuthentication.java
+++ b/idp-authn-api/src/main/java/net/shibboleth/idp/authn/ExternalAuthentication.java
@@ -27,6 +27,7 @@ import org.opensaml.profile.context.ProfileRequestContext;
 
 import com.google.common.net.UrlEscapers;
 
+import net.shibboleth.idp.attribute.IdPAttribute;
 import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
 import net.shibboleth.utilities.java.support.logic.Constraint;
 
diff --git a/idp-profile-api/src/main/java/net/shibboleth/idp/profile/interceptor/ExternalInterceptor.java b/idp-profile-api/src/main/java/net/shibboleth/idp/profile/interceptor/ExternalInterceptor.java
index 4847dcd..e0839ee 100644
--- a/idp-profile-api/src/main/java/net/shibboleth/idp/profile/interceptor/ExternalInterceptor.java
+++ b/idp-profile-api/src/main/java/net/shibboleth/idp/profile/interceptor/ExternalInterceptor.java
@@ -125,7 +125,7 @@ public class ExternalInterceptor {
     /**
      * Get the {@link ProfileRequestContext} associated with a request.
      * 
-     * @param key   the value returned by {@link #startExternalAuthentication(HttpServletRequest)}
+     * @param key   the value returned by {@link #startExternalInterceptor(HttpServletRequest)}
      * @param request servlet request
      * 
      * @return the profile request context

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.