Notes for MN API

register(token, ID, metadata)

Todo

Describe this operation.

Parameters:
  • token – The authentication token returned by login()
  • ID –
  • metadata –
batchGet(token, PIDs) → ?

Identical to get() except that a list of identifiers is requested.

The issue here is how to serialize the results. There are some conceptual mechanisms for handling structured markup such as XML, but no consistent approaches for working with data blobs. Perhaps this method should apply only to system metadata, for which the serialization can be defined independently of all the other participating nodes?

Parameters:
  • token – (Types.AuthToken) The authentication token returned by login()
  • PIDs – (pidList) The list of identifiers to retrieve.
Return type:

Bytes of the specified objects. How are multiple objects serialized?
Raises:

Todo

batchGet specifies that multiple objects may be retrieved in a single call. How are these objects packaged in the response?

checkDataQuality(PID)

Todo

need details on what this operation is supposed to be doing.

Parameters:PID – object to check

From the authorization API:

requestToken()

This operation is used by CN applications to obtain a token for system level operations.

Note

This could be a normal login() operation using a system user and secret that is stored in a secure location.

From the replication API:

synchronizationComplete(token, PID)

This is a callback method used by a CN to indicate to a MN that it has completed replication of the science metadata identified by PID. When called, the MN should somehow record that synchronization is complete for that object so that the next time it reponds to a listObjects(token, query) query the object will not be included as requiring synchronization.

Parameters:
  • token – authentication token; ignored for V0.3
  • PID – The PID of the science metadata object that is now synchronized with the CN.

Note

A CN could use this method to provide the MN with an updated version of the system metadata for the object if this method accepted a system metadata object instead of a simple PID as a parameter.

Returns:A simple acknowledgement.

Todo

Define “a simple acknowledgement”

Raises:
  • Exceptions.NotAuthorized –
  • Exceptions.InvalidIdentifier – The supplied PID does not identify a science metadata object owned by the MN.
  • Exceptions.InvalidOperation – The science metadata object identified by the PID is already marked as synchronized.

This method is not necessary since the CNs keep track of when an object was last synchronized. There should not be a requirement for MNs to track if content has been retrieved by the CNs.

More stuff from the replication APIs

::

cancelReplication (sess, transID) listAllObjects () listRecords () replicationSucceeds (transID) startReplica (ID, sessionID, transID, srcMN) sysOp (token) listChangedRecords(token) -> PIDs

## from v0.3 doc ## listObjects(token, query) -> list of PIDs synchronizationComplete(token, PID) synchronizationFailed(token, PID, problemDescription)

cancelReplication(sess, transID)
listAllObjects()
listRecords()
replicationSucceeds(transID)
startReplica(ID, sessionID, transID, srcMN)
sysOp(token)
listChangedRecords(token) → PidList

List the records that have changed since the last synchronization event.

Parameters:token – A token with authority to retrieve a list of changed records.

From the capabilities API, this function is listed but has no definition:

serviceRequest(token)

This material is based upon work supported by the National Science Foundation under Grant Numbers 083094 and 1430508.

Any opinions, findings, and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation.