Äï¥`������ådocutils.nodesîådocumentîìî)Åî}î(å	rawsourceîå�îåchildrenî]î(h�årawîìî)Åî}î(hå\newpageîh]îh�åTextîìîå\newpageîÖîÅî}î(hhåparentîhubaå
attributesî}î(åidsî]îåclassesî]îånamesî]îådupnamesî]îåbackrefsî]îåformatîålatexîå	xml:spaceîåpreserveîuåtagnameîh	åsourceîå]/var/lib/jenkins/jobs/metacat_beta/workspace/metacat/docs/user/metacat/source/identifiers.rstîålineîK
hhh
hubh�åsectionîìî)Åî}î(hhh]î(h�åtitleîìî)Åî}î(håIdentifier Managementîh]îhåIdentifier ManagementîÖîÅî}î(hh3hh1h
hh'Nh)Nubah}î(h]îh]îh]îh]îh ]îuh&h/hh,h
hh'h(h)Kubåsphinx.addnodesîåindexîìî)Åî}î(hhh]îh}î(h]îh]îh]îh]îh ]îåentriesî]î(åsingleîåIdentifiersîåindex-0îhNtîaåinlineîâuh&h@h'h(h)K	hh,h
hubh�åtargetîìî)Åî}î(hhh]îh}î(h]îh]îh]îh]îh ]îårefidîhOuh&hRhh,h
hh'h(h)K
ubh�ådefinition_listîìî)Åî}î(hhh]î(h�ådefinition_list_itemîìî)Åî}î(håAuthor
Matthew B. Jones
îh]î(h�återmîìî)Åî}î(håAuthorîh]îhåAuthorîÖîÅî}î(hhmhhkubah}î(h]îh]îh]îh]îh ]îuh&hih'h(h)Khheubh�å
definitionîìî)Åî}î(hhh]îh�å	paragraphîìî)Åî}î(håMatthew B. Jonesîh]îhåMatthew B. JonesîÖîÅî}î(hhÇhhÄubah}î(h]îh]îh]îh]îh ]îuh&h~h'h(h)Khh{ubah}î(h]îh]îh]îh]îh ]îuh&hyhheubeh}î(h]îh]îh]îh]îh ]îuh&hch'h(h)Khh`ubhd)Åî}î(hå@Date
- 20100301 [MBJ] Initial draft of Identifier documentation
îh]î(hj)Åî}î(håDateîh]îhåDateîÖîÅî}î(hh†hhûubah}î(h]îh]îh]îh]îh ]îuh&hih'h(h)Khhöubhz)Åî}î(hhh]îh�åbullet_listîìî)Åî}î(hhh]îh�å	list_itemîìî)Åî}î(hå920100301 [MBJ] Initial draft of Identifier documentation
îh]îh)Åî}î(hå820100301 [MBJ] Initial draft of Identifier documentationîh]îhå820100301 [MBJ] Initial draft of Identifier documentationîÖîÅî}î(hhºhh∫ubah}î(h]îh]îh]îh]îh ]îuh&h~h'h(h)Khh∂ubah}î(h]îh]îh]îh]îh ]îuh&h¥hh±ubah}î(h]îh]îh]îh]îh ]îåbulletîå
-îuh&hØh'h(h)Khh¨ubah}î(h]îh]îh]îh]îh ]îuh&hyhhöubeh}î(h]îh]îh]îh]îh ]îuh&hch'h(h)Khh`h
hubhd)Åî}î(håAGoal
Extend Metacat to support identifiers with arbitrary syntax
îh]î(hj)Åî}î(håGoalîh]îhåGoalîÖîÅî}î(hhËhhÊubah}î(h]îh]îh]îh]îh ]îuh&hih'h(h)Khh‚ubhz)Åî}î(hhh]îh)Åî}î(hå;Extend Metacat to support identifiers with arbitrary syntaxîh]îhå;Extend Metacat to support identifiers with arbitrary syntaxîÖîÅî}î(hh˘hh˜ubah}î(h]îh]îh]îh]îh ]îuh&h~h'h(h)KhhÙubah}î(h]îh]îh]îh]îh ]îuh&hyhh‚ubeh}î(h]îh]îh]îh]îh ]îuh&hch'h(h)Khh`h
hubhd)Åî}î(hX«
��Summary
Metacat currently supports identifier strings called 'docids' that have
the syntax 'scope.object.revision', such as 'foo.34.1' (we will refer to
these as 'LocalIDs'). We now want Metacat to support identifiers that are
arbitrary strings, but still enforce uniqueness and proper revision
handling (refer to these as GUIDs).  Metacat must be able to accept
these strings as identifiers for all CRUD operations, and reference them
in search results.
îh]î(hj)Åî}î(håSummaryîh]îhåSummaryîÖîÅî}î(hj
��hj
��ubah}î(h]îh]îh]îh]îh ]îuh&hih'h(h)Khj
��ubhz)Åî}î(hhh]îh)Åî}î(hXæ
��Metacat currently supports identifier strings called 'docids' that have
the syntax 'scope.object.revision', such as 'foo.34.1' (we will refer to
these as 'LocalIDs'). We now want Metacat to support identifiers that are
arbitrary strings, but still enforce uniqueness and proper revision
handling (refer to these as GUIDs).  Metacat must be able to accept
these strings as identifiers for all CRUD operations, and reference them
in search results.îh]îhXŒ
��Metacat currently supports identifier strings called ‚Äòdocids‚Äô that have
the syntax ‘scope.object.revision’, such as ‘foo.34.1’ (we will refer to
these as ‘LocalIDs’). We now want Metacat to support identifiers that are
arbitrary strings, but still enforce uniqueness and proper revision
handling (refer to these as GUIDs).  Metacat must be able to accept
these strings as identifiers for all CRUD operations, and reference them
in search results.îÖîÅî}î(hj(
��hj&
��ubah}î(h]îh]îh]îh]îh ]îuh&h~h'h(h)Khj#
��ubah}î(h]îh]îh]îh]îh ]îuh&hyhj
��ubeh}î(h]îh]îh]îh]îh ]îuh&hch'h(h)Khh`h
hubeh}î(h]îhOah]îh]îh]îh ]îuh&h^hh,h
hh'h(h)Nåexpect_referenced_by_nameî}îåexpect_referenced_by_idî}îhOhTsubh+)Åî}î(hhh]î(h0)Åî}î(håIdentifier Resolutionîh]îhåIdentifier ResolutionîÖîÅî}î(hjO
��hjM
��h
hh'Nh)Nubah}î(h]îh]îh]îh]îh ]îuh&h/hjJ
��h
hh'h(h)Kubh)Åî}î(hX˛��Because Metacat uses LocalIDs throughout the code for references to objects,
and that LocalID has a constrained structure that includes semantics about
revisions in the identifier, it is difficult to wholesale replace it with
less-constrained string identifiers without re-writing much of Metacat.
Thus, our alternate strategy is to wrap the Metacat APIs with a
identifier resolution layer that keeps track of the unconstrained GUIDs and
maps them to constrained local identifiers which are used internally within
Metacat. The basic identifer table model is shown in Figure 1, while the
basic strategy for retrieving an object is shown in Figure 2, creating an
object is shown in Figure 3, updating an object in Figure 4, and deleting
an object is shown in Figure 5.îh]îhX˛��Because Metacat uses LocalIDs throughout the code for references to objects,
and that LocalID has a constrained structure that includes semantics about
revisions in the identifier, it is difficult to wholesale replace it with
less-constrained string identifiers without re-writing much of Metacat.
Thus, our alternate strategy is to wrap the Metacat APIs with a
identifier resolution layer that keeps track of the unconstrained GUIDs and
maps them to constrained local identifiers which are used internally within
Metacat. The basic identifer table model is shown in Figure 1, while the
basic strategy for retrieving an object is shown in Figure 2, creating an
object is shown in Figure 3, updating an object in Figure 4, and deleting
an object is shown in Figure 5.îÖîÅî}î(hj]
��hj[
��h
hh'Nh)Nubah}î(h]îh]îh]îh]îh ]îuh&h~h'h(h)KhjJ
��h
hubh+)Åî}î(hhh]î(h0)Åî}î(håIdentifier Table Structureîh]îhåIdentifier Table StructureîÖîÅî}î(hjn
��hjl
��h
hh'Nh)Nubah}î(h]îh]îh]îh]îh ]îuh&h/hji
��h
hh'h(h)K-ubh�åfigureîìî)Åî}î(hhh]î(h�åimageîìî)Åî}î(håR.. figure:: images/identifiers.png

   Figure 1. Table structure for identifiers.
îh]îh}î(h]îh]îh]îh]îh ]îåuriîåimages/identifiers.pngîå
candidatesî}îå
*îjå
��suh&j
��hj|
��h'h(h)K1ubh�åcaptionîìî)Åî}î(hå*Figure 1. Table structure for identifiers.îh]îhå*Figure 1. Table structure for identifiers.îÖîÅî}î(hjî
��hjí
��ubah}î(h]îh]îh]îh]îh ]îuh&jê
��h'h(h)K1hj|
��ubeh}î(h]îåid1îah]îh]îh]îh ]îuh&jz
��h)K1hji
��h
hh'h(ubh�åcommentîìî)Åî}î(hXÇ
��This block defines the table structure diagram referenced above.
@startuml images/identifiers.png

