Documentation‎ > ‎

Register

You may chose to register your deployment of S3DB. This action enables the integration of S3DB deployments, making it possible, given the necessary privileges, to query and share data with other deployments as if the data was available in your local deployment. 

Also, registering your deployment enables you to build SPARQL queries that transverse more that one URL - the query is parallelized and redirected to the correct deployment. By assigning a name, a description and keywords, data related to the same entities can be discovered and accessed by those with privileges in your deployment (see permission management for more information). 

Currently, only the deployment at http://root.s3db.org is supported by the S3DB team for registration.

There is a total of 3 possible interactions with the mothership:
  • Register
  • Check
  • Update

The function responsible for mothership-deployment interaction is called s3rl.php

Register

Register a new deployment in the mothership

register

Arguments (Mandatory) :
url
publicKey (see documentation on getRSAKeys.php to genenate a public/private key pair)

Arguments (Optional):
name
description
keywords
userName
email
format

Syntax:
http://root.s3db.org/s3rl.php?url=...publicKey=....&name=...

Check

Find information on an existing deployment given deployment_id

Check

Note: Check is indistinguishable from an S3QL query in deployment. See S3QLSyntax for more information.

Arguments (Mandatory) :
uid

Arguments (Optional):
format

Syntax:
http://root.s3db.org/URI.php?uid=Dxxx
OR
http://root.s3db.org/S3QL.php?query=<S3QL><select>url</select><from>deployment</from><where><deployment_id>xxx</deployment_id></where></S3QL>

Update

In order to update a registered deployment, the mothership requires each deployment to decrypt a message with the private key generated upon configuration of each deployment (the private key must be paired with the publicKey that was sent to the Mothership upon register).

Update

Note: Update requires 2 sequential call - one indicating an update is about to occur, which will result in a message fromthe mothership to be decrypted; the second call, with the decripted message, updates the deployment URL

Arguments (Mandatory) :
Did
newUrl

Arguments (Optional):
format

Syntax:
Call1
http://root.s3db.org/s3rl.php?Did=...newUrl=....&format=...

Call2
http://root.s3db.org/s3rl.php?message=....&format=php

Comments