[java-identity-provider] 09/09: IDP-2106 Remove all API interfaces from the installer

Rod Widdowson rdw at steadingsoftware.com
Thu May 18 10:21:55 UTC 2023


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=4b469f7090495a4caa96b2ae4f59bd8b1ae6443b

commit 4b469f7090495a4caa96b2ae4f59bd8b1ae6443b
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Wed May 17 14:25:06 2023 +0100

    IDP-2106 Remove all API interfaces from the installer
    
    https://shibboleth.atlassian.net/browse/IDP-2106
    
    Rename the two metadata generator classes (removing the Impl suffix)
---
 .../installer/ant/impl/MetadataGeneratorTask.java    | 10 +++++-----
 .../idp/installer/ant/impl/V4InstallTask.java        |  4 ++--
 .../net/shibboleth/idp/installer/impl/V5Install.java | 20 ++++++++++----------
 ...dataGeneratorImpl.java => MetadataGenerator.java} |  6 +++---
 ...ersImpl.java => MetadataGeneratorParameters.java} |  2 +-
 .../test/java/net/shibboleth/idp/installer/Test.java |  4 ++--
 6 files changed, 23 insertions(+), 23 deletions(-)

diff --git a/idp-installer/src/main/java/net/shibboleth/idp/installer/ant/impl/MetadataGeneratorTask.java b/idp-installer/src/main/java/net/shibboleth/idp/installer/ant/impl/MetadataGeneratorTask.java
index f24a5fd5a..494bbd2f9 100644
--- a/idp-installer/src/main/java/net/shibboleth/idp/installer/ant/impl/MetadataGeneratorTask.java
+++ b/idp-installer/src/main/java/net/shibboleth/idp/installer/ant/impl/MetadataGeneratorTask.java
@@ -30,8 +30,8 @@ import org.springframework.context.support.GenericApplicationContext;
 import org.springframework.core.io.ClassPathResource;
 import org.springframework.core.io.Resource;
 
-import net.shibboleth.idp.installer.metadata.impl.MetadataGeneratorImpl;
-import net.shibboleth.idp.installer.metadata.impl.MetadataGeneratorParametersImpl;
+import net.shibboleth.idp.installer.metadata.impl.MetadataGenerator;
+import net.shibboleth.idp.installer.metadata.impl.MetadataGeneratorParameters;
 import net.shibboleth.idp.spring.IdPPropertiesApplicationContextInitializer;
 import net.shibboleth.shared.collection.CollectionSupport;
 import net.shibboleth.shared.spring.util.ApplicationContextBuilder;
