Pid Cache Manager Service

From MPDLMediaWiki
Revision as of 15:12, 8 January 2013 by Siedersleben (talk | contribs) (→‎
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
eSciDoc SOA

SOAP and REST style interfaces
Service layers

Core services
Context Handler · Item Handler
Container Handler
Organizational Unit Handler
User Account Handler
Content Model Handler
Semantic Store Handler

Intermediate services
Validation Service
Statistics Manager
Technical Metadata extraction
Basket Handler
Duplication detection

Application services
Control of Named Entities
Citation style Manager
Fledged Data
PID Cache

SOA Introduction


This Page describes the PID cache service.

ID (Label)[edit]


Complete Name[edit]

PID Cache Manager Service


Running with pidmanager 0.6


  • The PID cache service is a client to the GWDG PID Handle Service.
  • The PID cache service is used as an alternative to the PIDManager service offered by eSciDoc core infrastructure (PID Service without pre-cached PIDs).
  • The PID cache service holds pre-created PIDs which are assigned to an eSciDoc content resource by calling the Item/Container Handler methods (assignObjectPid(), assignVersionPid() or assignContentPid()).

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 allowed.
    • 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)


  1. Install files in deploy directory:
    1. pidmanger.war
    2. pid_cache.ear
    3. pid-cache-ds.xml (see source below)
  2. Defines properties in conf directory and changes with your own credentials (see sources below):
    2. with: <entry key="service.url"></entry> (changes with correct escidoc url)
    3. (if installed with pubman, then uses instead)


<?xml version="1.0" encoding="utf-8"?>
			<type-mapping>Hypersonic SQL</type-mapping>

# uncomment following line to use the PID Manager as PID service backend
escidoc-core.PidSystemFactory = de.escidoc.core.common.persistence.impl.PIDManagerRESTServiceFactory

# set parameter for the PID Managment service
# = http://localhost:8080/pidmanager/pid/

# must match <entry key="PIDManager:User"> in
escidoc-core.PidSystemRESTService.user = pid_manager

# must match <entry key="PIDManager:Password"> in
escidoc-core.PidSystemRESTService.password = XXX_SOME_PASSWORD_XXX

# must match <entry key="globalPrefix"> in
escidoc-core.PidSystem.globalPrefix = gwdg[edit]

<?xml version="1.0" encoding="UTF-8"?> 
<!DOCTYPE properties SYSTEM ""> 
	<comment>Local Handle Resolver Access Parameter</comment> 
	<!-- customize values to your GWDG handle account -->
	<entry key="globalPrefix">gwdg</entry>

	<entry key="service.url"></entry>
	<entry key="service.username">pid_manager</entry>
	<entry key="service.password">XXX_SAME_PASSWORD_AS_IN_escodoc-core.properties_XXX</entry>

	<!-- define path of service
		e.g. http://hostname:port/pidmanager/pid 
	<entry key="ResourcePath:Handle">/gwdg</entry>
	<entry key="ResourcePath:Resolve">/gwdg/{suffix}</entry>

	<!-- methods: semantic, random, serial, .. -->
	<!-- debug creates an fixed identifier -->
	<!-- semantic use the identifier which must be given via param. -->
	<!-- <param><systemID>escidoc:40312:4</systemID></param> -->
	<!-- The systemID is automatically added by framework stub.  -->
	<!-- <entry key="generatorMethod">semantic</entry> -->
	<!-- Use value "minter" to receive the identifier from the minter (NOID),
	set to "service" to let the GWDG service create identifier --> 
	<entry key="IdGenerator:Mode">service</entry>

	<!-- create identifier with local prefix -->
	<!-- e.g. 12345/test-123abcd456, where test- is the -->
	<!-- configured local prefix part. Leave it empty for no -->
	<!-- prefix. -->
	<entry key="localPrefix"></entry>

	<!-- allow override identifier by client - this means preminted PIDs which are to register -->
	<entry key="IdGenerator:Mode.override">true</entry>

	<!-- log/debug -->
	<entry key="debug">true</entry>
	<entry key="debug.traceMessages">true</entry>

	<!-- Run service without communication with Handle resolver (true/false) -->
	<!-- All response values are predefined -->
	<entry key="debug.coldRun">false</entry>

	<!-- debug identifier must have at minimum length 3 --> 
	<entry key="debug.identifier">test-handle-123:3</entry>

	<entry key="ResourceClass">de.escidoc.pidmanager.pidSystems.handleGWDG.Handle</entry>

	<!-- Class binding -->
	<entry key="BindingResources">Handle;Resolve</entry>

# PID cache properties
# must match <entry key="PIDManager:User"> in
# must match <entry key="PIDManager:Password"> in

<?xml version="1.0" encoding="UTF-8"?> 
<!DOCTYPE properties SYSTEM ""> 
<comment>REST Structure</comment> 
	<entry key="PIDManager:Port">8080</entry>
        <entry key="PIDManager:ServicePath">/handle</entry>

	<!-- enable/disable access restriction --> 
	<entry key="PIDManager:RestrictAccess">true</entry>
	<!-- change user and password -->
	<entry key="PIDManager:User">pid_manager</entry>
	<entry key="PIDManager:Password">XXX_SAME_PASSWORD_AS_IN_escodoc-core.properties_XXX</entry>
	<!-- services -->
	<entry key="Resources">gwdg</entry>

	<entry key="Resource:gwdg"></entry>

	<!-- logging -->
	<entry key="PIDManager:LogConfigFile">log4j-pidmanager.xml</entry>

	<!-- Set path where static files accessible via HTTP -->
	<entry key="IdGenerator:Storage">SQLite</entry>
	<entry key="SQLite:DBFile">pidmanager.sqlite</entry>

	<!-- Unique Identifier creation via NOID -->
	<!-- entry key="PIDManager:NoidMinterURL">http://localhost/cgi-bin/minter/</entry -->
	<entry key="IdGenerator:NoidMinterURL">http://localhost/cgi-bin/noid/niodu_kt5</entry>