[java-identity-provider] 03/03: IDP-1414 Deprecate V2 Scripted support

[Rod Widdowson]

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

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

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

commit be8e6faa07ef6483ecd885a05236ef0ddeaf964d
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Sat Apr 6 10:35:06 2019 +0100

    IDP-1414 Deprecate V2 Scripted support
    
    https://issues.shibboleth.net/jira/browse/IDP-1414
---
 .../common/attribute/provider/BasicAttribute.java         | 12 ++++++------
 .../attribute/provider/V2SAMLProfileRequestContext.java   | 15 +++++++++++++++
 2 files changed, 21 insertions(+), 6 deletions(-)

diff --git a/idp-attribute-resolver-impl/src/main/java/edu/internet2/middleware/shibboleth/common/attribute/provider/BasicAttribute.java b/idp-attribute-resolver-impl/src/main/java/edu/internet2/middleware/shibboleth/common/attribute/provider/BasicAttribute.java
index 60b4b9a..0a639dd 100644
--- a/idp-attribute-resolver-impl/src/main/java/edu/internet2/middleware/shibboleth/common/attribute/provider/BasicAttribute.java
+++ b/idp-attribute-resolver-impl/src/main/java/edu/internet2/middleware/shibboleth/common/attribute/provider/BasicAttribute.java
@@ -17,11 +17,10 @@
 
 package edu.internet2.middleware.shibboleth.common.attribute.provider;
 
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
 import net.shibboleth.idp.attribute.IdPAttribute;
 import net.shibboleth.idp.attribute.resolver.ad.impl.ScriptedIdPAttributeImpl;
+import net.shibboleth.utilities.java.support.primitive.DeprecationSupport;
+import net.shibboleth.utilities.java.support.primitive.DeprecationSupport.ObjectType;
 
 /**
  * A class which is here solely to provide compatibility for V2 scripted attribute definitions. The assumption is that a
@@ -29,8 +28,6 @@ import net.shibboleth.idp.attribute.resolver.ad.impl.ScriptedIdPAttributeImpl;
  */
 public class BasicAttribute extends ScriptedIdPAttributeImpl {
 
-    /** Log. */
-    private Logger log = LoggerFactory.getLogger(ScriptedIdPAttributeImpl.class);
 
     /**
      * Constructor.
@@ -39,6 +36,9 @@ public class BasicAttribute extends ScriptedIdPAttributeImpl {
      */
     public BasicAttribute(final String id) {
         super(new IdPAttribute(id), "Scripted Attribute Definition: ");
-        log.info("{}  Use of V2 emulated class \"BasicAttribute\", consider replacing this code", getLogPrefix());
+        // Deprecation is NEW in V3.4.4
+        DeprecationSupport.warnOnce(ObjectType.CLASS,
+                "edu.internet2.middleware.shibboleth.common.attribute.provider.BasicAttribute",
+                null, "IdPAttribute");
     }
 }
diff --git a/idp-attribute-resolver-impl/src/main/java/edu/internet2/middleware/shibboleth/common/attribute/provider/V2SAMLProfileRequestContext.java b/idp-attribute-resolver-impl/src/main/java/edu/internet2/middleware/shibboleth/common/attribute/provider/V2SAMLProfileRequestContext.java
index 172844d..46fbc23 100644
--- a/idp-attribute-resolver-impl/src/main/java/edu/internet2/middleware/shibboleth/common/attribute/provider/V2SAMLProfileRequestContext.java
+++ b/idp-attribute-resolver-impl/src/main/java/edu/internet2/middleware/shibboleth/common/attribute/provider/V2SAMLProfileRequestContext.java
@@ -26,6 +26,8 @@ import javax.xml.namespace.QName;
 
 import net.shibboleth.idp.attribute.resolver.context.AttributeResolutionContext;
 import net.shibboleth.utilities.java.support.logic.Constraint;
+import net.shibboleth.utilities.java.support.primitive.DeprecationSupport;
+import net.shibboleth.utilities.java.support.primitive.DeprecationSupport.ObjectType;
 import net.shibboleth.utilities.java.support.primitive.StringSupport;
 
 import org.joda.time.DateTime;
@@ -73,6 +75,8 @@ public class V2SAMLProfileRequestContext {
      * @return attribute ID
      */
     @Nullable protected String getId() {
+        // Deprecation is NEW in V3.4.4
+        DeprecationSupport.warnOnce(ObjectType.METHOD, "requestContext.getId()", null, null);
         return id;
     }
 
@@ -82,6 +86,9 @@ public class V2SAMLProfileRequestContext {
      * @return the Principal.
      */
     public String getPrincipalName() {
+        // Deprecation is NEW in V3.4.4
+        DeprecationSupport.warnOnce(ObjectType.METHOD, "requestContext.getPrincipalName()", null,
+                "resolutionContext.getPrincipal()");
         return resolutionContext.getPrincipal();
     }
 
@@ -91,6 +98,10 @@ public class V2SAMLProfileRequestContext {
      * @return the entityId.
      */
     public String getPeerEntityId() {
+        // Deprecation is NEW in V3.4.4
+        DeprecationSupport.warnOnce(ObjectType.METHOD, "requestContext.getPeerEntityId()",
+                null,
+                "resolutionContext.getAttributeRecipientID()");
         return resolutionContext.getAttributeRecipientID();
     }
 
@@ -100,6 +111,10 @@ public class V2SAMLProfileRequestContext {
      * @return the entityId.
      */
     public String getLocalEntityId() {
+        // Deprecation is NEW in V4.0
+        DeprecationSupport.warnOnce(ObjectType.METHOD,
+                "requestContext.getLocalEntityId()", null,
+                "resolutionContext.getAttributeIssuerID()");
         return resolutionContext.getAttributeIssuerID();
     }
 

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