@@ -157,7 +157,7 @@ public class MetadataGeneratorTask extends Task {
             throw new BuildException("DNS Name - output file not provided");
         }
         try {
-            final MetadataGeneratorParametersImpl parameters;
+            final MetadataGeneratorParameters parameters;
 
             final Resource resource = new ClassPathResource("net/shibboleth/idp/installer/metadata-generator-ant.xml");
 
@@ -167,13 +167,13 @@ public class MetadataGeneratorTask extends Task {
                     .setContextInitializer(new Initializer())
                     .build();
             
-            parameters = context.getBean("IdPConfiguration", MetadataGeneratorParametersImpl.class);
+            parameters = context.getBean("IdPConfiguration", MetadataGeneratorParameters.class);
 
             parameters.setBackchannelCert(backchannelCert);
             parameters.setDnsName(dns);
             parameters.initialize();
 
-            final MetadataGeneratorImpl generator = new MetadataGeneratorImpl();
+            final MetadataGenerator generator = new MetadataGenerator();
             generator.setSAML2AttributeQueryCommented(saml2AttributeQueryCommented);
             generator.setSAML2LogoutCommented(saml2LogoutCommented);
             generator.setParameters(parameters);
diff --git a/idp-installer/src/main/java/net/shibboleth/idp/installer/ant/impl/V4InstallTask.java b/idp-installer/src/main/java/net/shibboleth/idp/installer/ant/impl/V4InstallTask.java
index cd8eabf79..eceb66731 100644
--- a/idp-installer/src/main/java/net/shibboleth/idp/installer/ant/impl/V4InstallTask.java
+++ b/idp-installer/src/main/java/net/shibboleth/idp/installer/ant/impl/V4InstallTask.java
@@ -31,7 +31,7 @@ import net.shibboleth.idp.installer.impl.CopyDistribution;
 import net.shibboleth.idp.installer.impl.CurrentInstallState;
 import net.shibboleth.idp.installer.impl.InstallerProperties;
 import net.shibboleth.idp.installer.impl.V5Install;
-import net.shibboleth.idp.installer.metadata.impl.MetadataGeneratorImpl;
+import net.shibboleth.idp.installer.metadata.impl.MetadataGenerator;
 import net.shibboleth.shared.collection.CollectionSupport;
 import net.shibboleth.shared.component.ComponentInitializationException;
 import net.shibboleth.shared.logic.Constraint;
@@ -93,7 +93,7 @@ public class V4InstallTask extends Task {
 
             if (doInstall) {
                 final V5Install inst = new V5Install(ip, is);
-                inst.setMetadataGenerator(new MetadataGeneratorImpl());
+                inst.setMetadataGenerator(new MetadataGenerator());
                 inst.initialize();
                 inst.execute();
             }
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 8ab632ccf..39a899a91 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
@@ -49,8 +49,8 @@ import org.springframework.core.io.Resource;
 import net.shibboleth.idp.Version;
 import net.shibboleth.idp.installer.InstallerSupport;
 import net.shibboleth.idp.installer.PropertiesWithComments;
-import net.shibboleth.idp.installer.metadata.impl.MetadataGeneratorImpl;
-import net.shibboleth.idp.installer.metadata.impl.MetadataGeneratorParametersImpl;
+import net.shibboleth.idp.installer.metadata.impl.MetadataGenerator;
+import net.shibboleth.idp.installer.metadata.impl.MetadataGeneratorParameters;
 import net.shibboleth.idp.installer.plugin.impl.PluginState;
 import net.shibboleth.idp.module.IdPModule;
 import net.shibboleth.idp.module.ModuleContext;
@@ -86,7 +86,7 @@ public class V5Install extends AbstractInitializableComponent {
     @Nonnull private final KeyManagement keyManager;
 
     /** What will generate metadata? */
-    private MetadataGeneratorImpl metadataGenerator;
+    private MetadataGenerator metadataGenerator;
 
     /** Constructor.
      * @param props The properties to drive the installs.
@@ -130,13 +130,13 @@ public class V5Install extends AbstractInitializableComponent {
         reprotect();
     }
 
-    /** Set the {@link MetadataGeneratorImpl}.
+    /** Set the {@link MetadataGenerator}.
      * @param what what to set.  This need not have been initialized yet
-     * {@link MetadataGeneratorImpl#setOutput(File)} and
-     * {@link MetadataGeneratorImpl#setParameters(MetadataGeneratorParametersImpl)} are called
+     * {@link MetadataGenerator#setOutput(File)} and
+     * {@link MetadataGenerator#setParameters(MetadataGeneratorParameters)} are called
      * prior to initialization.
      */
-    public void setMetadataGenerator(final MetadataGeneratorImpl what) {
+    public void setMetadataGenerator(final MetadataGenerator what) {
         checkSetterPreconditions();
         metadataGenerator = what;
     }
@@ -476,13 +476,13 @@ public class V5Install extends AbstractInitializableComponent {
         }
         final Resource resource = new ClassPathResource("net/shibboleth/idp/installer/metadata-generator.xml");
         final GenericApplicationContext context = new ApplicationContextBuilder()
-                .setName(MetadataGeneratorImpl.class.getName())
+                .setName(MetadataGenerator.class.getName())
                 .setServiceConfigurations(CollectionSupport.singletonList(resource))
                 .setContextInitializer(new Initializer())
                 .build();
 
-        final MetadataGeneratorParametersImpl parameters = context.getBean("IdPConfiguration",
-                MetadataGeneratorParametersImpl.class);
+        final MetadataGeneratorParameters parameters = context.getBean("IdPConfiguration",
+                MetadataGeneratorParameters.class);
 
         log.info("Creating Metadata to {}", metadataFile);
         log.debug("Parameters {}", parameters);
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/MetadataGenerator.java
similarity index 99%
rename from idp-installer/src/main/java/net/shibboleth/idp/installer/metadata/impl/MetadataGeneratorImpl.java
rename to idp-installer/src/main/java/net/shibboleth/idp/installer/metadata/impl/MetadataGenerator.java
index 2b4181af5..e565eea26 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/MetadataGenerator.java
@@ -69,7 +69,7 @@ import net.shibboleth.shared.xml.XMLConstants;
  * This class gathers information which it then uses to generate IdP Metadata. Loosely based on the SP metadata
  * generator, and the V2 metadata.
  */
-public class MetadataGeneratorImpl extends AbstractInitializableComponent {
+public class MetadataGenerator extends AbstractInitializableComponent {
 
     /**
      * The end points we understand.
@@ -164,7 +164,7 @@ public class MetadataGeneratorImpl extends AbstractInitializableComponent {
     private File output;
 
     /** The parameters. */
-    private MetadataGeneratorParametersImpl params;
+    private MetadataGeneratorParameters params;
 
     /** {@inheritDoc} */
     protected void doInitialize() throws ComponentInitializationException {
@@ -189,7 +189,7 @@ public class MetadataGeneratorImpl extends AbstractInitializableComponent {
     /** Set a description of the IdP.
      * @param what what to set.  This component does not have to be initialized.
      */
-    public void setParameters(@Nonnull final MetadataGeneratorParametersImpl what) {
+    public void setParameters(@Nonnull final MetadataGeneratorParameters what) {
         checkSetterPreconditions();
         params = Constraint.isNotNull(what, "provided params must be nonnull");
     }
diff --git a/idp-installer/src/main/java/net/shibboleth/idp/installer/metadata/impl/MetadataGeneratorParametersImpl.java b/idp-installer/src/main/java/net/shibboleth/idp/installer/metadata/impl/MetadataGeneratorParameters.java
similarity index 98%
rename from idp-installer/src/main/java/net/shibboleth/idp/installer/metadata/impl/MetadataGeneratorParametersImpl.java
rename to idp-installer/src/main/java/net/shibboleth/idp/installer/metadata/impl/MetadataGeneratorParameters.java
index 7e46ad235..a1405cf0a 100644
--- a/idp-installer/src/main/java/net/shibboleth/idp/installer/metadata/impl/MetadataGeneratorParametersImpl.java
+++ b/idp-installer/src/main/java/net/shibboleth/idp/installer/metadata/impl/MetadataGeneratorParameters.java
@@ -37,7 +37,7 @@ import net.shibboleth.shared.component.ComponentInitializationException;
 /**
  * Parameters to metadata generation
  */
-public class MetadataGeneratorParametersImpl extends AbstractInitializableComponent {
+public class MetadataGeneratorParameters extends AbstractInitializableComponent {
 
     /**
      * The file with the certificate the IDP uses to encrypt.
diff --git a/idp-installer/src/test/java/net/shibboleth/idp/installer/Test.java b/idp-installer/src/test/java/net/shibboleth/idp/installer/Test.java
index f193b226e..a594909e4 100644
--- a/idp-installer/src/test/java/net/shibboleth/idp/installer/Test.java
+++ b/idp-installer/src/test/java/net/shibboleth/idp/installer/Test.java
@@ -24,7 +24,7 @@ import net.shibboleth.idp.installer.impl.CopyDistribution;
 import net.shibboleth.idp.installer.impl.CurrentInstallState;
 import net.shibboleth.idp.installer.impl.InstallerProperties;
 import net.shibboleth.idp.installer.impl.V5Install;
-import net.shibboleth.idp.installer.metadata.impl.MetadataGeneratorImpl;
+import net.shibboleth.idp.installer.metadata.impl.MetadataGenerator;
 import net.shibboleth.shared.component.ComponentInitializationException;
 /**
  *
@@ -58,7 +58,7 @@ public class Test {
         dist.execute();
 
         final V5Install inst = new V5Install(ip, is);
-        inst.setMetadataGenerator(new MetadataGeneratorImpl());
+        inst.setMetadataGenerator(new MetadataGenerator());
         inst.initialize();
         inst.execute();
 

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


More information about the commits mailing list