[java-identity-provider] branch main updated: Javadoc

[Rod Widdowson]

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

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

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

The following commit(s) were added to refs/heads/main by this push:
     new 3128baac0 Javadoc
3128baac0 is described below

commit 3128baac0525ef901c063d6cb67af3aaa8267ede
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Fri Feb 24 15:12:15 2023 +0000

    Javadoc
---
 .../idp/saml/impl/testing/TestSources.java         | 23 +++++++++++++++++++++-
 .../profile/testing/ActionTestSupportAction.java   |  7 +++++++
 2 files changed, 29 insertions(+), 1 deletion(-)

diff --git a/idp-testing/src/main/java/net/shibboleth/idp/saml/impl/testing/TestSources.java b/idp-testing/src/main/java/net/shibboleth/idp/saml/impl/testing/TestSources.java
index 49f5fbede..1c216c8f3 100644
--- a/idp-testing/src/main/java/net/shibboleth/idp/saml/impl/testing/TestSources.java
+++ b/idp-testing/src/main/java/net/shibboleth/idp/saml/impl/testing/TestSources.java
@@ -58,6 +58,7 @@ public final class TestSources {
     /** The name of the attribute we use as source. */
     @Nonnull public static final String DEPENDS_ON_ATTRIBUTE_NAME_ATTR = "at1";
 
+    /** a attribute connector to depend upon. */
     @Nonnull public static final String DEPENDS_ON_ATTRIBUTE_NAME_CONNECTOR = "ac1";
 
     /** The name of another attribute we use as source. */
@@ -90,9 +91,9 @@ public final class TestSources {
             ATTRIBUTE_ATTRIBUTE_VALUE_STRING);
 
     /** Regexp. for CONNECTOR_ATTRIBUTE_VALUE (for map and regexp testing). */
-
     @Nonnull public static final String CONNECTOR_ATTRIBUTE_VALUE_REGEXP = "at1-(.+)or";
 
+    /** a {@Link Pattern} derived from {@link #CONNECTOR_ATTRIBUTE_VALUE_REGEXP}. */
     @SuppressWarnings("null")
     @Nonnull public static final Pattern CONNECTOR_ATTRIBUTE_VALUE_REGEXP_PATTERN = Pattern
             .compile(CONNECTOR_ATTRIBUTE_VALUE_REGEXP);
@@ -109,10 +110,13 @@ public final class TestSources {
     /** Authentication method for Principal method tests */
     @Nonnull public static final String TEST_AUTHN_METHOD = "AuthNmEthod";
 
+    /** {@value #IDP_ENTITY_ID}. */
     @Nonnull public static final String IDP_ENTITY_ID = "https://idp.example.org/idp";
 
+    /** {@value #PRINCIPAL_ID}. */
     @Nonnull public static final String PRINCIPAL_ID = "PETER_THE_PRINCIPAL";
 
+    /** {@value #SP_ENTITY_ID}. */
     @Nonnull public static final String SP_ENTITY_ID = "https://sp.example.org/sp";
 
     /** Constructor. */
@@ -218,6 +222,12 @@ public final class TestSources {
         return defn;
     }
 
+    /** create a {@link AttributeResolutionContext}.
+     * @param principal  principal
+     * @param issuerID  issuerID
+     * @param recipientId  recipientId
+     * @return the freshly minted context
+     */
     public static AttributeResolutionContext createResolutionContext(@Nonnull String principal, @Nonnull String issuerID,
             @Nonnull String recipientId) {
         ProfileRequestContext parent = new ProfileRequestContext();
@@ -231,11 +241,20 @@ public final class TestSources {
         return retVal;
     }
 
+    /** Make a {@link ResolverAttributeDefinitionDependency}.
+     * @param attributeId attributeId
+     * @return  the dependency
+     */
     public static ResolverAttributeDefinitionDependency makeAttributeDefinitionDependency(@Nonnull String attributeId) {
         ResolverAttributeDefinitionDependency retVal = new ResolverAttributeDefinitionDependency(attributeId);
         return retVal;
     }
     
+    /** Make a {@link ResolverDataConnectorDependency}.
+     * @param connectorId connectorId
+     * @param attributeId attributeId
+     * @return the dependency
+     */
     public static ResolverDataConnectorDependency makeDataConnectorDependency(@Nonnull String connectorId, @Nullable String attributeId) {
         ResolverDataConnectorDependency retVal = new ResolverDataConnectorDependency(connectorId);
         if (null == attributeId) {
@@ -246,6 +265,7 @@ public final class TestSources {
         return retVal; 
     }
     
+    /** A static {@link AttributeDefinition} for testing. */
     private static class StaticAttributeDefinition extends AbstractAttributeDefinition {
 
         /** Static value returned by this definition. */
@@ -288,6 +308,7 @@ public final class TestSources {
         }
     }
 
+    /** A static {@link DataConnector}. */
     private static class StaticDataConnector extends AbstractDataConnector {
 
         /** Static collection of values returned by this connector. */
diff --git a/idp-testing/src/main/java/net/shibboleth/idp/saml/profile/testing/ActionTestSupportAction.java b/idp-testing/src/main/java/net/shibboleth/idp/saml/profile/testing/ActionTestSupportAction.java
index fda25e605..89e341f85 100644
--- a/idp-testing/src/main/java/net/shibboleth/idp/saml/profile/testing/ActionTestSupportAction.java
+++ b/idp-testing/src/main/java/net/shibboleth/idp/saml/profile/testing/ActionTestSupportAction.java
@@ -23,9 +23,16 @@ import net.shibboleth.shared.component.ComponentInitializationException;
 import javax.annotation.Nonnull;
 
 import org.opensaml.profile.context.ProfileRequestContext;
+import org.springframework.webflow.execution.Action;
 
+/**
+ * A Test {"link {@link Action}. 
+ */
 public class ActionTestSupportAction extends AbstractProfileAction {
 
+    /** Constructor. 
+     * @throws ComponentInitializationException if initialization fails
+     */
     public ActionTestSupportAction() throws ComponentInitializationException {
         initialize();
     }

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