[java-support] branch master updated: IDP-1595 Remove old Plugin support classes from java-support
Rod Widdowson
rdw at steadingsoftware.com
Fri Jul 17 10:00:44 UTC 2020
This is an automated email from the git hooks/post-receive script.
rdw pushed a commit to branch master
in repository java-support.
View the commit online:
http://git.shibboleth.net/view/?p=java-support.git;a=commit;h=5dc3871520f4d01333b2aaf9e8e0d846c64b7a0b
The following commit(s) were added to refs/heads/master by this push:
new 5dc3871 IDP-1595 Remove old Plugin support classes from java-support
5dc3871 is described below
commit 5dc3871520f4d01333b2aaf9e8e0d846c64b7a0b
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Fri Jul 17 10:49:34 2020 +0100
IDP-1595 Remove old Plugin support classes from java-support
https://issues.shibboleth.net/jira/browse/IDP-1595
---
.../support/plugin/AbstractPluginDescription.java | 64 ----------
.../java/support/plugin/PluginDescription.java | 130 ---------------------
.../java/support/plugin/package-info.java | 21 ----
3 files changed, 215 deletions(-)
diff --git a/src/main/java/net/shibboleth/utilities/java/support/plugin/AbstractPluginDescription.java b/src/main/java/net/shibboleth/utilities/java/support/plugin/AbstractPluginDescription.java
deleted file mode 100644
index cda1430..0000000
--- a/src/main/java/net/shibboleth/utilities/java/support/plugin/AbstractPluginDescription.java
+++ /dev/null
@@ -1,64 +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.utilities.java.support.plugin;
-
-import java.io.IOException;
-import java.net.URL;
-import java.nio.file.Path;
-import java.util.Collections;
-import java.util.List;
-
-import javax.annotation.Nonnegative;
-import javax.annotation.Nonnull;
-
-import com.google.common.annotations.Beta;
-
-import net.shibboleth.utilities.java.support.collection.Pair;
-
-/**
- * This class is exported (via the service API) by every plugin.
- */
- at Beta
- at Deprecated(forRemoval = true, since = "4.1")
-public abstract class AbstractPluginDescription implements PluginDescription {
-
- /** {@inheritDoc} */
- @Nonnull public List<String> getAdditionalPropertyFiles() {
- return Collections.emptyList();
- }
-
- /** {@inheritDoc} */
- @Nonnull public List<Path> getFilePathsToCopy() {
- return Collections.emptyList();
- }
-
- /** {@inheritDoc} */
- @Nonnull public List<Pair<URL, Path>> getExternalFilePathsToCopy() throws IOException {
- return Collections.emptyList();
- }
-
- /** {@inheritDoc} */
- @Nonnull public List<Pair<Path, List<String>>> getPropertyMerges() {
- return Collections.emptyList();
- }
-
- /** {@inheritDoc} */
- @Nonnegative public int getPatchVersion() {
- return 0;
- }
-}
diff --git a/src/main/java/net/shibboleth/utilities/java/support/plugin/PluginDescription.java b/src/main/java/net/shibboleth/utilities/java/support/plugin/PluginDescription.java
deleted file mode 100644
index 647d849..0000000
--- a/src/main/java/net/shibboleth/utilities/java/support/plugin/PluginDescription.java
+++ /dev/null
@@ -1,130 +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.utilities.java.support.plugin;
-
-import java.io.IOException;
-import java.net.URL;
-import java.nio.file.Path;
-import java.util.List;
-
-import javax.annotation.Nonnegative;
-import javax.annotation.Nonnull;
-
-import com.google.common.annotations.Beta;
-
-import net.shibboleth.utilities.java.support.annotation.constraint.NonnullElements;
-import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
-import net.shibboleth.utilities.java.support.annotation.constraint.Positive;
-import net.shibboleth.utilities.java.support.collection.Pair;
-
-/**
- * This class is exported (via the service API) by every plugin.
- */
- at Beta
- at Deprecated(forRemoval = true, since = "4.1")
-public interface PluginDescription {
-
- /** Return the unique identifier for the plugin. This name <em>MUST</em> be
- * <ul>
- * <li> renderable in all file systems (for instance alphanumerics, '-' and '.' only)</li>
- * <li> unique. This is best done using java module guidance</li>
- * </ul>
- * For instance <code>org.example.plugins.myplugin</code>
- *
- * @return The id of this plugin.
- */
- @Nonnull @NotEmpty public String getPluginId();
-
- /** Return the list of file names to be appended to
- * <code>idp.additional.properties</code>.
- * @return The list of names, potentially empty.
- */
- @Nonnull public List<String> getAdditionalPropertyFiles();
-
- /** Return the list of (idp.home) relative paths (of files, <em>not directories </em>)
- * to copy from the distribution into the IdP installation.
- *
- * <em>Not currently supported</em>
- *
- * <p>These files are copied non-destructively (if the file already exists
- * then it is not copied). Some paths are disallowed (for instance dist and system).
- * Directories are created if needed</p>
- * <p>
- * The dist folder is always copied, so no files from it should be included.</p>
- *
- * @return The list of paths.
- */
- @Nonnull public List<Path> getFilePathsToCopy();
-
- /** <p>Return the list of files <em>not directories </em> to get from 'external'
- * sources. This allows external content to be downloaded during installation.</p>
- *
- * <p>The first part of the pair is the source URL,
- * the second is a path relative to idp.home. These can include files
- * going to dist\edit-webapp in which case the path is expected to have the
- * plugin id appended. Sub directories are created if needed</p>
- *
- * @return The list.
- * @throws IOException if the resource construction failed.
- */
- @Nonnull public List<Pair<URL, Path>> getExternalFilePathsToCopy() throws IOException;
-
- /** Return the places to look for updates for this plugin package.
- * The format of the paths below this point is fixed.
- *
- * @return Zero or more URLs
- * @throws IOException if the resource construction failed.
- */
- @Nonnull @NonnullElements public List<URL> getUpdateURLs() throws IOException;
-
- /** Return this properties that require list merging.
- *
- * <em>Not currently supported</em>
- *
- * <p>Given
- * an property called (say) <code>idp.service.foo</code> in file <code>services.property</code>
- * and an init setting of <code>idp.service.foo.bar</code>, the output would be:</p>
- * <pre> idp.service.foo = BEAN.idp.service.foo.plugin-id.net.shibboleth.foo
- * idp.service.foo.OLD.plugin-id = shibboleth.AttributeFilterResources</pre>
- *
- * @return A list of pairs, the first element of the pair is the (relative) path of the property file
- * and the second is a list of property names to edit within that file.
- */
- @Nonnull public List<Pair<Path, List<String>>> getPropertyMerges();
-
- /** Return the major version, (as defined by the
- * <a href="https://wiki.shibboleth.net/confluence/display/DEV/Java+Product+Version+Policy">
- * Java Product Version Policy</a>.
- * @return The major version.
- */
- @Positive public int getMajorVersion();
-
- /** Return the minor version, (as defined by the
- * <a href="https://wiki.shibboleth.net/confluence/display/DEV/Java+Product+Version+Policy">
- * Java Product Version Policy</a>.
- * @return The minor version.
- */
- @Nonnegative public int getMinorVersion();
-
- /** Return The patch version, (as defined by the
- * <a href="https://wiki.shibboleth.net/confluence/display/DEV/Java+Product+Version+Policy">
- * Java Product Version Policy</a>.
- * @return The patch version.
- */
- @Nonnegative public int getPatchVersion();
-}
diff --git a/src/main/java/net/shibboleth/utilities/java/support/plugin/package-info.java b/src/main/java/net/shibboleth/utilities/java/support/plugin/package-info.java
deleted file mode 100644
index 48362c2..0000000
--- a/src/main/java/net/shibboleth/utilities/java/support/plugin/package-info.java
+++ /dev/null
@@ -1,21 +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.
- */
-/**
- * A set of APIs of general use in building plugins.
- */
-
-package net.shibboleth.utilities.java.support.plugin;
\ No newline at end of file
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list