Difference between revisions of "Pid Cache Manager Service"

From MPDLMediaWiki
Jump to navigation Jump to search
Line 37: Line 37:
== Service Interface ==
== Service Interface ==
* The PID cache service provides a REST interface:
* The PID cache service provides a REST interface:
** GET: /<service>/<prefix>/<suffix> - resolve
** GET: /pidcache/handle/read, implemting 2 methods:
** PUT: /<service>/<prefix>/<suffix> - registration at PID system (Not implemented)
*** /view?pid= - resolve PID
** POST: /<service>/<prefix>/ - identifier generation and registration at PID system
*** /search?url= - Find a PID
** DELETE: /<service>/<prefix>/<suffix> - delete (Not allowed)
** PUT: Not Implemented
* <service>: the url of the pid cache service (for instance: dev-pubman.mpdl.mpg.de/pidcache/handle)
** POST: /pidcache/handle/write - Implements 2 methods:
* <prefix>/<suffix>: the method called:
*** /create - Create a PID at GWDG (url passed as body parameter).
** /read/view : Visualization of a PID.
*** /update?pid= - Update a PID with new url (url passed as body parameter)
** /read/search: Search of a PID.
** DELETE: (Not allowed)
** /write/create: Creation of a PID.
** /write/update: Update of a PID.

Revision as of 14:55, 15 March 2010

This Page describes the PID cache service.

ID (Label)[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.


Service Interface[edit]

  • The PID cache service provides a REST interface:
    • GET: /pidcache/handle/read, implemting 2 methods:
      • /view?pid= - resolve PID
      • /search?url= - Find a PID
    • PUT: Not Implemented
    • POST: /pidcache/handle/write - Implements 2 methods:
      • /create - Create a PID at GWDG (url passed as body parameter).
      • /update?pid= - Update a PID with new url (url passed as body parameter)
    • DELETE: (Not allowed)