Usage Guide for Semantic Pingback in ODS
What is Semantic Pingback?
Semantic Pingback is a mechanism through which data space owners receive notification, in the form of triple statements, when external sources (typically other data spaces) make references to their data spaces. This mechanism is basically an adaptation of the blog pingback, with payloads now taking the form of RDF-based structured data resources.
For instance, the owner of foaf:knows
assertion --
{ DataSpaceA:owner foaf:knows DataSpaceB:owner }
Depending on data space settings, the owner of foaf:knows
assertion, or
{ DataSpaceB:owner foaf:knows DataSpaceA:owner }
The Semantic Pingback functionality in ODS supports operation in both client and server modes.
Semantic Pingback Endpoints in ODS
XML-RPC | http://<cname>[:<port>]/semping |
parameters 'source ' and 'target ' (strings) as explained in the specification |
REST | http://<cname>[:<port>]/semping/rest?source=<source uri>&target=<target uri> |
parameters are as with XML-RPC, but payloads are delivered using HTTP POST or GET operations. |
Semantic Pingback Setup in ODS
This scenario assumes two ODS instances, where one is the Ping Receiver and the other is the Ping Sender.
Configuring the Ping Receiver
- The ODS data space owner designates data space applications for which ping notification will be enabled through the Application Settings menu Semantic Pingback Setup option.
- The data space owner must choose what will happen upon ping notification: email; automatic generation of reciprocal data (i.e., triple-based data generation); or both:
Actions to take on the Ping Sender
- Go to a ping-enabled ODS data space application. For example, the Profile Manager and Editor includes an Annotations tab, which offers a UI for making arbitrary assertions about anything with triples-based statements.
- Make a simple Annotation claiming to know the owner of the Ping Receiver instance configured above, with a
foaf:knows
relation targeting theWebID of the Ping Receiver instance owner. - Tick the Issue Semantic Pingback checkbox.
- Click the Add button to complete the pingback enabled annotation.
Actions to take on the Ping Receiver
- Go to your ODS Profile Page, or simply load your
WebID into the Address Bar of any HTTP compliant browser. - Observe the addition of the new
foaf:knows
relation posted by the Ping Sender.
- If the email option was enabled, you will also receive an email indicating that you are the "Object" of a
foaf:knows
relation asserted by the Ping Sender.
Security of Ping Notifications
The access control feature of Virtuoso (your ODS host environment) may be used to add an ACL named '