[java-idp-plugin-jetty] branch main updated: Checkstyle.

[Scott Cantor]

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

scantor pushed a commit to branch main
in repository java-idp-plugin-jetty.

View the commit online:
https://git.shibboleth.net/view/?p=java-idp-plugin-jetty.git;a=commit;h=21a938b8f08fdae06dc51d2e31635aa997c218e5

The following commit(s) were added to refs/heads/main by this push:
     new 21a938b  Checkstyle.
21a938b is described below

commit 21a938b8f08fdae06dc51d2e31635aa997c218e5
Author: Scott Cantor <cantor.2 at osu.edu>
AuthorDate: Wed Nov 12 09:36:52 2025 -0500

    Checkstyle.
---
 .../shibboleth/idp/module/jetty/JettyModule.java   | 39 ++++++++++++++++------
 1 file changed, 29 insertions(+), 10 deletions(-)

diff --git a/jetty-impl/src/main/java/net/shibboleth/idp/module/jetty/JettyModule.java b/jetty-impl/src/main/java/net/shibboleth/idp/module/jetty/JettyModule.java
index c44fb14..5d860d8 100644
--- a/jetty-impl/src/main/java/net/shibboleth/idp/module/jetty/JettyModule.java
+++ b/jetty-impl/src/main/java/net/shibboleth/idp/module/jetty/JettyModule.java
@@ -42,6 +42,9 @@ import net.shibboleth.shared.collection.CollectionSupport;
 import net.shibboleth.shared.primitive.LoggerFactory;
 import net.shibboleth.shared.security.impl.SelfSignedCertificateGenerator;
 
+/**
+ * Module for Jetty plugin's resources, a bit more complex than usual.
+ */
 public class JettyModule extends PluginIdPModule {
 
     /** Class logger. */
@@ -49,6 +52,9 @@ public class JettyModule extends PluginIdPModule {
 
     /**
      * Constructor.
+     * 
+     * @throws IOException 
+     * @throws ModuleException 
      */
     public JettyModule() throws IOException, ModuleException {
         super(Version.getVersion(), JettyModule.class);
@@ -68,10 +74,13 @@ public class JettyModule extends PluginIdPModule {
         return result;
     }
 
-    /** Copy the logback jars into jetty-base\lib\logging and set up an appropriate ini file.
+    /**
+     * Copy the logback jars into jetty-base\lib\logging and set up an appropriate ini file.
+     * 
      * @param idpHome idpHome
      * @param jettyBaseName the jetty base to populate (parameterized to allow multiple jett-bases per plugin)
-     * @throws ModuleException if we cannot find the logback version or get an IO issue.
+     * 
+     * @throws ModuleException if we cannot find the logback version or get an IO issue
      */
     private void handleLogbackJars(final @Nonnull Path idpHome, final @Nonnull @NotEmpty String jettyBaseName) throws ModuleException {
 
@@ -98,10 +107,13 @@ public class JettyModule extends PluginIdPModule {
         }
     }
 
-    /** Copy a names logback jar from the IdP distribution to jetty-base 
+    /**
+     * Copy a names logback jar from the IdP distribution to jetty-base.
+     *  
      * @param sourceDir where to copy from (idp.home/dist/webapp/WEB-INF/lib
      * @param targetDir
      * @param jarName
+     * 
      * @throws IOException if the copy fails
      */
     private void copyLogbackJar(Path sourceDir, Path targetDir, String jarName) throws IOException {
@@ -126,11 +138,15 @@ public class JettyModule extends PluginIdPModule {
         }
     }
 
-	/** Find out what version of logback this IdP install uses.
-     * Look for logback-classic-version.jar and pluck out the version.
+	/**
+	 * Find out what version of logback this IdP install uses;
+     * look for logback-classic-version.jar and pluck out the version.
+     * 
      * @param distLibDir {@link Path}for idp.home/dist/webapp/WEB-INF/lib
-     * @return the version.
-     * @throws ModuleException if the lookup failed.
+     * 
+     * @return the version
+     * 
+     * @throws ModuleException if the lookup failed
      */
     private String inferLogbackVersion(Path distLibDir) throws ModuleException {
 
@@ -149,11 +165,14 @@ public class JettyModule extends PluginIdPModule {
         }
     }
 
-	/** Generate an mock idp-userfacing.p12 keystore.
-     * @param keystore where to put it
+	/**
+	 * Generate an mock idp-userfacing.p12 keystore.
+	 * 
+     * @param keyStore where to put it
+     * 
      * @throws ModuleException if the generator fails
      */
-    private void generateKeystore(Path keyStore) throws ModuleException {
+    private void generateKeystore(@Nonnull final Path keyStore) throws ModuleException {
         final SelfSignedCertificateGenerator generator = new SelfSignedCertificateGenerator();
         generator.setKeystoreFile(keyStore.toFile());
         generator.setKeySize(InstallerProperties.DEFAULT_KEY_SIZE);

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