[java-identity-provider] 07/09: IDP-2106 Remove all API interfaces from the installer
Rod Widdowson
rdw at steadingsoftware.com
Thu May 18 10:21:53 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=070281b0e30d5661e9c13769495d05eca6497bfc
commit 070281b0e30d5661e9c13769495d05eca6497bfc
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Wed May 17 14:08:27 2023 +0100
IDP-2106 Remove all API interfaces from the installer
https://shibboleth.atlassian.net/browse/IDP-2106
Move BuildWar CopyDistribution and V4Install into impl.
Rename V4Install V5Install
---
.../shibboleth/idp/installer/ant/impl/V4InstallTask.java | 8 ++++----
.../net/shibboleth/idp/installer/{ => impl}/BuildWar.java | 6 ++----
.../idp/installer/{ => impl}/CopyDistribution.java | 6 ++----
.../java/net/shibboleth/idp/installer/impl/Installer.java | 5 +----
.../idp/installer/{V4Install.java => impl/V5Install.java} | 15 ++++++++-------
.../java/net/shibboleth/idp/installer/package-info.java | 6 ------
.../idp/installer/plugin/impl/PluginInstaller.java | 2 +-
.../src/test/java/net/shibboleth/idp/installer/Test.java | 5 ++++-
8 files changed, 22 insertions(+), 31 deletions(-)
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 542abb2cd..cd8eabf79 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
@@ -26,11 +26,11 @@ import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Task;
import org.slf4j.Logger;
-import net.shibboleth.idp.installer.BuildWar;
-import net.shibboleth.idp.installer.CopyDistribution;
-import net.shibboleth.idp.installer.V4Install;
+import net.shibboleth.idp.installer.impl.BuildWar;
+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.shared.collection.CollectionSupport;
import net.shibboleth.shared.component.ComponentInitializationException;
@@ -92,7 +92,7 @@ public class V4InstallTask extends Task {
}
if (doInstall) {
- final V4Install inst = new V4Install(ip, is);
+ final V5Install inst = new V5Install(ip, is);
inst.setMetadataGenerator(new MetadataGeneratorImpl());
inst.initialize();
inst.execute();
diff --git a/idp-installer/src/main/java/net/shibboleth/idp/installer/BuildWar.java b/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/BuildWar.java
similarity index 96%
rename from idp-installer/src/main/java/net/shibboleth/idp/installer/BuildWar.java
rename to idp-installer/src/main/java/net/shibboleth/idp/installer/impl/BuildWar.java
index 8105375b5..edd1d2a6a 100644
--- a/idp-installer/src/main/java/net/shibboleth/idp/installer/BuildWar.java
+++ b/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/BuildWar.java
@@ -15,7 +15,7 @@
* limitations under the License.
*/
-package net.shibboleth.idp.installer;
+package net.shibboleth.idp.installer.impl;
import java.io.File;
import java.nio.file.Files;
@@ -29,9 +29,7 @@ import org.apache.tools.ant.taskdefs.Jar;
import org.slf4j.Logger;
import net.shibboleth.idp.Version;
-import net.shibboleth.idp.installer.impl.CurrentInstallState;
-import net.shibboleth.idp.installer.impl.InstallationLogger;
-import net.shibboleth.idp.installer.impl.InstallerProperties;
+import net.shibboleth.idp.installer.InstallerSupport;
import net.shibboleth.shared.component.AbstractInitializableComponent;
import net.shibboleth.shared.component.ComponentInitializationException;
import net.shibboleth.shared.component.UninitializedComponentException;
diff --git a/idp-installer/src/main/java/net/shibboleth/idp/installer/CopyDistribution.java b/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/CopyDistribution.java
similarity index 96%
rename from idp-installer/src/main/java/net/shibboleth/idp/installer/CopyDistribution.java
rename to idp-installer/src/main/java/net/shibboleth/idp/installer/impl/CopyDistribution.java
index fd688037f..ff820f6ae 100644
--- a/idp-installer/src/main/java/net/shibboleth/idp/installer/CopyDistribution.java
+++ b/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/CopyDistribution.java
@@ -15,7 +15,7 @@
* limitations under the License.
*/
-package net.shibboleth.idp.installer;
+package net.shibboleth.idp.installer.impl;
import java.nio.file.Files;
import java.nio.file.Path;
@@ -26,9 +26,7 @@ import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.taskdefs.Copy;
import org.slf4j.Logger;
-import net.shibboleth.idp.installer.impl.CurrentInstallState;
-import net.shibboleth.idp.installer.impl.InstallationLogger;
-import net.shibboleth.idp.installer.impl.InstallerProperties;
+import net.shibboleth.idp.installer.InstallerSupport;
import net.shibboleth.shared.component.AbstractInitializableComponent;
import net.shibboleth.shared.component.UninitializedComponentException;
import net.shibboleth.shared.logic.Constraint;
diff --git a/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/Installer.java b/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/Installer.java
index bb055d5eb..0c8340311 100644
--- a/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/Installer.java
+++ b/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/Installer.java
@@ -19,9 +19,6 @@ package net.shibboleth.idp.installer.impl;
import org.slf4j.Logger;
-import net.shibboleth.idp.installer.BuildWar;
-import net.shibboleth.idp.installer.CopyDistribution;
-import net.shibboleth.idp.installer.V4Install;
import net.shibboleth.shared.component.ComponentInitializationException;
/**
@@ -64,7 +61,7 @@ public final class Installer {
}
if (doInstall) {
- final V4Install inst = new V4Install(ip, is);
+ final V5Install inst = new V5Install(ip, is);
inst.execute();
}
diff --git a/idp-installer/src/main/java/net/shibboleth/idp/installer/V4Install.java b/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/V5Install.java
similarity index 98%
rename from idp-installer/src/main/java/net/shibboleth/idp/installer/V4Install.java
rename to idp-installer/src/main/java/net/shibboleth/idp/installer/impl/V5Install.java
index 9261558e3..03ca3dfff 100644
--- a/idp-installer/src/main/java/net/shibboleth/idp/installer/V4Install.java
+++ b/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/V5Install.java
@@ -15,7 +15,7 @@
* limitations under the License.
*/
-package net.shibboleth.idp.installer;
+package net.shibboleth.idp.installer.impl;
import java.io.BufferedReader;
import java.io.BufferedWriter;
@@ -47,9 +47,10 @@ import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;
import net.shibboleth.idp.Version;
-import net.shibboleth.idp.installer.impl.CurrentInstallState;
-import net.shibboleth.idp.installer.impl.InstallationLogger;
-import net.shibboleth.idp.installer.impl.InstallerProperties;
+import net.shibboleth.idp.installer.InstallerSupport;
+import net.shibboleth.idp.installer.MetadataGenerator;
+import net.shibboleth.idp.installer.MetadataGeneratorParameters;
+import net.shibboleth.idp.installer.PropertiesWithComments;
import net.shibboleth.idp.installer.plugin.impl.PluginState;
import net.shibboleth.idp.module.IdPModule;
import net.shibboleth.idp.module.ModuleContext;
@@ -70,10 +71,10 @@ import net.shibboleth.shared.spring.util.ApplicationContextBuilder;
/** Code to do most of the V4 Install.
*/
-public class V4Install extends AbstractInitializableComponent {
+public class V5Install extends AbstractInitializableComponent {
/** Log. */
- private final Logger log = InstallationLogger.getLogger(V4Install.class);
+ private final Logger log = InstallationLogger.getLogger(V5Install.class);
/** Installer Properties. */
@Nonnull private final InstallerProperties installerProps;
@@ -91,7 +92,7 @@ public class V4Install extends AbstractInitializableComponent {
* @param props The properties to drive the installs.
* @param installState The current install.
*/
- public V4Install(@Nonnull final InstallerProperties props, @Nonnull final CurrentInstallState installState) {
+ public V5Install(@Nonnull final InstallerProperties props, @Nonnull final CurrentInstallState installState) {
if (!props.isInitialized()) {
throw new UninitializedComponentException("Installer Properties not Initialized");
}
diff --git a/idp-installer/src/main/java/net/shibboleth/idp/installer/package-info.java b/idp-installer/src/main/java/net/shibboleth/idp/installer/package-info.java
index 9624108a4..4618fce74 100644
--- a/idp-installer/src/main/java/net/shibboleth/idp/installer/package-info.java
+++ b/idp-installer/src/main/java/net/shibboleth/idp/installer/package-info.java
@@ -16,12 +16,6 @@
*/
/**
* Classes available for installation.
- * <b>NOTE</b> that only {@link net.shibboleth.idp.installer.InstallerSupport}
- * is suitable for programmatic extension. All other classes are either for use
- * only by this package (i.e. {@link net.shibboleth.idp.installer.PropertiesWithComments})
- * or are final and have limited public methods (the three classes that do the heavy lifting
- * {@link net.shibboleth.idp.installer.V4Install}, {@link net.shibboleth.idp.installer.CopyDistribution},
- * {@link net.shibboleth.idp.installer.BuildWar}
*/
package net.shibboleth.idp.installer;
\ No newline at end of file
diff --git a/idp-installer/src/main/java/net/shibboleth/idp/installer/plugin/impl/PluginInstaller.java b/idp-installer/src/main/java/net/shibboleth/idp/installer/plugin/impl/PluginInstaller.java
index 997ec6c09..e121ce71b 100644
--- a/idp-installer/src/main/java/net/shibboleth/idp/installer/plugin/impl/PluginInstaller.java
+++ b/idp-installer/src/main/java/net/shibboleth/idp/installer/plugin/impl/PluginInstaller.java
@@ -65,9 +65,9 @@ import org.opensaml.security.httpclient.HttpClientSecurityParameters;
import org.slf4j.Logger;
import net.shibboleth.idp.Version;
-import net.shibboleth.idp.installer.BuildWar;
import net.shibboleth.idp.installer.InstallerSupport;
import net.shibboleth.idp.installer.ProgressReportingOutputStream;
+import net.shibboleth.idp.installer.impl.BuildWar;
import net.shibboleth.idp.installer.impl.InstallationLogger;
import net.shibboleth.idp.installer.plugin.impl.TrustStore.Signature;
import net.shibboleth.idp.module.IdPModule;
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 a4991a1ab..f193b226e 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
@@ -19,8 +19,11 @@ package net.shibboleth.idp.installer;
import java.io.IOException;
+import net.shibboleth.idp.installer.impl.BuildWar;
+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.shared.component.ComponentInitializationException;
/**
@@ -54,7 +57,7 @@ public class Test {
dist.initialize();
dist.execute();
- final V4Install inst = new V4Install(ip, is);
+ final V5Install inst = new V5Install(ip, is);
inst.setMetadataGenerator(new MetadataGeneratorImpl());
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