From f5dc9169edd2e2532e48b59649ac292e2b6b5def Mon Sep 17 00:00:00 2001
From: Ian Young <ian@iay.org.uk>
Date: Thu, 10 Jun 2021 14:58:39 +0100
Subject: [PATCH] Deconflict IdP discovery names using
 IdPDisplayNameDuplicateAvoidingStage

See ukf/ukf-meta#63.
---
 mdx/common-beans.xml | 209 ++++++++++++++++++++++---------------------
 mdx/uk/generate.xml  |  77 ++++++----------
 2 files changed, 131 insertions(+), 155 deletions(-)

diff --git a/mdx/common-beans.xml b/mdx/common-beans.xml
index 092ab294..645e6681 100644
--- a/mdx/common-beans.xml
+++ b/mdx/common-beans.xml
@@ -456,119 +456,123 @@
     <bean id="za_safire_registrar"       parent="String" c:_="https://safire.ac.za"/>
     <bean id="zm_fidern_registrar"       parent="String" c:_="https://fidern.ac.zm"/>
 
-
+    <!--
+        registrationAuthorityDisplayNameMap
+
+        Map from registration authority URIs to short codes
+        suitable for presentation in messages.
+    -->
+    <util:map id="registrationAuthorityDisplayNameMap">
+        <!--
+            eduGAIN participant registration authority display names as country codes.
+
+            The display name for a country with only one registrar
+            is the ISO 2-letter country code.
+
+            If there is more than one registrar, each will be given
+            a display name constructed from the country code, a hyphen,
+            and a federation acronym.
+
+            The ordering here is as on the eduGAIN status page:
+
+            https://technical.edugain.org/status
+        -->
+        <entry key-ref="au_aaf_registrar"             value="AU"/>
+        <entry key-ref="hr_eduhr_registrar"           value="HR"/>
+        <entry key-ref="mk_aaiedumk_registrar"        value="MK"/>
+        <entry key-ref="at_aconet_registrar"          value="AT"/>
+        <entry key-ref="am_afire_registrar"           value="AM"/>
+        <entry key-ref="dz_arnaai_registrar"          value="DZ"/>
+        <entry key-ref="si_arnes_registrar"           value="SI"/>
+        <entry key-ref="be_belnet_registrar"          value="BE"/>
+        <entry key-ref="ca_caf_registrar"             value="CA"/>
+        <entry key-ref="br_cafe_registrar"            value="BR"/>
+        <entry key-ref="mz_cafmoz_registrar"          value="MZ"/>
+        <entry key-ref="cn_carsi_registrar"           value="CN-CARSI"/>
+        <entry key-ref="cl_cofre_registrar"           value="CL"/>
+        <entry key-ref="co_colfire_registrar"         value="CO"/>
+        <entry key-ref="cy_cynet_registrar"           value="CY"/>
+        <entry key-ref="de_dfnaai_registrar"          value="DE"/>
+        <entry key-ref="ie_edugate_registrar"         value="IE"/>
+        <entry key-ref="cz_eduid_registrar"           value="CZ"/>
+        <entry key-ref="hu_eduid_registrar"           value="HU"/>
+        <entry key-ref="lu_eduid_registrar"           value="LU"/>
+        <entry key-ref="ma_eduidm_registrar"          value="MA"/>
+        <entry key-ref="by_febas_registrar"           value="BY"/>
+        <entry key-ref="ru_fedurus_registrar"         value="RU-FEDURUS"/>
+        <entry key-ref="no_feide_registrar"           value="NO"/>
+        <entry key-ref="fr_renater_registrar"         value="FR"/>
+        <entry key-ref="zm_fidern_registrar"          value="ZM"/>
+        <entry key-ref="jp_gakunin_registrar"         value="JP"/>
+        <entry key-ref="ge_gif_registrar"             value="GE"/>
+        <entry key-ref="gr_grnet_registrar"           value="GR"/>
+        <entry key-ref="fi_haka_registrar"            value="FI"/>
+        <entry key-ref="hk_hkaf_registrar"            value="HK"/>
+        <entry key-ref="it_idem_registrar"            value="IT"/>
+        <entry key-ref="us_incommon_registrar"        value="US"/>
+        <entry key-ref="in_infed_registrar"           value="IN"/>
+        <entry key-ref="ir_irfed_registrar"           value="IR"/>
+        <entry key-ref="il_iif_registrar"             value="IL"/>
+        <entry key-ref="kr_kafe_registrar"            value="KR"/>
+        <entry key-ref="kg_krena_registrar"           value="KG"/>
+        <entry key-ref="lv_laife_registrar"           value="LV"/>
+        <entry key-ref="md_leaf_registrar"            value="MD"/>
+        <entry key-ref="lt_litnet_registrar"          value="LT"/>
+        <entry key-ref="lk_liaf_registrar"            value="LK"/>
+        <entry key-ref="ar_mate_registrar"            value="AR"/>
+        <entry key-ref="ec_minga_registrar"           value="EC"/>
+        <entry key-ref="om_omankid_registrar"         value="OM-KID"/>
+        <entry key-ref="om_omren_registrar"           value="OM-REN"/>
+        <entry key-ref="ua_peano_registrar"           value="UA"/>
+        <entry key-ref="pl_pionier_registrar"         value="PL"/>
+        <entry key-ref="pk_pkifed_registrar"          value="PK"/>
+        <entry key-ref="al_rash_registrar"            value="AL"/>
+        <entry key-ref="pt_rctsaai_registrar"         value="PT"/>
+        <entry key-ref="mt_ricerca_registrar"         value="MT"/>
+        <entry key-ref="ug_rif_registrar"             value="UG"/>
+        <entry key-ref="ro_edunetid_registrar"        value="RO"/>
+        <entry key-ref="ru_runnet_registrar"          value="RU-RUNNET"/>
+        <entry key-ref="sa_maeen_registrar"           value="SA"/>
+        <entry key-ref="za_safire_registrar"          value="ZA"/>
+        <entry key-ref="sg_sgaf_registrar"            value="SG"/>
+        <entry key-ref="my_sifulan_registrar"         value="MY"/>
+        <entry key-ref="es_sir_registrar"             value="ES"/>
+        <entry key-ref="nl_surfconext_registrar"      value="NL"/>
+        <entry key-ref="se_swamid_registrar"          value="SE"/>
+        <entry key-ref="ch_switchaai_registrar"       value="CH"/>
+        <entry key-ref="ee_taat_registrar"            value="EE"/>
+        <entry key-ref="nz_tuakiri_registrar"         value="NZ"/>
+        <entry key-ref="uk_ukf_registrar"             value="UK"/>
+        <entry key-ref="dk_wayf_registrar"            value="DK"/>
+        <entry key-ref="tr_yetkim_registrar"          value="TR"/>
+
+        <!-- eduGAIN voting-only members -->
+        <entry key-ref="bg_bif_registrar"             value="BG"/>
+        <entry key-ref="it_gridp_registrar"           value="IT-GRIDP"/>
+
+        <!-- eduGAIN candidates -->
+        <entry key-ref="cn_cstcloud_registrar"        value="CN-CSTCLOUD"/>
+        <entry key-ref="me_eduid_registrar"           value="ME"/>
+        <entry key-ref="mx_fenix_registrar"           value="MX"/>
+        <entry key-ref="rs_amres_registrar"           value="RS"/>
+        <entry key-ref="lb_life_registrar"            value="LB"/>
+        <entry key-ref="mw_maren_registrar"           value="MW"/>
+        <entry key-ref="sk_safeid_registrar"          value="SK"/>
+        <entry key-ref="tj_tarena_registrar"          value="TJ"/>
+    </util:map>
 
     <!--
         identificationStrategy
 
         Standard item identifier strategy.
     -->
