€cdocutils.nodes
document
q)q}q(U	nametypesq}qX#   apis internal to coordinating nodesqNsUsubstitution_defsq}qUparse_messagesq	]q
Ucurrent_sourceqNU
decorationqNUautofootnote_startqKUnameidsq}qhU#apis-internal-to-coordinating-nodesqsUchildrenq]qcdocutils.nodes
section
q)q}q(U	rawsourceqU UparentqhUsourceqXj   /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/apis/CN_internal_APIs.txtqUtagnameqUsectionqU
attributesq}q(Udupnamesq]Uclassesq]Ubackrefsq ]Uidsq!]q"haUnamesq#]q$hauUlineq%KUdocumentq&hh]q'(cdocutils.nodes
title
q()q)}q*(hX#   APIs Internal to Coordinating Nodesq+hhhhhUtitleq,h}q-(h]h]h ]h!]h#]uh%Kh&hh]q.cdocutils.nodes
Text
q/X#   APIs Internal to Coordinating Nodesq0…q1}q2(hh+hh)ubaubcdocutils.nodes
paragraph
q3)q4}q5(hXã   The DataONE Coordinating Nodes are composed of several components that by their
nature will be operating in different JVMs. This document outlines the methods
that are exposed by the different components in a Coordinating Node.q6hhhhhU	paragraphq7h}q8(h]h]h ]h!]h#]uh%Kh&hh]q9h/Xã   The DataONE Coordinating Nodes are composed of several components that by their
nature will be operating in different JVMs. This document outlines the methods
that are exposed by the different components in a Coordinating Node.q:…q;}q<(hh6hh4ubaubcdocutils.nodes
literal_block
q=)q>}q?(hX‡  boolean identity.isPublic(Subject)

boolean identity.isGroup(Subject)

Subject[] identity.getSubjectGroups(Subject)

XML objectStore.getSystemMetadata(Identifier)

OctetStream objectStore.get(Identifier)

boolean objectStore.registerSystemMetadata(Identifier, SystemMetadata)

CN_crud.updateReplicaMetadata(token, pid, Types.ReplicaMetadata) -> Types.Identifier

 full replacement of ReplicaMetadata, changes date sysmeta modified


CN_crud.setAccessPolicy(token, pid, AccessPolicy) -> boolean

  RE /access/pid (body containing token, AccessPolicy) -> boolean
  changes date sysmeta modified too

CN_crud.setReplicationPolicy(token, pid, ReplicationPolicy) -> boolean
REST API: PUT /replication/pid (body containing token, ReplicationPolicy) -> boolean
   - changes date sysmeta modified too


CN.setDescribes()

   describes can be set in its own method, but only with write access to
   described object and describing object

   may want to relax the requirement later to allow third party
   annotations/perspectives/derivations on other people's data, but need to be
   able to differentiate the primary provider's description from these other
   descriptions

CN.setDescribedBy()
   describedBy can be set in its own method, but only with write access to described object


ObjectList getDescribes(Identifier)

ObjectList getDescribedBy(Identifier)

ObjectList getRelatedObjects(Identifier, RelationshipEnum)hhhhhUliteral_blockq@h}qA(U	xml:spaceqBUpreserveqCh!]h ]h]h]h#]uh%Kh&hh]qDh/X‡  boolean identity.isPublic(Subject)

boolean identity.isGroup(Subject)

Subject[] identity.getSubjectGroups(Subject)

XML objectStore.getSystemMetadata(Identifier)

OctetStream objectStore.get(Identifier)

boolean objectStore.registerSystemMetadata(Identifier, SystemMetadata)

CN_crud.updateReplicaMetadata(token, pid, Types.ReplicaMetadata) -> Types.Identifier

 full replacement of ReplicaMetadata, changes date sysmeta modified


CN_crud.setAccessPolicy(token, pid, AccessPolicy) -> boolean

  RE /access/pid (body containing token, AccessPolicy) -> boolean
  changes date sysmeta modified too

CN_crud.setReplicationPolicy(token, pid, ReplicationPolicy) -> boolean
REST API: PUT /replication/pid (body containing token, ReplicationPolicy) -> boolean
   - changes date sysmeta modified too


CN.setDescribes()

   describes can be set in its own method, but only with write access to
   described object and describing object

   may want to relax the requirement later to allow third party
   annotations/perspectives/derivations on other people's data, but need to be
   able to differentiate the primary provider's description from these other
   descriptions

CN.setDescribedBy()
   describedBy can be set in its own method, but only with write access to described object


ObjectList getDescribes(Identifier)

ObjectList getDescribedBy(Identifier)

ObjectList getRelatedObjects(Identifier, RelationshipEnum)qE…qF}qG(hU hh>ubaubeubahU UtransformerqHNUfootnote_refsqI}qJUrefnamesqK}qLUsymbol_footnotesqM]qNUautofootnote_refsqO]qPUsymbol_footnote_refsqQ]qRU	citationsqS]qTh&hUcurrent_lineqUNUtransform_messagesqV]qWUreporterqXNUid_startqYKUautofootnotesqZ]q[Ucitation_refsq\}q]Uindirect_targetsq^]q_Usettingsq`(cdocutils.frontend
Values
qaoqb}qc(Ufootnote_backlinksqdKUrecord_dependenciesqeNUrfc_base_urlqfUhttps://tools.ietf.org/html/qgU	tracebackqhˆUpep_referencesqiNUstrip_commentsqjNUtoc_backlinksqkUentryqlUlanguage_codeqmUenqnU	datestampqoNUreport_levelqpKU_destinationqqNU
halt_levelqrKUstrip_classesqsNh,NUerror_encoding_error_handlerqtUbackslashreplacequUdebugqvNUembed_stylesheetqw‰Uoutput_encoding_error_handlerqxUstrictqyUsectnum_xformqzKUdump_transformsq{NUdocinfo_xformq|KUwarning_streamq}NUpep_file_url_templateq~Upep-%04dqUexit_status_levelq€KUconfigqNUstrict_visitorq‚NUcloak_email_addressesqƒˆUtrim_footnote_reference_spaceq„‰Uenvq…NUdump_pseudo_xmlq†NUexpose_internalsq‡NUsectsubtitle_xformqˆ‰Usource_linkq‰NUrfc_referencesqŠNUoutput_encodingq‹Uutf-8qŒU
source_urlqNUinput_encodingqŽU	utf-8-sigqU_disable_configqNU	id_prefixq‘U U	tab_widthq’KUerror_encodingq“UUTF-8q”U_sourceq•hUgettext_compactq–ˆU	generatorq—NUdump_internalsq˜NUsmart_quotesq™‰Upep_base_urlqšU https://www.python.org/dev/peps/q›Usyntax_highlightqœUlongqUinput_encoding_error_handlerqžhyUauto_id_prefixqŸUidq Udoctitle_xformq¡‰Ustrip_elements_with_classesq¢NU_config_filesq£]Ufile_insertion_enabledq¤ˆUraw_enabledq¥KUdump_settingsq¦NubUsymbol_footnote_startq§K Uidsq¨}q©hhsUsubstitution_namesqª}q«hh&h}q¬(h]h!]h ]Usourcehh]h#]uU	footnotesq­]q®Urefidsq¯}q°ub.