diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle index b95ab346c18b1f98053b20b06dbc59a90542e81d..dbd1273f3107a2b70fcd90fd6de8711ea3ac6814 100644 Binary files a/docs/_build/doctrees/environment.pickle and b/docs/_build/doctrees/environment.pickle differ diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js index 7c88fc9734301ef3a7bfa25d7e5111e9141f5072..264edf66ad570235342f2506577db397d5fdc3aa 100644 --- a/docs/_build/html/searchindex.js +++ b/docs/_build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({envversion:42,terms:{test1:1,all:[0,1],belong:1,identifi:[],just:1,show:1,text:1,prefix:1,datestamp:1,earliestdatestamp:1,protocolvers:1,paramet:1,xml:1,"21t12":1,onli:1,"21t14":1,granular:1,"29z":1,everi:1,string:1,format:1,getrecord:[],verb:1,adminemail:1,requir:1,term:1,specif:1,edit:[0,1],michael:1,leuk:1,listidentifi:[],item:1,xsd:1,"40z":1,respond:1,www:1,set:1,be58:1,some:1,see:[0,1],aggreg:1,respons:[],further:1,"38z":1,todo:1,index:[],section:1,listdentifi:1,"43z":1,content:[],metadata:[0,1],"8741f26c":1,insid:1,responsed:1,repositori:[0,1],org:1,valu:1,search:[],hdl:1,"85e9":1,page:[],drama:1,amount:1,elasticsearch:0,yyyi:1,listrecord:[],modul:[],header:1,d618ffeec722:1,metadatanamespac:1,contributor:1,given:1,from:[0,1],"45fb":1,ddthh:1,support:1,identi:[],start:1,stirng:1,tgpr:1,licenc:0,type:1,store:0,listset:[],"68d8":1,option:1,regard:1,about:1,sessionid:[],ns2:1,ns3:1,harvest:[0,1],possibl:1,provid:1,servic:0,metadataprefix:1,structur:1,tgoaipmh:1,project:1,record:1,limit:1,can:1,error:1,"18z":1,werk:1,schema:1,openarch:1,descript:1,textgridrep:1,curl:[],gwdg:1,filter:1,b5d1:1,b068ff71:1,"12t11":1,titl:1,"12t12":1,listmetadataformat:[],same:1,other:1,which:1,ssz:1,relat:1,http:1,deletedrecord:1,metadataformat:1,object:1,baseurl:1,date:1,end:1,metadatformat:1,"807e":1,repositorynam:1,"54b3b5d26ded":1,oai_dc:1,"11t02":1,request:[],uri:1,textgrid:[0,1],inform:1,exampl:1,thi:1,time:1},objtypes:{},objnames:{},filenames:["index","api/oai"],titles:["oai-pmh","GET /oai"],objects:{},titleterms:{depend:0,welcom:[],get:1,listmetadataformat:1,licens:0,tabl:[],request:1,oai:[0,1],listset:1,api:0,indic:[],respons:[],listidentifi:1,identifi:1,document:0,pmh:0,getrecord:1,listrecord:1}}) \ No newline at end of file +Search.setIndex({envversion:42,terms:{test1:[],all:[0,1],code:1,identifi:[],just:1,show:1,text:1,andern:1,schema:1,prefix:1,datestamp:1,"12z":1,adalbert:1,yet:1,protocolvers:1,paramet:1,xml:1,"21t12":1,onli:1,thi:1,besond:1,"21t14":1,stefl:1,setnam:1,"gebr\u00e4uch":1,descript:1,granular:1,"37z":1,"29z":1,about:1,resumptiontoken:1,legalcod:1,larg:1,sourc:1,everi:1,string:1,format:1,getrecord:[],term:1,"h\u00fclpe":1,band:1,verb:1,combin:1,adminemail:1,requir:1,tvitt:1,"b\u00e4nden":1,specif:1,edit:[0,1],michael:1,leuk:1,"sch\u00f6nwerth":1,listidentifi:[],item:1,sagen:1,xsd:1,page:[],d618ffeec722:1,respond:1,www:1,set:1,creator:1,be58:1,list:1,some:1,metadataprefix:1,contributor:1,see:[0,1],"04z":1,respons:[],further:1,"38z":1,todo:[],servic:0,"24z":1,index:[],identi:[],miss:1,section:1,"2c4bbefcfd3c":1,earliestdatestamp:1,listdentifi:1,version:1,"43z":1,stirng:1,content:1,metadata:[0,1],vs2:1,"8741f26c":1,gesamtausgab:1,insid:1,v73g:1,v73h:1,error:1,standalon:1,"6cd4":1,"05t03":1,repositori:[0,1],franz:1,org:1,"27z":1,brockhau:1,valu:1,ochsenkopf:1,last:1,cannotdisseminateformat:1,adelbert:1,"85e9":1,responsed:1,"40z":1,drama:1,amount:1,vs2t:1,"36z":1,oai_d:1,implement:1,other:1,textgridlab:1,yyyi:1,gesammelt:1,listrecord:[],"46z":1,modul:[],leipzig:1,encod:1,header:1,smaller:1,"22z":1,metadatanamespac:1,"18e0":1,r49:1,"28t19":1,given:1,from:[0,1],start:1,ddthh:1,support:1,empti:1,sitten:1,"45fb":1,"01b5":1,tausend:1,"m\u00e4rchen":1,tgpr:1,einigen:1,time:1,illeg:1,licenc:0,"29t10":1,type:1,setspec:1,includ:1,"68d8":1,xmln:1,gwdg:1,badverb:1,rieger:1,augsburg:1,regard:1,search:[],sessionid:[],part:1,"17z":1,ns2:1,ns3:1,harvest:[0,1],"29t11":1,creativecommon:1,bei:1,utf:1,bd44:1,possibl:1,provid:1,norddeutschland:1,der:1,r49t:1,structur:1,tgoaipmh:1,project:1,record:1,elasticsearch:0,"50z":1,store:0,den:1,diepholz:1,"18z":1,werk:1,hdl:1,fetch:1,aggreg:1,unknown:1,openarch:1,can:1,von:1,gegenden:1,argument:1,textgridrep:1,badargu:1,right:1,wiesbaden:1,prose:1,limit:1,curl:[],"null":1,nachkommenschaften:1,option:1,result:1,filter:1,b5d1:1,b068ff71:1,"12t11":1,titl:1,"12t12":1,"57f2":1,same:1,listset:[],herausgegeben:1,which:1,angrenzenden:1,und:1,ssz:1,belong:1,purl:1,repositorynam:1,relat:1,http:1,e464:1,deletedrecord:1,metadataformat:1,max:1,object:1,listmetadataformat:[],baseurl:1,"04t08":1,norecordsmatch:1,kuhn:1,date:1,end:1,metadatformat:1,"807e":1,oberpfalz:1,"54b3b5d26ded":1,oai_dc:1,"02z":1,"11t02":1,sech:1,insel:1,request:[],uri:1,element:1,textgrid:[0,1],inform:1,exampl:1,"372fe6dc":1,westfalen:1,textgridrepositori:1,stifter:1},objtypes:{},objnames:{},filenames:["index","api/oai"],titles:["oai-pmh","GET /oai"],objects:{},titleterms:{depend:0,welcom:[],get:1,listmetadataformat:1,licens:0,tabl:[],request:1,oai:[0,1],listset:1,api:0,indic:[],respons:[],listidentifi:1,identifi:1,document:0,pmh:0,getrecord:1,listrecord:1}}) \ No newline at end of file diff --git a/docs/api/oai.rst b/docs/api/oai.rst index 0bf5241bdf3fca943a1c0f8faa5348401ce5d577..bc378244ea39a8cbd27c998dc3589333a7432903 100644 --- a/docs/api/oai.rst +++ b/docs/api/oai.rst @@ -13,6 +13,7 @@ listRecords Get all records of the repository. The amount of records ca listIdentifiers Same as the listRecords request but only the header of thes listRecords request is given listMetadataFormats Shows the metadatformats supported by the repository or all metadataformats provided for a specific item listSets Shows the structure of the repository +resumptionToken Fetching last responses in smaller parts (not yet implemented in textgrid) ==================== ======================================================================================================================= ---------------- @@ -31,7 +32,7 @@ verb=identify String verb for the identify request **Example request**:: - http://textgrid-test1.gwdg.de/1.0/tgoaipmh/oai?verb=Identify + http://textgridlab.org/1.0/tgoaipmh/oai?verb=Identify **Example Response**:: @@ -50,10 +51,13 @@ verb=identify String verb for the identify request </OAI-PMH> -**Example Error Response**:: - - TODO +**Error Response (Illegal Verb) **:: + <OAI-PMH> + <responseDate>2015-10-29T10:40:22Z</responseDate> + <request>www.textgridrep.de</request> + <error code="badVerb">Illegal OAI-PMH verb</error> + </OAI-PMH> ----------------- getRecord Request @@ -74,7 +78,7 @@ metadataPrefix Stirng prefix to get the items in a specific metada **Example request**:: - http://textgrid-test1.gwdg.de/1.0/tgoaipmh/oai?verb=GetRecord&identifier=textgrid:7t.0&metadataPrefix=oai_dc + http://textgridlab.org/1.0/tgoaipmh/oai?verb=GetRecord&identifier=textgrid:7t.0&metadataPrefix=oai_dc **Example Response**:: @@ -106,10 +110,21 @@ metadataPrefix Stirng prefix to get the items in a specific metada </OAI-PMH> -**Example Error Response**:: +**Example Error Response (URI is no content of TextGridRepository)**:: - TODO + <OAI-PMH> + <responseDate>2015-10-29T10:43:17Z</responseDate> + <request verb="GetRecord" identifier="textgrid:t.0" metadataPrefix="oai_dc">www.textgridrep.de</request> + <error code="noRecordsMatch">The value of the identifier: textgrid:t.0 is unknown or illegal in this repository</error> + </OAI-PMH> +**Example Error Response (includes illegal arguments or is missing required arguments)**:: + + <OAI-PMH> + <responseDate>2015-10-29T10:44:37Z</responseDate> + <request verb="GetRecord" identifier="textgrid:7t.0">www.textgridrep.de</request> + <error code="badArgument">The request includes illegal arguments or is missing required arguments: [metadataPrefix]</error> + </OAI-PMH> ------------------- listRecords Request @@ -123,6 +138,7 @@ from date start time of the responded items to date end time of the responded items no set String get just item for a specific term no metadataPrefix String prefix to get the items in a specific metadata format yes +resumptionToken String fetching large responses in smaller parts not implemented no ========================== ======= ====================================================================== ========== @@ -132,16 +148,113 @@ metadataPrefix String prefix to get the items in a specific metada **Example request**:: - http://textgrid-test1.gwdg.de/1.0/tgoaipmh/oai?verb=GetRecord&identifier=textgrid:7t.0&metadataPrefix=oai_dc + http://textgridlab.org/1.0/tgoaipmh/oai?verb=ListRecords&metadataPrefix=oai_dc **Example Response**:: - TODO + <?xml version="1.0" encoding="UTF-8" standalone="yes"?> + <OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:ns2="http://purl.org/dc/elements/1.1/" + xmlns:ns3="http://www.openarchives.org/OAI/2.0/oai_dc/"> + <responseDate>2015-10-29T11:09:24Z</responseDate> + <request verb="ListRecords" metadataPrefix="oai_dc">www.textgridrep.de</request> + <ListRecords> + <record> + <header> + <identifier>textgrid:r49s.0</identifier> + <datestamp>2012-01-28T19:54:02Z</datestamp> + </header> + <metadata> + <ns3:dc> + <ns2:contributor>tvitt@textgrid.de</ns2:contributor> + <ns2:creator>Kuhn, Adalbert</ns2:creator> + <ns2:date>2012-01-28T19:54:02Z</ns2:date> + <ns2:format>text/tg.edition+tg.aggregation+xml</ns2:format> + <ns2:identifier>textgrid:r49s.0</ns2:identifier> + <ns2:identifier>hdl:11858/00-1734-0000-0003-BD44-0</ns2:identifier> + <ns2:relation>TGPR-372fe6dc-57f2-6cd4-01b5-2c4bbefcfd3c</ns2:relation> + <ns2:relation>25. St.-Hülpe bei Diepholz</ns2:relation> + <ns2:relation>textgrid:r49t.0</ns2:relation> + <ns2:rights>http://creativecommons.org/licenses/by/3.0/de/legalcode</ns2:rights> + <ns2:source>Kuhn, Adalbert</ns2:source> + <ns2:source>Adalbert Kuhn: Sagen, Gebräuche und Märchen aus Westfalen und + einigen andern, besonders den angrenzenden Gegenden Norddeutschlands 1–2. + Band 1, Leipzig: Brockhaus, 1859.</ns2:source> + <ns2:source>Leipzig</ns2:source> + <ns2:source>20</ns2:source> + <ns2:title>25. St.-Hülpe bei Diepholz</ns2:title> + <ns2:type>other</ns2:type> + </ns3:dc> + </metadata> + </record> + <record> + <header> + <identifier>textgrid:vs2t.0</identifier> + <datestamp>2012-02-05T03:08:12Z</datestamp> + </header> + <metadata> + <ns3:dc> + <ns2:contributor>tvitt@textgrid.de</ns2:contributor> + <ns2:creator>Stifter, Adalbert</ns2:creator> + <ns2:date>2012-02-05T03:08:12Z</ns2:date> + <ns2:format>text/tg.edition+tg.aggregation+xml</ns2:format> + <ns2:identifier>textgrid:vs2t.0</ns2:identifier> + <ns2:identifier>hdl:11858/00-1734-0000-0005-18E0-5</ns2:identifier> + <ns2:relation>TGPR-372fe6dc-57f2-6cd4-01b5-2c4bbefcfd3c</ns2:relation> + <ns2:relation>Nachkommenschaften</ns2:relation> + <ns2:relation>textgrid:vs2s.0</ns2:relation> + <ns2:rights>http://creativecommons.org/licenses/by/3.0/de/legalcode</ns2:rights> + <ns2:source>Stifter, Adalbert</ns2:source> + <ns2:source>Adelbert Stifter: Gesammelte Werke in sechs Bänden, [herausgegeben + von Max Stefl,] Band 3, 6.–10. Tausend der Gesamtausgabe, Wiesbaden: Insel, + 1959.</ns2:source> + <ns2:source>Wiesbaden</ns2:source> + <ns2:source>565</ns2:source> + <ns2:title>Nachkommenschaften</ns2:title> + <ns2:type>prose</ns2:type> + </ns3:dc> + </metadata> + </record> + <record> + <header> + <identifier>textgrid:v73g.0</identifier> + <datestamp>2012-02-04T08:33:36Z</datestamp> + </header> + <metadata> + <ns3:dc> + <ns2:contributor>tvitt@textgrid.de</ns2:contributor> + <ns2:creator>Schönwerth, Franz</ns2:creator> + <ns2:date>2012-02-04T08:33:36Z</ns2:date> + <ns2:format>text/tg.edition+tg.aggregation+xml</ns2:format> + <ns2:identifier>textgrid:v73g.0</ns2:identifier> + <ns2:identifier>hdl:11858/00-1734-0000-0004-E464-5</ns2:identifier> + <ns2:relation>TGPR-372fe6dc-57f2-6cd4-01b5-2c4bbefcfd3c</ns2:relation> + <ns2:relation>2. Das Ochsenkopf</ns2:relation> + <ns2:relation>textgrid:v73h.0</ns2:relation> + <ns2:rights>http://creativecommons.org/licenses/by/3.0/de/legalcode</ns2:rights> + <ns2:source>Schönwerth, Franz</ns2:source> + <ns2:source>Franz Schönwerth: Aus der Oberpfalz. Sitten und Sagen 1–3, Band 2, + Augsburg: Rieger, 1857/58/59.</ns2:source> + <ns2:source>Augsburg</ns2:source> + <ns2:source>238</ns2:source> + <ns2:title>2. Das Ochsenkopf</ns2:title> + <ns2:type>other</ns2:type> + </ns3:dc> + </metadata> + </record> + </ListRecords> + </OAI-PMH> + **Example Error Response**:: - TODO + <OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:ns2="http://purl.org/dc/elements/1.1/" xmlns:ns3="http://www.openarchives.org/OAI/2.0/oai_dc/"> + <responseDate>2015-10-29T11:12:50Z</responseDate> + <request verb="ListRecords" metadataPrefix="oai_d">www.textgridrep.de</request> + <error code="cannotDisseminateFormat"> + The value of the metadataPrefix: oai_d is not supported by the item identified by the value of: null + </error> + </OAI-PMH> ----------------- @@ -156,6 +269,7 @@ metadataPrefix String format for the metadata response from date start time of the responded items no to date end time of the responded items no set String get just item for a specific term no +resumptionToken String fetching large responses in smaller parts not implemented no ========================== ======= ====================================================================== ========== @@ -165,12 +279,18 @@ set String get just item for a specific term **Example request**:: - http://textgrid-test1.gwdg.de/1.0/tgoaipmh/oai?verb=GetRecord&identifier=textgrid:7t.0&metadataPrefix=oai_dc + http://textgridlab.org/1.0/tgoaipmh/oai?verb=GetRecord&identifier=textgrid:7t.0&metadataPrefix=oai_dc **Example Error Response**:: - TODO + <OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:ns2="http://purl.org/dc/elements/1.1/" xmlns:ns3="http://www.openarchives.org/OAI/2.0/oai_dc/"> + <responseDate>2015-10-29T11:22:46Z</responseDate> + <request verb="ListIdentifiers" metadataPrefix="oai_dc" from="2017">www.textgridrep.de</request> + <error code="noRecordsMatch"> + The combination of the values 2017 and null results in an empty list + </error> + </OAI-PMH> @@ -192,7 +312,7 @@ identifier URI identifier of the requested item **Example request**:: - http://textgrid-test1.gwdg.de/1.0/tgoaipmh/oai?verb=ListMetadataFormats + http://textgridlab.org/1.0/tgoaipmh/oai?verb=ListMetadataFormats **Example Response**:: @@ -208,9 +328,6 @@ identifier URI identifier of the requested item </OAI-PMH> -**Example Error Response**:: - - TODO ------------------- @@ -221,6 +338,7 @@ listSets Parameter Type Description Required ========================== ======= ====================================================================== ========== verb=listSets String verb for the listSets request yes +resumptionToken String fetching large responses in smaller parts not implemented no ========================== ======= ====================================================================== ========== @@ -230,22 +348,34 @@ verb=listSets String verb for the listSets request **Example request**:: - http://textgrid-test1.gwdg.de/1.0/tgoaipmh/oai?verb=ListSets + http://textgridlab.org/1.0/tgoaipmh/oai?verb=ListSets **Example Response**:: - <OAI-PMH> - <responseDate>2015-05-21T14:13:38Z</responseDate> - <request verb="ListMetadataFormats">www.textgridrep.de</request> - <ListMetadataFormats> - <metadataFormat> - <metadataPrefix>oai_dc</metadataPrefix> - <schema>http://www.openarchives.org/OAI/2.0/oai_dc.xsd</schema> - <metadataNamespace>http://www.openarchives.org/OAI/2.0/oai_dc/</metadataNamespace> - </metadataFormat></ListMetadataFormats> + <OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:ns2="http://purl.org/dc/elements/1.1/" xmlns:ns3="http://www.openarchives.org/OAI/2.0/oai_dc/"> + <responseDate>2015-10-29T11:27:04Z</responseDate> + <request verb="ListSets">www.textgridrep.de</request> + <ListSets> + <set> + <setSpec>textgrid:r49s.0</setSpec> + <setName/> + </set> + <set> + <setSpec>textgrid:vs2t.0</setSpec> + <setName/> + </set> + <set> + <setSpec>textgrid:v73g.0</setSpec> + <setName/> + </set> + </ListSets> </OAI-PMH> **Example Error Response**:: - TODO + <OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:ns2="http://purl.org/dc/elements/1.1/" xmlns:ns3="http://www.openarchives.org/OAI/2.0/oai_dc/"> + <responseDate>2015-10-29T11:30:27Z</responseDate> + <request>www.textgridrep.de</request> + <error code="badVerb">Illegal OAI-PMH verb</error> + </OAI-PMH> diff --git a/oaipmh-core/src/main/java/info/textgrid/middleware/RecordListDeliverer.java b/oaipmh-core/src/main/java/info/textgrid/middleware/RecordListDeliverer.java index e4fe6acfe1f690f5a8590ae0941af2ccceed05f8..0afdb2df4724ddf179a3be940ac4a16697838096 100644 --- a/oaipmh-core/src/main/java/info/textgrid/middleware/RecordListDeliverer.java +++ b/oaipmh-core/src/main/java/info/textgrid/middleware/RecordListDeliverer.java @@ -393,7 +393,7 @@ public class RecordListDeliverer { header.setDatestamp(this.dates.get(0)); header.setIdentifier(this.identifiers.get(0)); if (set != null) { - header.getSetSpec().add(DARIAHConstants.COLLECTIONREGISTRY_PREFIX + ":" + set); + header.getSetSpec().add(set); // header.getSetSpec().add(this.collectionTitle); } }