[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=59e96edd0457ef6b0f4b267f5440f66401e9837a

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

commit 59e96edd0457ef6b0f4b267f5440f66401e9837a
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Wed May 24 07:49:50 2023 +0100

    Javadoc
---
 .../java/net/shibboleth/idp/installer/impl/CopyDistribution.java     | 1 -
 .../src/main/java/net/shibboleth/idp/installer/impl/IdPBuildWar.java | 5 ++---
 .../main/java/net/shibboleth/idp/installer/impl/IdPInstallerCLI.java | 1 +
 .../java/net/shibboleth/idp/installer/impl/InstallerProperties.java  | 2 +-
 .../main/java/net/shibboleth/idp/installer/impl/PasswordHandler.java | 1 +
 .../src/main/java/net/shibboleth/idp/installer/impl/V5Install.java   | 3 +++
 6 files changed, 8 insertions(+), 5 deletions(-)

diff --git a/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/CopyDistribution.java b/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/CopyDistribution.java
index 7108dba46..f420dbfea 100644
--- a/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/CopyDistribution.java
+++ b/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/CopyDistribution.java
@@ -44,7 +44,6 @@ public final class CopyDistribution {
 
     /** Constructor.
      * @param props The environment for the work.
-     * @param state  Where we are right now.
      */
     public CopyDistribution(@Nonnull final InstallerProperties props) {
         installerProps = props;
diff --git a/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/IdPBuildWar.java b/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/IdPBuildWar.java
index c56c63a77..1007281d6 100644
--- a/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/IdPBuildWar.java
+++ b/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/IdPBuildWar.java
@@ -34,6 +34,7 @@ import net.shibboleth.shared.primitive.LoggerFactory;
  */
 public class IdPBuildWar extends AbstractCommandLine<IdPBuildArguments> {
 
+    /** Logger. */
     @Nullable private Logger log;
     
     /** {@inheritDoc} */
@@ -63,9 +64,7 @@ public class IdPBuildWar extends AbstractCommandLine<IdPBuildArguments> {
         return localLog;
     }
 
-    /** {@inheritDoc} 
-     * NOTE that we do not call the super classe
-     * */
+    /** {@inheritDoc} */
     protected int doRun(@Nonnull final IdPBuildArguments args) {
 
         super.doRun(args);
diff --git a/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/IdPInstallerCLI.java b/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/IdPInstallerCLI.java
index 987ca86b9..762edfe5f 100644
--- a/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/IdPInstallerCLI.java
+++ b/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/IdPInstallerCLI.java
@@ -43,6 +43,7 @@ import net.shibboleth.shared.primitive.LoggerFactory;
  */
 public class IdPInstallerCLI extends AbstractCommandLine<IdPInstallerArguments> {
 
+    /** Logger. */
     @Nullable private Logger log;
     
     /** {@inheritDoc} */
diff --git a/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/InstallerProperties.java b/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/InstallerProperties.java
index b9a064359..3134462e9 100644
--- a/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/InstallerProperties.java
+++ b/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/InstallerProperties.java
@@ -171,7 +171,7 @@ public class InstallerProperties  {
 
     /**
      * Constructor.
-     * @param copiedDistribution Has the distribution been copied? If no we don't need the source dir.
+     * @param sourceDir Where the *source* installation is.
      */
     public InstallerProperties(@Nonnull final Path sourceDir) {
         srcDir = sourceDir;
diff --git a/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/PasswordHandler.java b/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/PasswordHandler.java
index a350ecc88..3a0170698 100644
--- a/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/PasswordHandler.java
+++ b/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/PasswordHandler.java
@@ -36,6 +36,7 @@ import org.slf4j.Logger;
 /** Ant helper class to ask for passwords, rejecting zero length passwords and asking for confirmation. */
 public class PasswordHandler extends SecureInputHandler {
     
+    /** Logger. */
     @Nonnull final private Logger log = LoggerFactory.getLogger(PasswordHandler.class);
 
     /** Spool the file to a {@link PropertiesWithComments}, read it in again as a {@link Properties} and check
diff --git a/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/V5Install.java b/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/V5Install.java
index 6a6f45df6..bea5ca366 100644
--- a/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/V5Install.java
+++ b/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/V5Install.java
@@ -99,6 +99,9 @@ public class V5Install {
     /** Constructor.
      * @param props The properties to drive the installs.
      * @param installState The current install.
+     * @param client {@link HttpClient} to use on any Plugin operations
+     * @param securityParams {@link HttpClientSecurityParameters} to use on any Plugin operations
+     * 
      */
     public V5Install(@Nonnull final InstallerProperties props, @Nonnull final CurrentInstallState installState,
             @Nonnull final HttpClient client, @Nullable final HttpClientSecurityParameters securityParams) {

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