identifiers "*" -- "1" xml_documents

identifiers : String identifier
identifiers : String docid
identifiers : Integer rev

xml_documents : String docid
xml_documents : String rev

note right of identifiers
  "identifiers.(docid,rev) is a foreign key into xml_documents"
end note
@endumlîh]îhXÇ
��This block defines the table structure diagram referenced above.
@startuml images/identifiers.png

identifiers "*" -- "1" xml_documents

identifiers : String identifier
identifiers : String docid
identifiers : Integer rev

xml_documents : String docid
xml_documents : String rev

note right of identifiers
  "identifiers.(docid,rev) is a foreign key into xml_documents"
end note
@endumlîÖîÅî}î(hhhj©
��ubah}î(h]îh]îh]îh]îh ]îh$h%uh&jß
��hji
��h
hh'h(h)KDubh
)Åî}î(hå\newpageîh]îhå\newpageîÖîÅî}î(hhhj∑
��ubah}î(h]îh]îh]îh]îh ]îåformatîålatexîh$h%uh&h	h'h(h)KEhji
��h
hubh
)Åî}î(hå	PageBreakîh]îhå	PageBreakîÖîÅî}î(hhhj«
��ubah}î(h]îh]îh]îh]îh ]îåformatîåpdfîh$h%uh&h	h'h(h)KIhji
��h
hubeh}î(h]îåidentifier-table-structureîah]îh]îåidentifier table structureîah]îh ]îuh&h*hjJ
��h
hh'h(h)K-ubh+)Åî}î(hhh]î(h0)Åî}î(hå!Handling document read operationsîh]îhå!Handling document read operationsîÖîÅî}î(hj‰
��hj‚
��h
hh'Nh)Nubah}î(h]îh]îh]îh]îh ]îuh&h/hjfl
��h
hh'h(h)KOubh)Åî}î(håAAn overview of the process needed to read an object using a GUID.îh]îhåAAn overview of the process needed to read an object using a GUID.îÖîÅî}î(hjÚ
��hj
��h
hh'Nh)Nubah}î(h]îh]îh]îh]îh ]îuh&h~h'h(h)KQhjfl
��h
hubj{
��)Åî}î(hhh]î(jÄ
��)Åî}î(håñ.. figure:: images/guid_read.png

   Figure 2. Basic handling for string identifiers (GUIDs) as mapped to
   docids (LocalIDs) to retrieve an object.
îh]îh}î(h]îh]îh]îh]îh ]îåuriîåimages/guid_read.pngîjç
��}îjè
��j��suh&j
��hj˛
��h'h(h)KVubjë
��)Åî}î(håmFigure 2. Basic handling for string identifiers (GUIDs) as mapped to
docids (LocalIDs) to retrieve an object.îh]îhåmFigure 2. Basic handling for string identifiers (GUIDs) as mapped to
docids (LocalIDs) to retrieve an object.îÖîÅî}î(hj��hj��ubah}î(h]îh]îh]îh]îh ]îuh&jê
��h'h(h)KVhj˛
��ubeh}î(h]îåid2îah]îh]îh]îh ]îuh&jz
��h)KVhjfl
��h
hh'h(ubj®
��)Åî}î(hX��@startuml images/guid_read.png
!include plantuml.conf
actor User
participant "Client" as app_client << Application >>
participant "CRUD API" as c_crud << MetacatRestServlet >>
participant "Identifier Manager" as ident_man << IdentifierManager >>
participant "Handler" as handler << MetacatHandler >>
User -> app_client
app_client -> c_crud: get(token, GUID)
c_crud -> ident_man: getLocalID(GUID)
c_crud <-- ident_man: localID
c_crud -> handler: handleReadAction(localID)
c_crud <-- handler: object
c_crud --> app_client: object

@endumlîh]îhX��@startuml images/guid_read.png
!include plantuml.conf
actor User
participant "Client" as app_client << Application >>
participant "CRUD API" as c_crud << MetacatRestServlet >>
participant "Identifier Manager" as ident_man << IdentifierManager >>
participant "Handler" as handler << MetacatHandler >>
User -> app_client
app_client -> c_crud: get(token, GUID)
c_crud -> ident_man: getLocalID(GUID)
c_crud <-- ident_man: localID
c_crud -> handler: handleReadAction(localID)
c_crud <-- handler: object
c_crud --> app_client: object