-    <bean id="identificationStrategy" class="uk.org.ukfederation.mda.UKItemIdentificationStrategy">
+    <bean id="identificationStrategy" class="uk.org.ukfederation.mda.UKItemIdentificationStrategy"
+        p:registrationAuthorityDisplayNames-ref="registrationAuthorityDisplayNameMap">
         <property name="ignoredRegistrationAuthorities">
             <set>
                 <ref bean="uk_ukf_registrar"/>
             </set>
         </property>
-        <property name="registrationAuthorityDisplayNames">
-            <map>
-                <!--
-                    eduGAIN participant registration authority display names as country codes.
-
-                    The display name for a country with only one registrar
-                    is the ISO 2-letter country code.
-
-                    If there is more than one registrar, each will be given
-                    a display name constructed from the country code, a hyphen,
-                    and a federation acronym.
-
-                    The ordering here is as on the eduGAIN status page:
-
-                    https://technical.edugain.org/status
-                -->
-                <entry key-ref="au_aaf_registrar"             value="AU"/>
-                <entry key-ref="hr_eduhr_registrar"           value="HR"/>
-                <entry key-ref="mk_aaiedumk_registrar"        value="MK"/>
-                <entry key-ref="at_aconet_registrar"          value="AT"/>
-                <entry key-ref="am_afire_registrar"           value="AM"/>
-                <entry key-ref="dz_arnaai_registrar"          value="DZ"/>
-                <entry key-ref="si_arnes_registrar"           value="SI"/>
-                <entry key-ref="be_belnet_registrar"          value="BE"/>
-                <entry key-ref="ca_caf_registrar"             value="CA"/>
-                <entry key-ref="br_cafe_registrar"            value="BR"/>
-                <entry key-ref="mz_cafmoz_registrar"          value="MZ"/>
-                <entry key-ref="cn_carsi_registrar"           value="CN-CARSI"/>
-                <entry key-ref="cl_cofre_registrar"           value="CL"/>
-                <entry key-ref="co_colfire_registrar"         value="CO"/>
-                <entry key-ref="cy_cynet_registrar"           value="CY"/>
-                <entry key-ref="de_dfnaai_registrar"          value="DE"/>
-                <entry key-ref="ie_edugate_registrar"         value="IE"/>
-                <entry key-ref="cz_eduid_registrar"           value="CZ"/>
-                <entry key-ref="hu_eduid_registrar"           value="HU"/>
-                <entry key-ref="lu_eduid_registrar"           value="LU"/>
-                <entry key-ref="ma_eduidm_registrar"          value="MA"/>
-                <entry key-ref="by_febas_registrar"           value="BY"/>
-                <entry key-ref="ru_fedurus_registrar"         value="RU-FEDURUS"/>
-                <entry key-ref="no_feide_registrar"           value="NO"/>
-                <entry key-ref="fr_renater_registrar"         value="FR"/>
-                <entry key-ref="zm_fidern_registrar"          value="ZM"/>
-                <entry key-ref="jp_gakunin_registrar"         value="JP"/>
-                <entry key-ref="ge_gif_registrar"             value="GE"/>
-                <entry key-ref="gr_grnet_registrar"           value="GR"/>
-                <entry key-ref="fi_haka_registrar"            value="FI"/>
-                <entry key-ref="hk_hkaf_registrar"            value="HK"/>
-                <entry key-ref="it_idem_registrar"            value="IT"/>
-                <entry key-ref="us_incommon_registrar"        value="US"/>
-                <entry key-ref="in_infed_registrar"           value="IN"/>
-                <entry key-ref="ir_irfed_registrar"           value="IR"/>
-                <entry key-ref="il_iif_registrar"             value="IL"/>
-                <entry key-ref="kr_kafe_registrar"            value="KR"/>
-                <entry key-ref="kg_krena_registrar"           value="KG"/>
-                <entry key-ref="lv_laife_registrar"           value="LV"/>
-                <entry key-ref="md_leaf_registrar"            value="MD"/>
-                <entry key-ref="lt_litnet_registrar"          value="LT"/>
-                <entry key-ref="lk_liaf_registrar"            value="LK"/>
-                <entry key-ref="ar_mate_registrar"            value="AR"/>
-                <entry key-ref="ec_minga_registrar"           value="EC"/>
-                <entry key-ref="om_omankid_registrar"         value="OM-KID"/>
-                <entry key-ref="om_omren_registrar"           value="OM-REN"/>
-                <entry key-ref="ua_peano_registrar"           value="UA"/>
-                <entry key-ref="pl_pionier_registrar"         value="PL"/>
-                <entry key-ref="pk_pkifed_registrar"          value="PK"/>
-                <entry key-ref="al_rash_registrar"            value="AL"/>
-                <entry key-ref="pt_rctsaai_registrar"         value="PT"/>
-                <entry key-ref="mt_ricerca_registrar"         value="MT"/>
-                <entry key-ref="ug_rif_registrar"             value="UG"/>
-                <entry key-ref="ro_edunetid_registrar"        value="RO"/>
-                <entry key-ref="ru_runnet_registrar"          value="RU-RUNNET"/>
-                <entry key-ref="sa_maeen_registrar"           value="SA"/>
-                <entry key-ref="za_safire_registrar"          value="ZA"/>
-                <entry key-ref="sg_sgaf_registrar"            value="SG"/>
-                <entry key-ref="my_sifulan_registrar"         value="MY"/>
-                <entry key-ref="es_sir_registrar"             value="ES"/>
-                <entry key-ref="nl_surfconext_registrar"      value="NL"/>
-                <entry key-ref="se_swamid_registrar"          value="SE"/>
-                <entry key-ref="ch_switchaai_registrar"       value="CH"/>
-                <entry key-ref="ee_taat_registrar"            value="EE"/>
-                <entry key-ref="nz_tuakiri_registrar"         value="NZ"/>
-                <entry key-ref="uk_ukf_registrar"             value="UK"/>
-                <entry key-ref="dk_wayf_registrar"            value="DK"/>
-                <entry key-ref="tr_yetkim_registrar"          value="TR"/>
-
-                <!-- eduGAIN voting-only members -->
-                <entry key-ref="bg_bif_registrar"             value="BG"/>
-                <entry key-ref="it_gridp_registrar"           value="IT-GRIDP"/>
-
-                <!-- eduGAIN candidates -->
-                <entry key-ref="cn_cstcloud_registrar"        value="CN-CSTCLOUD"/>
-                <entry key-ref="me_eduid_registrar"           value="ME"/>
-                <entry key-ref="mx_fenix_registrar"           value="MX"/>
-                <entry key-ref="rs_amres_registrar"           value="RS"/>
-                <entry key-ref="lb_life_registrar"            value="LB"/>
-                <entry key-ref="mw_maren_registrar"           value="MW"/>
-                <entry key-ref="sk_safeid_registrar"          value="SK"/>
-                <entry key-ref="tj_tarena_registrar"          value="TJ"/>
-            </map>
-        </property>
     </bean>
 
     <!--
