Pid Cache Manager Service

From MPDLMediaWiki
Revision as of 16:00, 11 March 2010 by Bastien (talk | contribs)
Jump to navigation Jump to search

This Page describes the PID cache service.

ID[edit]

PIDC

Complete Name[edit]

PID Cache Manager Service

Status[edit]

Work in Progress (version 0.1.0 in test).

Description[edit]

  • The role of the PID cache service is to avoid unavailability of the GWDG PID Handle Service.
  • The PID cache service is used as alternative to the PIDManager service offered by eSciDoc core infrastructure.
  • The PID cache service holds pre-created PIDs which are assigned to an eSciDoc content resource by calling the Object Handler methods (assignObjectPid() and assignVersionPid()).

Operations Overview[edit]

Operation Status Input Output Description
create implemented URL:String String Scope:Public
Assign a PID to an URL.
Update implemented URL: String
PID(handler): String
String Scope:Public
Update a PID with a new URL.
view implemented PID(handler):String String Scope:Public
Retrieve a PID (If GWDG service unavailable, can only retrieve PID that are waiting in cache to be updated at the GWDG).
Search implemented URL:String String Scope:Public
Search for a PID (If GWDG service unavailable, can only search for PID that are waiting in cache to be updated at the GWDG). Implements only the search by URL so far. Might be extended.


TODO[edit]

  • The PID cache service provides a REST interface:
    • GET: /<service>/<prefix>/<suffix> - resolve
    • PUT: /<service>/<prefix>/<suffix> - registration at PID system (Not implemented)
    • POST: /<service>/<prefix>/ - identifier generation and registration at PID system
    • DELETE: /<service>/<prefix>/<suffix> - delete (Not allowed)
  • <service>: the url of the pid cache service (for instance: dev-pubman.mpdl.mpg.de/pidcache/handle)
  • <prefix>/<suffix>: the method called:
    • /read/view : Visualization of a PID.
    • /read/search: Search of a PID.
    • /write/create: Creation of a PID.
    • /write/update: Update of a PID.