@endumlîÖîÅî}î(hhhj#��ubah}î(h]îh]îh]îh]îh ]îh$h%uh&jß
��hjfl
��h
hh'h(h)Kjubeh}î(h]îå!handling-document-read-operationsîah]îh]îå!handling document read operationsîah]îh ]îuh&h*hjJ
��h
hh'h(h)KOubh+)Åî}î(hhh]î(h0)Åî}î(hå#Handling document create operationsîh]îhå#Handling document create operationsîÖîÅî}î(hj>��hj<��h
hh'Nh)Nubah}î(h]îh]îh]îh]îh ]îuh&h/hj9��h
hh'h(h)Klubh)Åî}î(håCAn overview of the process needed to create an object using a GUID.îh]îhåCAn overview of the process needed to create an object using a GUID.îÖîÅî}î(hjL��hjJ��h
hh'Nh)Nubah}î(h]îh]îh]îh]îh ]îuh&h~h'h(h)Knhj9��h
hubj{
��)Åî}î(hhh]î(jÄ
��)Åî}î(håñ.. figure:: images/guid_insert.png

   Figure 3. Basic handling for string identifiers (GUIDs) as mapped to
   docids (LocalIDs) to create an object.
îh]îh}î(h]îh]îh]îh]îh ]îåuriîåimages/guid_insert.pngîjç
��}îjè
��jf��suh&j
��hjX��h'h(h)Krubjë
��)Åî}î(håkFigure 3. Basic handling for string identifiers (GUIDs) as mapped to
docids (LocalIDs) to create an object.îh]îhåkFigure 3. Basic handling for string identifiers (GUIDs) as mapped to
docids (LocalIDs) to create an object.îÖîÅî}î(hjj��hjh��ubah}î(h]îh]îh]îh]îh ]îuh&jê
��h'h(h)KrhjX��ubeh}î(h]îåid3îah]îh]îh]îh ]îuh&jz
��h)Krhj9��h
hh'h(ubj®
��)Åî}î(hX{��@startuml images/guid_insert.png
!include plantuml.conf
actor User
participant "Client" as app_client << Application >>
participant "CRUD API" as c_crud << MetacatRestServlet >>
participant "Identifier Manager" as ident_man << IdentifierManager >>
participant "Handler" as handler << MetacatHandler >>
User -> app_client
app_client -> c_crud: create(token, GUID, object, sysmeta)
c_crud -> ident_man: identifierExists(GUID)
c_crud <-- ident_man: T or F
alt identifierExists == "F"
    c_crud -> ident_man: mapToLocalId(GUID)
    c_crud <-- ident_man: localID
    c_crud -> handler: handleInsertAction(localID)
    c_crud <-- handler: success
    note right of c_crud
      "Also need to address how to handle the sysmeta information wrt insertion methods"
    end note
    app_client <-- c_crud: success
else identifierExists == "T"
    app_client <-- c_crud: IdentifierNotUnique
end
@endumlîh]îhX{��@startuml images/guid_insert.png
!include plantuml.conf
actor User
participant "Client" as app_client << Application >>
participant "CRUD API" as c_crud << MetacatRestServlet >>
participant "Identifier Manager" as ident_man << IdentifierManager >>
participant "Handler" as handler << MetacatHandler >>
User -> app_client
app_client -> c_crud: create(token, GUID, object, sysmeta)
c_crud -> ident_man: identifierExists(GUID)
c_crud <-- ident_man: T or F
alt identifierExists == "F"
    c_crud -> ident_man: mapToLocalId(GUID)
    c_crud <-- ident_man: localID
    c_crud -> handler: handleInsertAction(localID)
    c_crud <-- handler: success
    note right of c_crud
      "Also need to address how to handle the sysmeta information wrt insertion methods"
    end note
    app_client <-- c_crud: success
else identifierExists == "T"
    app_client <-- c_crud: IdentifierNotUnique
end
@endumlîÖîÅî}î(hhhj}��ubah}î(h]îh]îh]îh]îh ]îh$h%uh&jß
��hj9��h
hh'h(h)Kéubeh}î(h]îå#handling-document-create-operationsîah]îh]îå#handling document create operationsîah]îh ]îuh&h*hjJ
��h
hh'h(h)Klubh+)Åî}î(hhh]î(h0)Åî}î(hå#Handling document update operationsîh]îhå#Handling document update operationsîÖîÅî}î(hjò��hjñ��h
hh'Nh)Nubah}î(h]îh]îh]îh]îh ]îuh&h/hjì��h
hh'h(h)Kêubh)Åî}î(håCAn overview of the process needed to update an object using a GUID.îh]îhåCAn overview of the process needed to update an object using a GUID.îÖîÅî}î(hj¶��hj§��h
hh'Nh)Nubah}î(h]îh]îh]îh]îh ]îuh&h~h'h(h)Kíhjì��h
hubj{
��)Åî}î(hhh]î(jÄ
��)Åî}î(håñ.. figure:: images/guid_update.png

   Figure 4. Basic handling for string identifiers (GUIDs) as mapped to
   docids (LocalIDs) to update an object.
îh]îh}î(h]îh]îh]îh]îh ]îåuriîåimages/guid_update.pngîjç
��}îjè
��j¿��suh&j
��hj≤��h'h(h)Kñubjë
��)Åî}î(håkFigure 4. Basic handling for string identifiers (GUIDs) as mapped to
docids (LocalIDs) to update an object.îh]îhåkFigure 4. Basic handling for string identifiers (GUIDs) as mapped to
docids (LocalIDs) to update an object.îÖîÅî}î(hjƒ��hj¬��ubah}î(h]îh]îh]îh]îh ]îuh&jê
��h'h(h)Kñhj≤��ubeh}î(h]îåid4îah]îh]îh]îh ]îuh&jz
��h)Kñhjì��h
hh'h(ubj®
��)Åî}î(hXÉ��@startuml images/guid_update.png
!include plantuml.conf
actor User
participant "Client" as app_client << Application >>
participant "CRUD API" as c_crud << MetacatRestServlet >>
participant "Identifier Manager" as ident_man << IdentifierManager >>
participant "Handler" as handler << MetacatHandler >>
User -> app_client
app_client -> c_crud: update(token, GUID, object, obsoletedGUID, sysmeta)

c_crud -> ident_man: identifierExists(obsoletedGUID)
c_crud <-- ident_man: T or F
alt identifierExists == "T"

    c_crud -> ident_man: identifierExists(GUID)
    c_crud <-- ident_man: T or F
    alt identifierExists == "F"
        c_crud -> ident_man: mapToLocalId(GUID, obsoletedGUID)
        c_crud <-- ident_man: localID
        c_crud -> handler: handleUpdateAction(localID)
        c_crud <-- handler: success
        note right of c_crud
          "Also need to address how to handle the sysmeta information wrt update methods"
        end note
        app_client <-- c_crud: success
    else identifierExists == "T"
        app_client <-- c_crud: IdentifierNotUnique
    end
else identifierExists == "F"
    app_client <-- c_crud: NotFound
end
@endumlîh]îhXÉ��@startuml images/guid_update.png
!include plantuml.conf
actor User
participant "Client" as app_client << Application >>
participant "CRUD API" as c_crud << MetacatRestServlet >>
participant "Identifier Manager" as ident_man << IdentifierManager >>
participant "Handler" as handler << MetacatHandler >>
User -> app_client
app_client -> c_crud: update(token, GUID, object, obsoletedGUID, sysmeta)

