diff --git a/build.xml b/build.xml index ed2f6bf1..925e6c15 100644 --- a/build.xml +++ b/build.xml @@ -1051,20 +1051,11 @@ Running @{channel} @{verb} flow. - + + + + + + + + + Completed @{channel} @{verb} flow. diff --git a/mdx/au_aaf/beans.xml b/mdx/au_aaf/beans.xml index 81f76ee2..c868a40f 100644 --- a/mdx/au_aaf/beans.xml +++ b/mdx/au_aaf/beans.xml @@ -6,11 +6,11 @@ xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd"> - - + + @@ -18,7 +18,8 @@ - + @@ -29,9 +30,32 @@ - - - + + + + + + + + + + + + + + + + + + + + + + diff --git a/mdx/au_aaf/import.xml b/mdx/au_aaf/verbs.xml similarity index 57% rename from mdx/au_aaf/import.xml rename to mdx/au_aaf/verbs.xml index d815e5b7..5cba8088 100644 --- a/mdx/au_aaf/import.xml +++ b/mdx/au_aaf/verbs.xml @@ -1,6 +1,6 @@ @@ -15,9 +15,9 @@ --> - - + @@ -26,24 +26,14 @@ - - + - - - - - - - - - - + - - + diff --git a/mdx/ca_caf/beans.xml b/mdx/ca_caf/beans.xml index 6f354f5f..fe4245e0 100644 --- a/mdx/ca_caf/beans.xml +++ b/mdx/ca_caf/beans.xml @@ -6,11 +6,11 @@ xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd"> - - + + @@ -18,7 +18,8 @@ - + @@ -29,9 +30,32 @@ - - - + + + + + + + + + + + + + + + + + + + + + + diff --git a/mdx/ca_caf/import.xml b/mdx/ca_caf/verbs.xml similarity index 57% rename from mdx/ca_caf/import.xml rename to mdx/ca_caf/verbs.xml index d5abd10f..ff5d115b 100644 --- a/mdx/ca_caf/import.xml +++ b/mdx/ca_caf/verbs.xml @@ -1,6 +1,6 @@ @@ -15,9 +15,9 @@ --> - - + @@ -26,24 +26,14 @@ - - + - - - - - - - - - - + - - + diff --git a/mdx/ch_switchaai/beans.xml b/mdx/ch_switchaai/beans.xml index c5724e23..d3715a04 100644 --- a/mdx/ch_switchaai/beans.xml +++ b/mdx/ch_switchaai/beans.xml @@ -6,11 +6,11 @@ xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd"> - - + + @@ -18,7 +18,8 @@ - + @@ -26,9 +27,35 @@ - - - + + + + + + + + + + + + + + + + + + + + + + + diff --git a/mdx/ch_switchaai/import.xml b/mdx/ch_switchaai/verbs.xml similarity index 56% rename from mdx/ch_switchaai/import.xml rename to mdx/ch_switchaai/verbs.xml index 68c28bb3..31bdc96a 100644 --- a/mdx/ch_switchaai/import.xml +++ b/mdx/ch_switchaai/verbs.xml @@ -1,6 +1,6 @@ @@ -15,9 +15,9 @@ --> - - + @@ -26,24 +26,14 @@ - - + - - - - - - - - - - + - - + diff --git a/mdx/conventions.txt b/mdx/conventions.txt new file mode 100644 index 00000000..7f3aec3e --- /dev/null +++ b/mdx/conventions.txt @@ -0,0 +1,44 @@ +Conventions for the /mdx/ directory tree. +========================================= + +Each directory under /mdx/ represents a source of metadata, referred to as a channel. Each channel is named in the form "country_source", for example: us_incommon. Exceptions are made for the UK federation, whose channel is just called "uk", and for channels not associated with particular countries, which are named as "int_source", for example "int_edugain". + +Each channel contains a number of Spring bean configuration files. The beans.xml file is present in all channels, in addition a channel may provide a verbs.xml and/or .xml files implementing channel-specific verbs. + +beans.xml conventions +===================== + +Most beans defined within a channel appear in a beans.xml configuration file within the channel directory. + +As well as being available to channel-local operations, these beans are available to operations involving more than one channel. Therefore, all beans defined in beans.xml should be named with the channel name as a prefix in order to avoid clashes when beans from more than one channel are brought together at run time. For example, a bean which would naturally be called "productionAggregate" would be named "us_incommon_productionAggregate" within the "us_incommon" channel, "se_swamid_productionAggregate" within the "se_swamid" channel and so on. + +All beans defined in beans.xml should be set as lazy-init="true". All aggregator component beans should additionally declare init-method="initialize". + +common beans.xml channel beans +============================== + +channel_productionAggregate is a stage that fetches the source's production aggregate + +channel_exportAggregate is a stage that fetches the source's export aggregate. Omitted if the source doesn't have an export aggregate. + +channel_signingCertificate + +channel_checkSignature + +channel_exportedEntities is a composite stage which returns the source's exported entities as a collection. If the source doesn't have an export aggregate, it may instead derive a pseudo export collection from the production aggregate. + +verbs.xml and .xml conventions +==================================== + +Verbs are operations that can be directly executed by the aggregator CLI. They are implemented as aggregator pipeline objects named by the verb they implement, without qualification by the channel name. A qualified name is not required in this case because verbs are never called from other channels, only from the CLI. + +Verbs are defined either in a file named after the verb (e.g., "collect.xml", "import.xml") or in a "verbs.xml" file. The Ant build file looks for a specifically-named file first, then falls back to the verbs.xml file. + +For example, executing the "import" verb on the "us_incommon" channel involves looking for an "import.xml" file in the "us_incommon" directory. If this is found, the "import" pipeline in /mdx/us_incommon/import.xml is invoked; otherwise, the CLI is invoked on the "import" pipeline in /mdx/us_incommon/verbs.xml. + +Verb definition files should import the channel's beans.xml file as well as the common-beans.xml file from the parent /mdx/ directory through a relative path. + +Verb definition files should not import each other; any beans required to be shared between verb definition files should be moved into the channel's beans.xml file and given an appropriately channel-qualified name. + +All aggregator component beans declared within a verb definition file should declare init-method="initialize". If more than one verb is defined in a verbs.xml file, all beans within the file should also be set as lazy-init="true". + diff --git a/mdx/cz_eduid/beans.xml b/mdx/cz_eduid/beans.xml index 45dbce57..8a8d1a26 100644 --- a/mdx/cz_eduid/beans.xml +++ b/mdx/cz_eduid/beans.xml @@ -16,13 +16,11 @@ --> - - + @@ -56,7 +54,8 @@ - + + diff --git a/mdx/cz_eduid/import.xml b/mdx/cz_eduid/verbs.xml similarity index 73% rename from mdx/cz_eduid/import.xml rename to mdx/cz_eduid/verbs.xml index 6b94d699..80c6fdb5 100644 --- a/mdx/cz_eduid/import.xml +++ b/mdx/cz_eduid/verbs.xml @@ -1,6 +1,6 @@ @@ -15,9 +15,9 @@ --> - - + @@ -26,14 +26,14 @@ - - + - + diff --git a/mdx/ie_edugate/beans.xml b/mdx/ie_edugate/beans.xml index 97a83d3d..3c688a4e 100644 --- a/mdx/ie_edugate/beans.xml +++ b/mdx/ie_edugate/beans.xml @@ -6,13 +6,11 @@ xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd"> - - + @@ -45,7 +43,8 @@ - + + diff --git a/mdx/ie_edugate/import.xml b/mdx/ie_edugate/verbs.xml similarity index 73% rename from mdx/ie_edugate/import.xml rename to mdx/ie_edugate/verbs.xml index c3c03aab..56016b69 100644 --- a/mdx/ie_edugate/import.xml +++ b/mdx/ie_edugate/verbs.xml @@ -1,6 +1,6 @@ @@ -15,9 +15,9 @@ --> - - + @@ -26,14 +26,14 @@ - - + - + diff --git a/mdx/int_edugain/beans.xml b/mdx/int_edugain/beans.xml index 2af1dfa0..066f161c 100644 --- a/mdx/int_edugain/beans.xml +++ b/mdx/int_edugain/beans.xml @@ -10,23 +10,21 @@ http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-3.0.xsd"> - - + + - - + + @@ -34,7 +32,8 @@ - + @@ -42,9 +41,55 @@ - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/mdx/int_edugain/testImport.xml b/mdx/int_edugain/testImport.xml deleted file mode 100644 index e7257295..00000000 --- a/mdx/int_edugain/testImport.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/mdx/int_edugain/import.xml b/mdx/int_edugain/verbs.xml similarity index 59% rename from mdx/int_edugain/import.xml rename to mdx/int_edugain/verbs.xml index c56e6bdd..18d80c81 100644 --- a/mdx/int_edugain/import.xml +++ b/mdx/int_edugain/verbs.xml @@ -1,6 +1,6 @@ - - + @@ -30,26 +30,28 @@ - - + - - - - - - - - - - + - - + + + + + + + + + + + + diff --git a/mdx/se_swamid/beans.xml b/mdx/se_swamid/beans.xml index d3a15621..256954f0 100644 --- a/mdx/se_swamid/beans.xml +++ b/mdx/se_swamid/beans.xml @@ -6,11 +6,11 @@ xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd"> - - + + @@ -18,7 +18,8 @@ - + @@ -29,9 +30,32 @@ - - - + + + + + + + + + + + + + + + + + + + + + + diff --git a/mdx/se_swamid/import.xml b/mdx/se_swamid/verbs.xml similarity index 56% rename from mdx/se_swamid/import.xml rename to mdx/se_swamid/verbs.xml index aae37729..de6140a3 100644 --- a/mdx/se_swamid/import.xml +++ b/mdx/se_swamid/verbs.xml @@ -1,6 +1,6 @@ @@ -15,9 +15,9 @@ --> - - + @@ -26,24 +26,14 @@ - - + - - - - - - - - - - + - - + diff --git a/mdx/si_arnes/beans.xml b/mdx/si_arnes/beans.xml index dbb89328..608bdb86 100644 --- a/mdx/si_arnes/beans.xml +++ b/mdx/si_arnes/beans.xml @@ -6,11 +6,11 @@ xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd"> - - + + @@ -18,7 +18,8 @@ - + @@ -29,9 +30,32 @@ - - - + + + + + + + + + + + + + + + + + + + + + + diff --git a/mdx/si_arnes/import.xml b/mdx/si_arnes/verbs.xml similarity index 56% rename from mdx/si_arnes/import.xml rename to mdx/si_arnes/verbs.xml index 5f5cee7e..f2b7795b 100644 --- a/mdx/si_arnes/import.xml +++ b/mdx/si_arnes/verbs.xml @@ -1,6 +1,6 @@ @@ -15,9 +15,9 @@ --> - - + @@ -26,24 +26,14 @@ - - + - - - - - - - - - - + - - + diff --git a/mdx/uk/collect.xml b/mdx/uk/collect.xml index f0b409f9..23bd7e5a 100644 --- a/mdx/uk/collect.xml +++ b/mdx/uk/collect.xml @@ -1,6 +1,6 @@ - - + @@ -30,16 +30,16 @@ - - + - + diff --git a/mdx/uk_eduserv/beans.xml b/mdx/uk_eduserv/beans.xml index aed703aa..b6804f2a 100644 --- a/mdx/uk_eduserv/beans.xml +++ b/mdx/uk_eduserv/beans.xml @@ -8,9 +8,9 @@ - - + @@ -43,7 +43,7 @@ - + diff --git a/mdx/uk_eduserv/import.xml b/mdx/uk_eduserv/verbs.xml similarity index 73% rename from mdx/uk_eduserv/import.xml rename to mdx/uk_eduserv/verbs.xml index 0df96a59..c7a97c7b 100644 --- a/mdx/uk_eduserv/import.xml +++ b/mdx/uk_eduserv/verbs.xml @@ -1,6 +1,6 @@ @@ -15,9 +15,9 @@ --> - - + @@ -26,14 +26,14 @@ - - + - + diff --git a/mdx/us_incommon/beans.xml b/mdx/us_incommon/beans.xml index ffc1a64a..08d457e1 100644 --- a/mdx/us_incommon/beans.xml +++ b/mdx/us_incommon/beans.xml @@ -6,11 +6,11 @@ xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd"> - - + + @@ -18,7 +18,7 @@ - + @@ -29,9 +29,32 @@ - - - + + + + + + + + + + + + + + + + + + + + + + diff --git a/mdx/us_incommon/import.xml b/mdx/us_incommon/verbs.xml similarity index 56% rename from mdx/us_incommon/import.xml rename to mdx/us_incommon/verbs.xml index c36e713e..ff95e503 100644 --- a/mdx/us_incommon/import.xml +++ b/mdx/us_incommon/verbs.xml @@ -1,6 +1,6 @@ @@ -15,9 +15,12 @@ --> - + - + @@ -26,24 +29,14 @@ - - + - - - - - - - - - - + - - +