[java-identity-provider] 05/05: IDP-2121 Future Proofing the Module Plugin infrastructure for Future SP use

Rod Widdowson rdw at steadingsoftware.com
Fri Jun 9 09:37:03 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=fd6fb067a1a53c3d2f08eb43e4745819aa2b48fa

commit fd6fb067a1a53c3d2f08eb43e4745819aa2b48fa
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Thu Jun 8 20:06:54 2023 +0100

    IDP-2121 Future Proofing the Module Plugin infrastructure for Future SP use
    
    https://shibboleth.atlassian.net/browse/IDP-2121
    
    Rermove three redundant classes - they all have homologs inside
    shib-profile-api.
    
    If people really need them we can add them back it but they represent noise.
---
 .../net/shibboleth/idp/module/ModuleContext.java   | 41 ----------
 .../net/shibboleth/idp/plugin/PluginSupport.java   | 93 ----------------------
 .../net/shibboleth/idp/plugin/PluginVersion.java   | 61 --------------
 3 files changed, 195 deletions(-)

diff --git a/idp-admin-api/src/main/java/net/shibboleth/idp/module/ModuleContext.java b/idp-admin-api/src/main/java/net/shibboleth/idp/module/ModuleContext.java
deleted file mode 100644
index a35122d52..000000000
--- a/idp-admin-api/src/main/java/net/shibboleth/idp/module/ModuleContext.java
+++ /dev/null
@@ -1,41 +0,0 @@
-/*
- * Licensed to the University Corporation for Advanced Internet Development,
- * Inc. (UCAID) under one or more contributor license agreements.  See the
- * NOTICE file distributed with this work for additional information regarding
- * copyright ownership. The UCAID licenses this file to You under the Apache
- * License, Version 2.0 (the "License"); you may not use this file except in
- * compliance with the License.  You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package net.shibboleth.idp.module;
-
-import javax.annotation.Nonnull;
-
-import net.shibboleth.shared.annotation.constraint.NotEmpty;
-
-/**
- * Information required to perform some module operations.
- * 
- * @since 4.1.0
- */
- at Deprecated(forRemoval = true, since = "5.0.0")
-public final class ModuleContext extends net.shibboleth.profile.module.ModuleContext {
-
-    /**
-     * Constructor.
-     *
-     * @param home location of IdP install
-     */
-    public ModuleContext(@Nonnull @NotEmpty final String home) {
-        super(home);
-    }
-
-}
\ No newline at end of file
diff --git a/idp-admin-api/src/main/java/net/shibboleth/idp/plugin/PluginSupport.java b/idp-admin-api/src/main/java/net/shibboleth/idp/plugin/PluginSupport.java
deleted file mode 100644
index fc7166cb8..000000000
--- a/idp-admin-api/src/main/java/net/shibboleth/idp/plugin/PluginSupport.java
+++ /dev/null
@@ -1,93 +0,0 @@
-/*
- * Licensed to the University Corporation for Advanced Internet Development,
- * Inc. (UCAID) under one or more contributor license agreements.  See the
- * NOTICE file distributed with this work for additional information regarding
- * copyright ownership. The UCAID licenses this file to You under the Apache
- * License, Version 2.0 (the "License"); you may not use this file except in
- * compliance with the License.  You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package net.shibboleth.idp.plugin;
-
-import javax.annotation.Nonnull;
-
-import org.slf4j.Logger;
-
-import net.shibboleth.idp.Version;
-import net.shibboleth.shared.primitive.LoggerFactory;
-
-/**
- * Methods for supporting plugins.
- * 
- * @deprecated
- */
- at Deprecated(forRemoval = true, since = "5.0.0")
-public final class PluginSupport {
-    
-    /** Property Name suffix for available versions inside {@link IdPPlugin#getUpdateURLs()}. */
-    @Nonnull public static final String AVAILABLE_VERSIONS_PROPERTY_SUFFIX = ".versions";
-
-    /** Property Name for Download directory {@link IdPPlugin#getUpdateURLs()}. */
-    @Nonnull public static final String DOWNLOAD_URL_INTERFIX = ".downloadURL.";
-
-    /** Property Name for download name {@link IdPPlugin#getUpdateURLs()}. */
-    @Nonnull public static final String BASE_NAME_INTERFIX = ".baseName.";
-
-    /** Property Name for max supported IdP version inside inside {@link IdPPlugin#getUpdateURLs()}. */
-    @Nonnull public static final String MAX_IDP_VERSION_INTERFIX = ".idpVersionMax.";
-
-    /** Property Name for minimum supported IdP version inside inside {@link IdPPlugin#getUpdateURLs()}. */
-    @Nonnull public static final String MIN_IDP_VERSION_INTERFIX = ".idpVersionMin.";
-
-    /** Property Name for support level inside inside {@link IdPPlugin#getUpdateURLs()}. */
-    @Nonnull public static final String SUPPORT_LEVEL_INTERFIX = ".supportLevel.";
-
-    /** Used for specifying templated keynames. */
-    @Nonnull public static final String VERSION_PATTERN = "%{version}";
-
-    /** Used for specifying templated results. */
-    @Nonnull public static final String VERSION_PATTERN_REGEX = "\\%\\{version\\}";
-
-    /** Value for support level pointed to by {@link #SUPPORT_LEVEL_INTERFIX}.*/
-    public static enum SupportLevel {
-        /** The current release. */
-        Current,
-        /** Still working but a new version is available. */
-        OutOfDate,
-        /** Out of Support. */
-        Unsupported,
-        /** Security alerts against this plugin. */
-        Secadv,
-        /** Withdrawn. */
-        Withdrawn,
-        /** Nothing published. */
-        Unknown
-    }
-
-    /** Class logger. */
-    @Nonnull private static Logger log = LoggerFactory.getLogger(PluginSupport.class);
-    
-    /** Constructor. */
-    private PluginSupport() {
-    }
-
-    /** Get parse IdP Version (with fallback for testing).
-     * @return a {@link PluginVersion} of the version.
-     */
-    public static PluginVersion getIdPVersion() {
-        final String idpVersion = Version.getVersion();
-        if (idpVersion!=null) {
-            return new PluginVersion(idpVersion);
-        }
-        log.error("Could not locate IdP Version, assuming 4.1.0");
-        return new PluginVersion(4,1,0);
-    }
-}
diff --git a/idp-admin-api/src/main/java/net/shibboleth/idp/plugin/PluginVersion.java b/idp-admin-api/src/main/java/net/shibboleth/idp/plugin/PluginVersion.java
deleted file mode 100644
index c0f6b2839..000000000
--- a/idp-admin-api/src/main/java/net/shibboleth/idp/plugin/PluginVersion.java
+++ /dev/null
@@ -1,61 +0,0 @@
-/*
- * Licensed to the University Corporation for Advanced Internet Development,
- * Inc. (UCAID) under one or more contributor license agreements.  See the
- * NOTICE file distributed with this work for additional information regarding
- * copyright ownership. The UCAID licenses this file to You under the Apache
- * License, Version 2.0 (the "License"); you may not use this file except in
- * compliance with the License.  You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package net.shibboleth.idp.plugin;
-
-import javax.annotation.Nonnull;
-
-import net.shibboleth.profile.installablecomponent.InstallableComponentVersion;
-
-/**
- * @deprecated class.
- */
- at Deprecated(forRemoval = true, since = "5.0.0") public class PluginVersion extends InstallableComponentVersion {
-
-    /**
-     * Constructor.
-     *
-     * @param plugin what to get the version of.
-     * @throws NumberFormatException if the values are out of range
-     */
-    public PluginVersion(@Nonnull IdPPlugin plugin) throws NumberFormatException {
-        super(plugin);
-    }
-
-    /**
-     * Constructor.
-     *
-     * @param version what to build from 
-     * @throws NumberFormatException if it doesn't fit a 1.2.3 format or if the values are
-     * out of range
-     */
-    public PluginVersion(final String version) throws NumberFormatException {
-        super(version);
-    }
-
-    /**
-     * Constructor.
-     *
-     * @param maj Major Version
-     * @param min Minor Version
-     * @param pat Patch Version
-     * @throws NumberFormatException if the values are out of range
-     */
-    public PluginVersion(final int maj, final int min, final int pat) {
-        super(maj, min, pat);
-    }
-}

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


More information about the commits mailing list