c_crud -> ident_man: identifierExists(obsoletedGUID)
c_crud <-- ident_man: T or F
alt identifierExists == "T"

    c_crud -> ident_man: identifierExists(GUID)
    c_crud <-- ident_man: T or F
    alt identifierExists == "F"
        c_crud -> ident_man: mapToLocalId(GUID, obsoletedGUID)
        c_crud <-- ident_man: localID
        c_crud -> handler: handleUpdateAction(localID)
        c_crud <-- handler: success
        note right of c_crud
          "Also need to address how to handle the sysmeta information wrt update methods"
        end note
        app_client <-- c_crud: success
    else identifierExists == "T"
        app_client <-- c_crud: IdentifierNotUnique
    end
else identifierExists == "F"
    app_client <-- c_crud: NotFound
end
@endumlîÖîÅî}î(hhhj◊��ubah}î(h]îh]îh]îh]îh ]îh$h%uh&jß
��hj�h
hh'h(h)K∫ubeh}î(h]îå#handling-document-update-operationsîah]îh]îå#handling document update operationsîah]îh ]îuh&h*hjJ
��h
hh'h(h)Kêubh+)Åî}î(hhh]î(h0)Åî}î(hå#Handling document delete operationsîh]îhå#Handling document delete operationsîÖîÅî}î(hjÚ��hj��h
hh'Nh)Nubah}î(h]îh]îh]îh]îh ]îuh&h/hjÌ��h
hh'h(h)Kºubh)Åî}î(håCAn overview of the process needed to delete an object using a GUID.îh]îhåCAn overview of the process needed to delete an object using a GUID.îÖîÅî}î(hj���hj˛��h
hh'Nh)Nubah}î(h]îh]îh]îh]îh ]îuh&h~h'h(h)KæhjÌ��h
hubj{
��)Åî}î(hhh]î(jÄ
��)Åî}î(håñ.. figure:: images/guid_delete.png

   Figure 5. Basic handling for string identifiers (GUIDs) as mapped to
   docids (LocalIDs) to delete an object.
îh]îh}î(h]îh]îh]îh]îh ]îåuriîåimages/guid_delete.pngîjç
��}îjè
��j��suh&j
��hj��h'h(h)K¬ubjë
��)Åî}î(håkFigure 5. Basic handling for string identifiers (GUIDs) as mapped to
docids (LocalIDs) to delete an object.îh]îhåkFigure 5. Basic handling for string identifiers (GUIDs) as mapped to
docids (LocalIDs) to delete an object.îÖîÅî}î(hj��hj��ubah}î(h]îh]îh]îh]îh ]îuh&jê
��h'h(h)K¬hj��ubeh}î(h]îåid5îah]îh]îh]îh ]îuh&jz
��h)K¬hjÌ��h
hh'h(ubj®
��)Åî}î(hX‡��@startuml images/guid_delete.png
!include plantuml.conf
actor User
participant "Client" as app_client << Application >>
participant "CRUD API" as c_crud << MetacatRestServlet >>
participant "Identifier Manager" as ident_man << IdentifierManager >>
participant "Handler" as handler << MetacatHandler >>
User -> app_client
app_client -> c_crud: delete(token, GUID)
c_crud -> ident_man: identifierExists(GUID)
c_crud <-- ident_man: T or F
alt identifierExists == "T"
    c_crud -> ident_man: mapToLocalId(GUID)
    c_crud <-- ident_man: localID
    c_crud -> handler: handleDeleteAction(localID)
    c_crud <-- handler: success
    app_client <-- c_crud: success
else identifierExists == "F"
    app_client <-- c_crud: NotFound
end
@endumlîh]îhX‡��@startuml images/guid_delete.png
!include plantuml.conf
actor User
participant "Client" as app_client << Application >>
participant "CRUD API" as c_crud << MetacatRestServlet >>
participant "Identifier Manager" as ident_man << IdentifierManager >>
participant "Handler" as handler << MetacatHandler >>
User -> app_client
app_client -> c_crud: delete(token, GUID)
c_crud -> ident_man: identifierExists(GUID)
c_crud <-- ident_man: T or F
alt identifierExists == "T"
    c_crud -> ident_man: mapToLocalId(GUID)
    c_crud <-- ident_man: localID
    c_crud -> handler: handleDeleteAction(localID)
    c_crud <-- handler: success
    app_client <-- c_crud: success