@@ -1223,7 +1227,6 @@
 
                 <ref bean="checkSchemas"/>
                 <ref bean="CHECK_std"/>
-                <ref bean="check_dup_display"/>
                 <ref bean="check_namespaces"/>
 
                 <bean id="checkCertificates" parent="mda.X509ValidationStage">
diff --git a/mdx/uk/generate.xml b/mdx/uk/generate.xml
index 8c63d02b..478b42f4 100644
--- a/mdx/uk/generate.xml
+++ b/mdx/uk/generate.xml
@@ -302,12 +302,6 @@
                 <bean id="flowConstraints" parent="ukf.FlowConstraintApplyingStage"
                     p:flowName="production"/>
 
-                <!--
-                    Enforce IdP display name uniqueness before assembling aggregate
-                -->
-                <ref bean="check_dup_display"/>
-                <ref bean="errorTerminatingFilter"/>
-
                 <ref bean="assembleAggregate"/>
                 <bean parent="mda.SetCacheDurationStage"
                     p:cacheDuration="${cacheDuration.aggregate.duration}"/>
@@ -365,18 +359,12 @@
                 <!-- Apply flow constraints for this flow. -->
                 <bean id="flowConstraints" parent="ukf.FlowConstraintApplyingStage"
                     p:flowName="wayf"/>
