[java-identity-provider] branch main updated: IDP-1751 - SAML2NameID Attribute Definition not documented

[Scott Cantor]

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

scantor 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=36d0be2239b0aa5110fb7e0d30d92f2da4e04c95

The following commit(s) were added to refs/heads/main by this push:
       new  36d0be223 IDP-1751 - SAML2NameID Attribute Definition not documented
36d0be223 is described below

commit 36d0be2239b0aa5110fb7e0d30d92f2da4e04c95
Author: Scott Cantor <cantor.2 at osu.edu>
AuthorDate: Mon Feb 15 08:54:29 2021 -0500

    IDP-1751 - SAML2NameID Attribute Definition not documented
    
    https://issues.shibboleth.net/jira/browse/IDP-1751
    
    Add deprecation warnings.
---
 .../ad/impl/SAML1NameIdentifierAttributeDefinitionParser.java     | 8 +++++++-
 .../spring/ad/impl/SAML2NameIDAttributeDefinitionParser.java      | 6 ++++++
 .../resolver/impl/SAML1NameIdentifierAttributeDefinition.java     | 4 +++-
 .../attribute/resolver/impl/SAML2NameIDAttributeDefinition.java   | 4 +++-
 4 files changed, 19 insertions(+), 3 deletions(-)

diff --git a/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/ad/impl/SAML1NameIdentifierAttributeDefinitionParser.java b/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/ad/impl/SAML1NameIdentifierAttributeDefinitionParser.java
index 5270f3393..f070a2124 100644
--- a/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/ad/impl/SAML1NameIdentifierAttributeDefinitionParser.java
+++ b/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/ad/impl/SAML1NameIdentifierAttributeDefinitionParser.java
@@ -30,9 +30,12 @@ import org.w3c.dom.Element;
 import net.shibboleth.idp.attribute.resolver.spring.ad.BaseAttributeDefinitionParser;
 import net.shibboleth.idp.attribute.resolver.spring.impl.AttributeResolverNamespaceHandler;
 import net.shibboleth.idp.saml.attribute.resolver.impl.SAML1NameIdentifierAttributeDefinition;
+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;
 
 /** Spring bean definition parser for SAML 1 NameIdentifier attribute definitions. */
+ at SuppressWarnings("removal")
 public class SAML1NameIdentifierAttributeDefinitionParser extends BaseAttributeDefinitionParser {
 
     /** Schema type name. */
@@ -49,7 +52,10 @@ public class SAML1NameIdentifierAttributeDefinitionParser extends BaseAttributeD
 
     /** {@inheritDoc} */
     @Override protected void doParse(@Nonnull final Element config, @Nonnull final ParserContext parserContext,
-            @Nonnull final BeanDefinitionBuilder builder) {
+            @Nonnull final BeanDefinitionBuilder builder) {        
+        DeprecationSupport.warn(ObjectType.XSITYPE, "SAML1NameIdentifier",
+                parserContext.getReaderContext().getResource().getDescription(), "(none)");
+        
         super.doParse(config, parserContext, builder);
 
         final String nameIdQualifier = StringSupport.trimOrNull(config.getAttributeNS(null, "nameIdQualifier"));
diff --git a/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/ad/impl/SAML2NameIDAttributeDefinitionParser.java b/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/ad/impl/SAML2NameIDAttributeDefinitionParser.java
index 694a01803..14e05db77 100644
--- a/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/ad/impl/SAML2NameIDAttributeDefinitionParser.java
+++ b/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/ad/impl/SAML2NameIDAttributeDefinitionParser.java
@@ -30,9 +30,12 @@ import org.w3c.dom.Element;
 import net.shibboleth.idp.attribute.resolver.spring.ad.BaseAttributeDefinitionParser;
 import net.shibboleth.idp.attribute.resolver.spring.impl.AttributeResolverNamespaceHandler;
 import net.shibboleth.idp.saml.attribute.resolver.impl.SAML2NameIDAttributeDefinition;
+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;
 
 /** Spring bean definition parser for SAML 2 NameID attribute definitions. */
+ at SuppressWarnings("removal")
 public class SAML2NameIDAttributeDefinitionParser extends BaseAttributeDefinitionParser {
 
     /** Schema type name. */
@@ -50,6 +53,9 @@ public class SAML2NameIDAttributeDefinitionParser extends BaseAttributeDefinitio
     /** {@inheritDoc} */
     @Override protected void doParse(@Nonnull final Element config, @Nonnull final ParserContext parserContext,
             @Nonnull final BeanDefinitionBuilder builder) {
+        DeprecationSupport.warn(ObjectType.XSITYPE, "SAML2NameID",
+                parserContext.getReaderContext().getResource().getDescription(), "(none)");
+
         super.doParse(config, parserContext, builder);
 
         if (config.hasAttributeNS(null, "nameIdFormat")) {
diff --git a/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/attribute/resolver/impl/SAML1NameIdentifierAttributeDefinition.java b/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/attribute/resolver/impl/SAML1NameIdentifierAttributeDefinition.java
index 86280496c..82bfcfe3a 100644
--- a/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/attribute/resolver/impl/SAML1NameIdentifierAttributeDefinition.java
+++ b/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/attribute/resolver/impl/SAML1NameIdentifierAttributeDefinition.java
@@ -49,8 +49,10 @@ import org.slf4j.LoggerFactory;
  * <p>When building the NameIdentifier the textual content of the NameIdentifier is the value of the source attribute.
  * If a {@link #nameIdQualifier} is provided that value is used as the NameIdentifier's NameQualifier otherwise the
  * attribute issuer's entity ID is used.</p>
+ * 
+ * @deprecated
  */
-
+ at Deprecated(forRemoval=true, since="4.1.0")
 public class SAML1NameIdentifierAttributeDefinition extends AbstractAttributeDefinition {
 
     /** Class logger. */
diff --git a/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/attribute/resolver/impl/SAML2NameIDAttributeDefinition.java b/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/attribute/resolver/impl/SAML2NameIDAttributeDefinition.java
index 1c41dd35e..136197af4 100644
--- a/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/attribute/resolver/impl/SAML2NameIDAttributeDefinition.java
+++ b/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/attribute/resolver/impl/SAML2NameIDAttributeDefinition.java
@@ -51,8 +51,10 @@ import org.slf4j.LoggerFactory;
  * {@link #nameIdQualifier} is provided that value is used as the NameID's NameQualifier otherwise the attribute
  * issuer's entity ID is used. If a {@link #nameIdSPQualifier} is provided then that valid is used as the NameID's
  * SPNameQualifier, otherwise the attribute recipient's entityID is used.</p>
+ * 
+ * @deprecated
  */
-
+ at Deprecated(forRemoval=true, since="4.1.0")
 public class SAML2NameIDAttributeDefinition extends AbstractAttributeDefinition {
 
     /** Class logger. */

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