else identifierExists == "F"
    app_client <-- c_crud: NotFound
end
@endumlîÖîÅî}î(hhhj1��ubah}î(h]îh]îh]îh]îh ]îh$h%uh&jß
��hj��h
hh'h(h)K€ubj®
��)Åî}î(hXN��This block defines the interaction diagram referenced above.
startuml images/01_interaction.png
  !include plantuml.conf
  actor User
  participant "Client" as app_client << Application >>
  User -> app_client

  participant "CRUD API" as c_crud << Coordinating Node >>
  activate c_crud
  app_client -> c_crud: resolve(GUID, auth_token)
  participant "Authorization API" as c_authorize << Coordinating Node >>
  c_crud -> c_authorize: isAuth(auth_token, GUID)
  participant "Verify API" as c_ver << Coordinating Node >>
  c_authorize -> c_ver: isValidToken (token)
  c_authorize <-- c_ver: T or F
  c_crud <-- c_authorize: T or F
  app_client <-- c_crud: handle_list
  deactivate c_crud

  participant "CRUD API" as m_crud << Member Node >>
  activate m_crud
  app_client -> m_crud: get(auth_token, handle)
  participant "Server Authentication API" as m_authenticate << Member Node >>
  m_crud -> m_authenticate: isAuth(auth_token, GUID)
  m_crud <-- m_authenticate: T or F
  m_crud -> m_crud: log(get, UserID, GUID)
  app_client <-- m_crud: object or unauth or doesNotExist
  deactivate m_crud
endumlîh]îhXN��This block defines the interaction diagram referenced above.
startuml images/01_interaction.png
  !include plantuml.conf
  actor User
  participant "Client" as app_client << Application >>
  User -> app_client

  participant "CRUD API" as c_crud << Coordinating Node >>
  activate c_crud
  app_client -> c_crud: resolve(GUID, auth_token)
  participant "Authorization API" as c_authorize << Coordinating Node >>
  c_crud -> c_authorize: isAuth(auth_token, GUID)
  participant "Verify API" as c_ver << Coordinating Node >>
  c_authorize -> c_ver: isValidToken (token)
  c_authorize <-- c_ver: T or F
  c_crud <-- c_authorize: T or F
  app_client <-- c_crud: handle_list
  deactivate c_crud

  participant "CRUD API" as m_crud << Member Node >>
  activate m_crud
  app_client -> m_crud: get(auth_token, handle)
  participant "Server Authentication API" as m_authenticate << Member Node >>
  m_crud -> m_authenticate: isAuth(auth_token, GUID)
  m_crud <-- m_authenticate: T or F
  m_crud -> m_crud: log(get, UserID, GUID)
  app_client <-- m_crud: object or unauth or doesNotExist
  deactivate m_crud