-                
+
                 <!--
                     Remove SIRTFI metadata.
                 -->
                 <ref bean="strip.SIRTFI"/>
 
-                <!--
-                    Enforce IdP display name uniqueness before assembling aggregate
-                -->
-                <ref bean="check_dup_display"/>
-                <ref bean="errorTerminatingFilter"/>
-
                 <ref bean="assembleAggregate"/>
                 <bean parent="mda.SetCacheDurationStage"
                     p:cacheDuration="${cacheDuration.aggregate.duration}"/>
@@ -493,12 +481,6 @@
                 <!-- Apply flow constraints for this flow. -->
                 <bean id="flowConstraints" parent="ukf.FlowConstraintApplyingStage"
                     p:flowName="cdsall"/>
-                
-                <!--
-                    Enforce IdP display name uniqueness before assembling aggregate
-                -->
-                <ref bean="check_dup_display"/>
-                <ref bean="errorTerminatingFilter"/>
 
                 <!-- make an aggregate first so that we're only traversing one item -->
                 <ref bean="assembleAggregate"/>
@@ -561,12 +543,6 @@
                 <bean id="flowConstraints" parent="ukf.FlowConstraintApplyingStage"
                     p:flowName="wugen"/>
 
-                <!--
-                    Enforce IdP display name uniqueness before assembling aggregate
-                -->
-                <ref bean="check_dup_display"/>
-                <ref bean="errorTerminatingFilter"/>
-
                 <!-- make an aggregate first so that we're only traversing one item -->
                 <ref bean="assembleAggregate"/>
 
