[java-identity-provider] 03/03: Deprecate exportAllAttributes from the DataConnectors

[Rod Widdowson]

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

rdw pushed a commit to branch master
in repository java-identity-provider.

View the commit online:
http://git.shibboleth.net/view/?p=java-identity-provider.git;a=commit;h=978ba02f23d2c425cfb45e6c12534b1b72f9e23c

commit 978ba02f23d2c425cfb45e6c12534b1b72f9e23c
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Wed Jun 24 14:13:27 2020 +0100

    Deprecate exportAllAttributes from the DataConnectors
    
    This was a mistake which hasn't been trumpeted loudly.
---
 .../net/shibboleth/idp/attribute/resolver/AbstractDataConnector.java | 5 +++++
 .../attribute/resolver/spring/dc/AbstractDataConnectorParser.java    | 4 ++++
 2 files changed, 9 insertions(+)

diff --git a/idp-attribute-resolver-api/src/main/java/net/shibboleth/idp/attribute/resolver/AbstractDataConnector.java b/idp-attribute-resolver-api/src/main/java/net/shibboleth/idp/attribute/resolver/AbstractDataConnector.java
index 0344a7360..75f31cd0a 100644
--- a/idp-attribute-resolver-api/src/main/java/net/shibboleth/idp/attribute/resolver/AbstractDataConnector.java
+++ b/idp-attribute-resolver-api/src/main/java/net/shibboleth/idp/attribute/resolver/AbstractDataConnector.java
@@ -39,7 +39,9 @@ import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
 import net.shibboleth.utilities.java.support.annotation.constraint.Unmodifiable;
 import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
 import net.shibboleth.utilities.java.support.component.ComponentSupport;
+import net.shibboleth.utilities.java.support.primitive.DeprecationSupport;
 import net.shibboleth.utilities.java.support.primitive.StringSupport;
+import net.shibboleth.utilities.java.support.primitive.DeprecationSupport.ObjectType;
 
 /** Base class for data connector resolver plugins. */
 @ThreadSafe
@@ -62,6 +64,7 @@ public abstract class AbstractDataConnector extends AbstractResolverPlugin<Map<S
     @Nonnull private Duration noRetryDelay;
 
     /** Do we release all attributes?. */
+    @Deprecated(since = "4.1.0", forRemoval = true)
     private boolean exportAllAttributes;
 
     /** Which named attributes do we release?. */
@@ -133,6 +136,7 @@ public abstract class AbstractDataConnector extends AbstractResolverPlugin<Map<S
      *
      * @param what whether we export all attributes
      */
+    @Deprecated(since = "4.1.0", forRemoval = true)
     public void setExportAllAttributes(final boolean what) {
         ComponentSupport.ifDestroyedThrowDestroyedComponentException(this);
         ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
@@ -142,6 +146,7 @@ public abstract class AbstractDataConnector extends AbstractResolverPlugin<Map<S
     /**
      * {@inheritDoc}
      */
+    @Deprecated(since = "4.1.0", forRemoval = true)
     @Override public boolean isExportAllAttributes() {
         return exportAllAttributes;
     }
diff --git a/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/dc/AbstractDataConnectorParser.java b/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/dc/AbstractDataConnectorParser.java
index c20b09d48..ffecc9871 100644
--- a/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/dc/AbstractDataConnectorParser.java
+++ b/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/dc/AbstractDataConnectorParser.java
@@ -28,7 +28,9 @@ import net.shibboleth.idp.attribute.resolver.spring.BaseResolverPluginParser;
 import net.shibboleth.idp.attribute.resolver.spring.dc.impl.DataConnectorFactoryBean;
 import net.shibboleth.idp.attribute.resolver.spring.impl.AttributeResolverNamespaceHandler;
 import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
+import net.shibboleth.utilities.java.support.primitive.DeprecationSupport;
 import net.shibboleth.utilities.java.support.primitive.StringSupport;
+import net.shibboleth.utilities.java.support.primitive.DeprecationSupport.ObjectType;
 import net.shibboleth.utilities.java.support.xml.ElementSupport;
 
 import org.slf4j.Logger;
@@ -150,6 +152,8 @@ public abstract class AbstractDataConnectorParser extends BaseResolverPluginPars
             if (config.hasAttributeNS(null, ATTR_EXPORT_NAMES)) {
                 log.warn("{} {} overrides {}", getLogPrefix(), ATTR_EXPORT_ALL, ATTR_EXPORT_NAMES);
             }
+            DeprecationSupport.warnOnce(ObjectType.ATTRIBUTE, "exportAllAttributes", null,
+                    "exportAttributes=\"attr1, attr2,...\"");
             builder.addPropertyValue("exportAllAttributes",
                     StringSupport.trimOrNull(config.getAttributeNS(null, ATTR_EXPORT_ALL)));
         } else if (config.hasAttributeNS(null, ATTR_EXPORT_NAMES)) {

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