endumlîÖîÅî}î(hhhj?��ubah}î(h]îh]îh]îh]îh ]îh$h%uh&jß
��hj��h
hh'h(h)K˘ubeh}î(h]îå#handling-document-delete-operationsîah]îh]îå#handling document delete operationsîah]îh ]îuh&h*hjJ
��h
hh'h(h)Kºubeh}î(h]îåidentifier-resolutionîah]îh]îåidentifier resolutionîah]îh ]îuh&h*hh,h
hh'h(h)Kubeh}î(h]îåidentifier-managementîah]îh]îåidentifier managementîah]îh ]îuh&h*hhh
hh'h(h)Kubeh}î(h]îh]îh]îh]îh ]îåsourceîh(uh&h
åcurrent_sourceîNåcurrent_lineîNåsettingsîådocutils.frontendîåValuesîìî)Åî}î(h/Nå	generatorîNå	datestampîNåsource_linkîNå
source_urlîNå
toc_backlinksîåentryîåfootnote_backlinksîK
å
sectnum_xformîK
åstrip_commentsîNåstrip_elements_with_classesîNå
strip_classesîNåreport_levelîKå
halt_levelîKåexit_status_levelîKådebugîNåwarning_streamîNå	tracebackîàåinput_encodingîå	utf-8-sigîåinput_encoding_error_handlerîåstrictîåoutput_encodingîåutf-8îåoutput_encoding_error_handlerîjà��åerror_encodingîåUTF-8îåerror_encoding_error_handlerîåbackslashreplaceîå
language_codeîåenîårecord_dependenciesîNåconfigîNå	id_prefixîhåauto_id_prefixîåidîå
dump_settingsîNådump_internalsîNådump_transformsîNådump_pseudo_xmlîNåexpose_internalsîNåstrict_visitorîNå_disable_configîNå_sourceîh(å_destinationîNå
_config_filesî]îåpep_referencesîNåpep_base_urlîå https://www.python.org/dev/peps/îåpep_file_url_templateîåpep-%04dîårfc_referencesîNårfc_base_urlîåhttps://tools.ietf.org/html/îå	tab_widthîKåtrim_footnote_reference_spaceîâåfile_insertion_enabledîàåraw_enabledîK
åsyntax_highlightîålongîåsmart_quotesîàåsmartquotes_localesîNåcharacter_level_inline_markupîâådoctitle_xformîâå
docinfo_xformîK
åsectsubtitle_xformîâåembed_stylesheetîâåcloak_email_addressesîàåenvîNågettext_compactîàubåreporterîNåindirect_targetsî]îåsubstitution_defsî}îåsubstitution_namesî}îårefnamesî}îårefidsî}îhO]îhTasånameidsî}î(jb��j_��jZ��jW��j‹
��jŸ
��j6��j3��jê��jç��jÍ��jÁ��jR��jO��uå	nametypesî}î(jb��NjZ��Nj‹
��Nj6��Njê��NjÍ��NjR��Nuh}î(j_��h,hOh`jW��jJ
��jŸ
��ji
��j3��jfl
��jç��j9��jÁ��jì��jO��jÌ��j¢
��j|
��j��j˛
��jx��jX��j“��j≤��j,��j��uå
footnote_refsî}îå
citation_refsî}îå
autofootnotesî]îåautofootnote_refsî]îåsymbol_footnotesî]îåsymbol_footnote_refsî]îå	footnotesî]îå	citationsî]îåautofootnote_startîK
åsymbol_footnote_startîK�åid_startîKåparse_messagesî]îåtransform_messagesî]îh�åsystem_messageîìî)Åî}î(hhh]îh)Åî}î(hhh]îhå-Hyperlink target "index-0" is not referenced.îÖîÅî}î(hhhjÁ��ubah}î(h]îh]îh]îh]îh ]îuh&h~hj‰��ubah}î(h]îh]îh]îh]îh ]îålevelîK
åtypeîåINFOîåsourceîh(ålineîK
uh&j‚��ubaåtransformerîNå
decorationîNh
hub.