[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=c117d66af2d39d8dad110ee2397f0f29540d9e00

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

commit c117d66af2d39d8dad110ee2397f0f29540d9e00
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Sun Oct 2 15:33:50 2022 +0100

    javaDoc
---
 .../net/shibboleth/idp/cli/impl/JarCheckCLI.java   | 11 ++++----
 .../metadata/impl/MetadataGeneratorImpl.java       | 33 ++++++++++++++++------
 .../spring/factory/FlowRelativeResourceLoader.java |  5 ++++
 3 files changed, 34 insertions(+), 15 deletions(-)

diff --git a/idp-cli/src/main/java/net/shibboleth/idp/cli/impl/JarCheckCLI.java b/idp-cli/src/main/java/net/shibboleth/idp/cli/impl/JarCheckCLI.java
index 6741d7b97..1505d2232 100644
--- a/idp-cli/src/main/java/net/shibboleth/idp/cli/impl/JarCheckCLI.java
+++ b/idp-cli/src/main/java/net/shibboleth/idp/cli/impl/JarCheckCLI.java
@@ -94,9 +94,8 @@ public final class JarCheckCLI extends AbstractIdPHomeAwareCommandLine<JarCheckA
         }));
     }
     
-    /** Check for the same file in two places and if asked for.
-     * output the sorted list
-     * @param args
+    /** Check for the same file in two places.
+     * @param args the arguments to check
      */
     private void listAndExactCheck(final JarCheckArguments args) {
         final Map<String, String> allNames = new HashMap<>(distJars.size() + pluginJars.size() + webAppJars.size());
@@ -159,7 +158,7 @@ public final class JarCheckCLI extends AbstractIdPHomeAwareCommandLine<JarCheckA
     }
 
     /** Do a general test.
-     * @param args
+     * @param args the arguments to check
      */
     private void fileNamesOnly(final JarCheckArguments args) {
         final Map<String, String> allNames = new HashMap<>(distJars.size() + pluginJars.size() + webAppJars.size());
@@ -171,7 +170,7 @@ public final class JarCheckCLI extends AbstractIdPHomeAwareCommandLine<JarCheckA
     }
     
     /** make the file names look more 'usual'.
-     * @param fileNames
+     * @param fileNames the files to look at
      * @return the processed names
      */
     private List<String> normalize(final List<String> fileNames) {
@@ -189,7 +188,7 @@ public final class JarCheckCLI extends AbstractIdPHomeAwareCommandLine<JarCheckA
     }
 
     /** Do a detailed check.
-     * @param args 
+     * @param args the arguments to check
      */
     private void detailed(final JarCheckArguments args) {
         final Map<String, String> allNames = new HashMap<>();
diff --git a/idp-installer/src/main/java/net/shibboleth/idp/installer/metadata/impl/MetadataGeneratorImpl.java b/idp-installer/src/main/java/net/shibboleth/idp/installer/metadata/impl/MetadataGeneratorImpl.java
index f70283ee1..9f1861586 100644
--- a/idp-installer/src/main/java/net/shibboleth/idp/installer/metadata/impl/MetadataGeneratorImpl.java
+++ b/idp-installer/src/main/java/net/shibboleth/idp/installer/metadata/impl/MetadataGeneratorImpl.java
@@ -77,15 +77,30 @@ public class MetadataGeneratorImpl extends AbstractInitializableComponent implem
      * The end points we understand.
      */
     enum Endpoints {
-        /** IDPSSODescriptor. Artfact */
-        SAML1Artifact, SAML2Artifact,
-        /** IDPSSODescriptor. SLO */
-        RedirectSLO, POSTSLO, POSTSimpleSignSLO, SOAPSLO,
-        /** IDPSSODescriptor. SSO */
-        ShibbolethSSO, POSTSSO, POSTSimpleSignSSO, RedirectSSO,
-
-        /** AttributeAuthorityDescriptor. */
-        SAML1Query, SAML2Query,
+        /** IDPSSODescriptor. Artifact (SAML1). */
+        SAML1Artifact,
+        /** IDPSSODescriptor. Artifact (SAML2). */
+        SAML2Artifact,
+        /** IDPSSODescriptor. SLO (Redirect) */
+        RedirectSLO,
+        /** IDPSSODescriptor. SLO (Post) */
+        POSTSLO,
+        /** IDPSSODescriptor. SLO (Post Simple Sign) */
+        POSTSimpleSignSLO,
+        /** IDPSSODescriptor. SLO (Soap) */
+        SOAPSLO,
+        /** IDPSSODescriptor. SSO (Shibboleth protocol)*/
+        ShibbolethSSO,
+        /** IDPSSODescriptor. SSO (SAML2 Post)*/
+        POSTSSO,
+        /** IDPSSODescriptor. SSO (SAML2 Post Simple Sign)*/
+        POSTSimpleSignSSO,
+        /** IDPSSODescriptor. SSO (SAML2 Redirectr)*/
+        RedirectSSO,
+        /** AttributeAuthorityDescriptor. (SAML1=)*/
+        SAML1Query,
+        /** AttributeAuthorityDescriptor. (SAML2) */
+        SAML2Query,
     }
 
     /**
diff --git a/idp-spring/src/main/java/net/shibboleth/idp/profile/spring/factory/FlowRelativeResourceLoader.java b/idp-spring/src/main/java/net/shibboleth/idp/profile/spring/factory/FlowRelativeResourceLoader.java
index e1012d4fa..07855d530 100644
--- a/idp-spring/src/main/java/net/shibboleth/idp/profile/spring/factory/FlowRelativeResourceLoader.java
+++ b/idp-spring/src/main/java/net/shibboleth/idp/profile/spring/factory/FlowRelativeResourceLoader.java
@@ -50,6 +50,7 @@ class FlowRelativeResourceLoader extends DefaultResourceLoader {
         getProtocolResolvers().add(new ConditionalResourceResolver());
     }
 
+    /** {@inheritDoc} */
     public ClassLoader getClassLoader() {
         return flowResource.getClass().getClassLoader();
     }
@@ -74,6 +75,10 @@ class FlowRelativeResourceLoader extends DefaultResourceLoader {
         return createFlowRelativeResource(location);
     }
 
+    /** Return resource relative to the {@linkplain #flowResource}
+     * @param location the resource location
+     * @return a corresponding Resource handle
+     */
     private Resource createFlowRelativeResource(final String location) {
         try {
             return flowResource.createRelative(location);

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