Skip to Content
Last modified by Helena on 2025/09/10 11:19
From version 2.18
edited by Helena
on 2025/05/21 15:13
Change comment: There is no comment for this version
To version 2.16
edited by Helena
on 2025/05/21 15:11
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1248,12 +1248,15 @@
1248 1248  
1249 1249  A user can submit a subscription in the registry that defines which events are of interest, and either an email and/or an HTTP address to which a notification of qualifying events will be delivered. The subscription will be identified in the registry by a URN which is returned to the user when the subscription is created. If the user wants to delete the subscription at a later point, the subscription URN is used as identification. Subscriptions have a validity period expressed as a date range (startDate, endDate) and the registry may delete any expired subscriptions, and will notify the subscriber on expiry.
1250 1250  
1251 -When a registry/repository artefact is modified, any subscriptions which are observing the object are activated, and either an email or HTTP POST is instigated to report details of the changes to the user specified in the subscription. This is called a “notification”.
1251 +When a registry/repository artefact is modified, any subscriptions which are observing the object are activated, and either an email or HTTP POST is instigated to report details of the changes to the user specified in the subscription. This is called a
1252 1252  
1253 -=== 7.5.1Subscription Logical Class Diagram ===
1253 +“notification”.
1254 1254  
1255 -[[image:1747829554603-150.png]]
1255 + 7.5.1Subscription Logical Class Diagram
1256 1256  
1257 +
1258 +[[image:1747824123028-257.png]]
1259 +
1257 1257  **Figure 19: Logical Class Diagram of the Subscription**
1258 1258  
1259 1259  === 7.5.2 Subscription Information ===
... ... @@ -1260,58 +1260,73 @@
1260 1260  
1261 1261  Regardless of the type of registry/repository events being observed, a subscription always contains:
1262 1262  
1263 -1. A set of URIs describing the end-points to which notifications must be sent if the subscription is activated. The URIs can be either mailto~: or http: protocol. In the former case an email notification is sent; in the latter an HTTP POST notification is sent.
1264 -1. A user-defined identifier which is returned in the response to the subscription request. This helps with asynchronous processing and is NOT stored in the Registry.
1265 -1. A validity period which defines both when the subscription becomes active and expires. The subscriber may be sent a notification on expiration of the subscription.
1266 -1. A selector which specifies which type of events are of interest. The set of event types is:
1266 +~1. A set of URIs describing the end-points to which notifications must be sent if the subscription is activated. The URIs can be either mailto~: or http: protocol. In the former case an email notification is sent; in the latter an HTTP POST notification is sent.
1267 1267  
1268 -|(% style="width:327px" %)**Event Type**|(% style="width:1545px" %)**Comment**
1269 -|(% style="width:327px" %)STRUCTURAL_REPOSITORY_EVENTS|(% style="width:1545px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1270 -|(% style="width:327px" %)DATA_REGISTRATION_EVENTS|(% style="width:1545px" %)Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
1271 -|(% style="width:327px" %)METADATA_REGISTRATION_EVENTS|(% style="width:1545px" %)Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
1272 -|(% style="width:327px" %)ALL_EVENTS|(% style="width:1545px" %)All events of the specified EventType
1268 +2. A user-defined identifier which is returned in the response to the subscription request. This helps with asynchronous processing and is NOT stored in the Registry.
1273 1273  
1270 +3. A validity period which defines both when the subscription becomes active and expires. The subscriber may be sent a notification on expiration of the subscription.
1271 +
1272 +4. A selector which specifies which type of events are of interest. The set of event types is:
1273 +
1274 +|**Event Type**|**Comment**
1275 +|STRUCTURAL_REPOSITORY_EVENTS|Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1276 +|DATA_REGISTRATION_EVENTS|Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
1277 +|METADATA_REGISTRATION_EVENTS|Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
1278 +|ALL_EVENTS|All events of the specified EventType
1279 +
1274 1274  === 7.5.3 Wildcard Facility ===
1275 1275  
1276 1276  Subscription notification supports wildcarded identifier components URNs, which are identiiers which have some or all of their component parts replaced by the wildcard character `%`. Identifier components comprise:
1277 1277  
1278 -* agencyID
1279 -* id
1280 -* version
1284 + agencyID
1281 1281  
1286 + id
1287 +
1288 + version
1289 +
1282 1282  Examples of wildcarded identifier components for an identified object type of Codelist are shown below.
1283 1283  
1284 -//AgencyID = %
1292 +AgencyID = %
1293 +
1285 1285  Id = %
1286 -Version = %//
1287 1287  
1296 +Version = %
1297 +
1288 1288  This subscribes to all Codelists of all versions for all agencies.
1289 1289  
1290 -//AgencyID = AGENCY1
1300 +AgencyID = AGENCY1
1301 +
1291 1291  Id = CODELIST1
1292 -Version = %//
1293 1293  
1304 +Version = %
1305 +
1294 1294  This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1295 1295  
1296 -//AGENCY1
1308 +AGENCY1
1309 +
1297 1297  AgencyID = AGENCY1
1311 +
1298 1298  Id = %
1299 -Version = %//
1300 1300  
1314 +Version = %
1315 +
1301 1301  This subscribes to all versions of all Codelist objects maintained by the agency
1302 1302  
1303 -//AGENCY1
1318 +AGENCY1
1319 +
1304 1304  AgencyID = %
1321 +
1305 1305  Id = CODELIST1
1306 -Version = %//
1307 1307  
1324 +Version = %
1325 +
1308 1308  This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1309 1309  
1310 -//AGENCY1//
1328 +AGENCY1
1311 1311  
1312 1312  Note that if the subscription is to the latest version then this can be achieved by the * character
1313 1313  
1314 -//i.e. Version = *//
1332 +i.e. Version = *
1315 1315  
1316 1316  Note that a subscription using the URN mechanism cannot use wildcard characters.
1317 1317  
1747829554603-150.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -99.1 KB
Content