[java-identity-provider] 01/06: IDP-1121 Add comments to V4 deprecations

[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=47315f74a4746fc9ff5d182b9713418487b163fd

commit 47315f74a4746fc9ff5d182b9713418487b163fd
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Tue Apr 2 16:19:01 2019 +0100

    IDP-1121 Add comments to V4 deprecations
    
    https://issues.shibboleth.net/jira/browse/IDP-1121
---
 .../shibboleth/common/attribute/provider/BasicAttribute.java          | 1 +
 .../common/attribute/provider/V2SAMLProfileRequestContext.java        | 4 ++++
 .../resolver/spring/ad/impl/TemplateAttributeDefinitionParser.java    | 1 +
 .../attribute/resolver/spring/dc/impl/ScriptDataConnectorParser.java  | 1 +
 4 files changed, 7 insertions(+)

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 6cc62e5..18b4c25 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
@@ -36,6 +36,7 @@ public class BasicAttribute extends ScriptedIdPAttributeImpl {
      */
     public BasicAttribute(final String id) {
         super(new IdPAttribute(id), "Scripted Attribute Definition: ");
+        // Deprecation is NEW in V4.0
         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 0f6e1c7..1f9cd4b 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
@@ -75,6 +75,7 @@ public class V2SAMLProfileRequestContext {
      * @return attribute ID
      */
     @Nullable protected String getId() {
+        // Deprecation is NEW in V4.0
         DeprecationSupport.warnOnce(ObjectType.METHOD, "requestContext.getId()", null, null);
         return id;
     }
@@ -85,6 +86,7 @@ public class V2SAMLProfileRequestContext {
      * @return the Principal.
      */
     public String getPrincipalName() {
+        // Deprecation is NEW in V4.0
         DeprecationSupport.warnOnce(ObjectType.METHOD, "requestContext.getPrincipalName()", null, null);
         return resolutionContext.getPrincipal();
     }
@@ -95,6 +97,7 @@ public class V2SAMLProfileRequestContext {
      * @return the entityId.
      */
     public String getPeerEntityId() {
+        // Deprecation is NEW in V4.0
         DeprecationSupport.warnOnce(ObjectType.METHOD, "requestContext.getPeerEntityId()", null, null);
         return resolutionContext.getAttributeRecipientID();
     }
@@ -105,6 +108,7 @@ public class V2SAMLProfileRequestContext {
      * @return the entityId.
      */
     public String getLocalEntityId() {
+        // Deprecation is NEW in V4.0
         DeprecationSupport.warnOnce(ObjectType.METHOD, "requestContext.getLocalEntityId()", null, null);
         return resolutionContext.getAttributeIssuerID();
     }
diff --git a/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/ad/impl/TemplateAttributeDefinitionParser.java b/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/ad/impl/TemplateAttributeDefinitionParser.java
index 7f9bc89..bc2e8d0 100644
--- a/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/ad/impl/TemplateAttributeDefinitionParser.java
+++ b/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/ad/impl/TemplateAttributeDefinitionParser.java
@@ -87,6 +87,7 @@ public class TemplateAttributeDefinitionParser extends BaseAttributeDefinitionPa
         final List<Element> sourceAttributeElements =
             ElementSupport.getChildElements(config, SOURCE_ATTRIBUTE_ELEMENT_NAME_RESOLVER);
         if (null != sourceAttributeElements && !sourceAttributeElements.isEmpty()) {
+            // V4 deprecation
             DeprecationSupport.warnOnce(ObjectType.ELEMENT, SOURCE_ATTRIBUTE_ELEMENT_NAME_RESOLVER.getLocalPart(),
                     parserContext.getReaderContext().getResource().getDescription(),
                     "by using <InputAttributeDefinition> and <InputDataConnector>");
diff --git a/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/dc/impl/ScriptDataConnectorParser.java b/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/dc/impl/ScriptDataConnectorParser.java
index e70f8ad..b5fb3e2 100644
--- a/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/dc/impl/ScriptDataConnectorParser.java
+++ b/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/dc/impl/ScriptDataConnectorParser.java
@@ -66,6 +66,7 @@ public class ScriptDataConnectorParser extends AbstractDataConnectorParser {
     @Override protected void doParse(@Nonnull final Element config, @Nonnull final ParserContext parserContext,
             @Nonnull final BeanDefinitionBuilder builder) {
         if (isNative(config)) {
+            // V4 Deprecation
             DeprecationSupport.warnOnce(ObjectType.ATTRIBUTE, ATTR_SPRING_RESOURCE, null,null);
         }
         super.doParse(config, parserContext, builder);

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