@@ -631,17 +607,11 @@
                 <!-- Apply flow constraints for this flow. -->
                 <bean id="flowConstraints" parent="ukf.FlowConstraintApplyingStage"
                     p:flowName="fallback"/>
-                
+
                 <bean id="removeFallbackBlocklist" parent="mda.EntityFilterStage"
                     p:whitelistingEntities="false"
                     p:designatedEntities-ref="fallbackEntityBlocklist"/>
 
-                <!--
-                    Enforce IdP display name uniqueness before assembling aggregate
-                -->
-                <ref bean="check_dup_display"/>
-                <ref bean="errorTerminatingFilter"/>
-
                 <ref bean="assembleAggregate"/>
                 <bean parent="mda.SetCacheDurationStage"
                     p:cacheDuration="${cacheDuration.aggregate.duration}"/>
@@ -697,12 +667,6 @@
                 <!-- Apply flow constraints for this flow. -->
                 <bean id="flowConstraints" parent="ukf.FlowConstraintApplyingStage"
                     p:flowName="test"/>
-                
-                <!--
-                    Enforce IdP display name uniqueness before assembling aggregate
-                -->
-                <ref bean="check_dup_display"/>
-                <ref bean="errorTerminatingFilter"/>
 
                 <ref bean="uk_strip_UKFederationMember"/>
                 <ref bean="assembleAggregate"/>
@@ -765,7 +729,7 @@
                 <!-- Apply flow constraints for this flow. -->
                 <bean id="flowConstraints" parent="ukf.FlowConstraintApplyingStage"
                     p:flowName="export"/>
-                
+
                 <!--
                     Additional rules excluding entities from the aggregate.
 
@@ -819,12 +783,6 @@
                     </property>
                 </bean>
 
-                <!--
-                    Enforce IdP display name uniqueness before assembling aggregate
-                -->
-                <ref bean="check_dup_display"/>
-                <ref bean="errorTerminatingFilter"/>
-
                 <ref bean="stripUkfedlabelNamespace"/>
                 <ref bean="assembleAggregate"/>
                 <bean parent="mda.SetCacheDurationStage"
@@ -874,7 +832,7 @@
                 <!-- Apply flow constraints for this flow. -->
                 <bean id="flowConstraints" parent="ukf.FlowConstraintApplyingStage"
                     p:flowName="export-preview"/>
-                
+
                 <!--
                     Additional rules excluding entities from the aggregate.
 
@@ -928,12 +886,6 @@
                     </property>
                 </bean>
 
-                <!--
-                    Enforce IdP display name uniqueness before assembling aggregate
-                -->
-                <ref bean="check_dup_display"/>
-                <ref bean="errorTerminatingFilter"/>
-
                 <ref bean="stripUkfedlabelNamespace"/>
                 <ref bean="assembleAggregate"/>
                 <bean parent="mda.SetCacheDurationStage"
@@ -1101,6 +1053,15 @@
                     </property>
                 </bean>
 
+                <!--
+                    Deconflict the discovery names of any entities
+                    brought in from production metadata exchange sources.
+                -->
+                <bean id="deconflictProductionMDXEntities"
+                    parent="ukf.IdPDisplayNameDuplicateAvoidingStage"
+                    p:registrationAuthorityDisplayNames-ref="registrationAuthorityDisplayNameMap"
+                />
+
                 <!--
                     *************************************************
                     ***                                           ***
@@ -1157,6 +1118,18 @@
                     </property>
                 </bean>
 
+                <!--
+                    Deconflict the discovery names of any entities
+                    brought in from pre-production metadata exchange sources.
+
+                    This will not affect entities from production sources
+                    which have already been renamed.
+                -->
+                <bean id="deconflictPreproductionMDXEntities"
+                    parent="ukf.IdPDisplayNameDuplicateAvoidingStage"
+                    p:registrationAuthorityDisplayNames-ref="registrationAuthorityDisplayNameMap"
+                />
+
                 <!--
                     *********************************************************
                     ***                                                   ***