Oai Workshop Extended

www.ariadne-eu.org www.cs.kuleuven.be/~hmdb
1

OAI workshop:
OAI-PMH - Practical
session

Bram Vandeputte
K.U.Leuven
ARIADNE
1

Overview

2

Overview

• How OAI works
• Harvesting metadata : the simple way
• Setting up an OAI-PMH target
• Binding your database to the OAI-PMH target
• Harvesting metadata - take 2

2

Overview

• SettingHow OAI works target
up an OAI-PMH

2

How OAI works

• OAI “VERBS” Service Provider Metadata Provider

• Identify H HTTP Request
R
E
• ListMetadataFormats A
R (OAI Verb) P
• GetRecord V O
• ListIdentiﬁers E OAI OAI S
S I
• ListRecords T T
O
• ListSets E
HTTP Response
R
R (Valid XML)
Y

3

GetRecord

• Purpose
• Returns the metadata for a single item in the form
of an OAI record

• Parameters
• identiﬁer – unique id for item (R)
• metadataPreﬁx – metadata format for the record
(R)

4

ListRecords
• Purpose
• Retrieves metadata records for multiple items
• Parameters
• from – start date (O)
- greater than or equal to
• until – end date (O)
- less than or equal to
• set – set to harvest from (O)
• resumptionToken – ﬂow control mechanism (X)
• metadataPreﬁx – metadata format (R)
5

ListRecords – from until
http://localhost:8080/oaicat/OAIHandler?verb=ListRecords&
from=1999-01-15&until=2005-12-31&metadataPrefix=oai_lom

UTCdatetime
Dates and times are uniformly encoded using ISO8601
and are expressed in UTC throughout the protocol.
When time is included, the special UTC designator
("Z") must be used. UTC is implied for dates although
no timezone designator is specified. For example,
1957-03-20T20:30:00Z is UTC 8:30:00 PM on March
20th 1957. UTCdatetime is used in both protocol
requests and protocol replies, in the way described in
the following sections.

6

ListIdentifiers
• Purpose
• List headers for all items corresponding to the specified
parameters

• Parameters
• from – start date (O)
• until – end date (O)
• set – set to harvest from (O)
• metadataPrefix – metadata format to list identifiers for (R)
• resumptionToken – flow control mechanism (X)

7

ListSets

• Purpose
• Provide a listing of sets in which records may be
organized (may be hierarchical, overlapping, or ﬂat)

• Parameters
• None

8

Overview

9

Overview

✓ How OAI works

9

Overview

✓ How OAI works

• Harvesting up an OAI-PMH targetway
Setting metadata : the simple

9

Harvesting metadata
• the simple way : harvesting through browser
• Identify
- http://ariadne.cs.kuleuven.be/oaitarget/OAIHandler?verb=Identify
• ListMetadataFormats
- http://ariadne.cs.kuleuven.be/oaitarget/OAIHandler?verb=ListMetadataFormats
• ListRecords
- http://ariadne.cs.kuleuven.be/oaitarget/OAIHandler?verb=ListRecords&metadataPrefix=oai_lom
- http://ariadne.cs.kuleuven.be/oaitarget/OAIHandler?verb=ListRecords&resumptionToken=
• GetRecord
- http://ariadne.cs.kuleuven.be/oaitarget/OAIHandler?verb=GetRecord
&identifier=oai:ariadne.cs.kuleuven.be:BLKLKP1382&metadataPrefix=oai_lom

• ...
10

Overview

11

Overview

✓ How OAI works
✓ Harvesting metadata : the simple way

11

Setting up a target

12

Setting up a target

Wiki page with detailed instructions :
http://ariadne.cs.kuleuven.be/lomi/index.php/Setting_Up_OAI-PMH

12

OAI-PMH Target Software
2. Mapping Process

Repository metadata Repository LOM metadata

1. Get metadata - identiﬁer - lom.general.identiﬁer
out of database - title - lom.general.title
- url - lom.general.description
- project description - lom.technical.location
- ... - ...

3. Copy results in
OAI-PMH service

Repository OAI-PMH result

DYNAMO LOM 4. Serve results ARIADNE
DYNAMO LOM
metadata LOM Harvester
DYNAMO
metadata
Repository LOM
metadata
metadata

13

Setting up a target

14

Setting up a target
• Install Java, Ant & apache-tomcat
• Set environment vars
set JAVA_HOME=C:j2sdk1.5.0
set ANT_HOME=C:apache-ant-1.6.5
set PATH=%JAVA_HOME%bin;%ANT_HOME%bin;%PATH%

• Download oaicat source and build
cd <your build-dir>
type “ant”
• Deploy code
put “oaicat_5.0/dist/oaicat.war” under “apache-tomcat/webapps/”

14

Setting up a target

15

Setting up a target

• Testing the target
- http://localhost:8080/oaitarget/OAIHandler?verb=Identify
- http://localhost:8080/oaitarget/OAIHandler?verb=ListMetadataFormats

15

Setting up a target

16

Setting up a target
• Binding to example lucene index
• Download the index :
- http://ariadne.cs.kuleuven.be/MeltSqiOai/OAI/lucene.zip
• Extract
• open properties ﬁle with text editor :
- oaicat_5.0/WEB-INF/oaicat.properties
• Enter the full path of index under the
"LuceneLomCatalog.lucenePath" property
• reload the target

16

Setting up a target

17

Setting up a target

• Testing the target
- http://localhost:8080/oaitarget/OAIHandler?verb=ListRecords&metadataPrefix=oai_lom

- http://localhost:8080/oaitarget/OAIHandler?verb=ListRecords&resumptionToken=

- http://localhost:8080/oaitarget/OAIHandler?verb=GetRecord&identifier=
oai:oaicat.ariadne.org:CS_LKP_v_3.0_nr_1162 &metadataPrefix=oai_lom

17

Setting up a target

18

Setting up a target

• Validate the result metadata in the
validationService online :
• http://ariadne.cs.kuleuven.be/validationService

18

Overview

19

Overview

✓ How OAI works
✓ Setting up an OAI-PMH target

19

Binding it to your DB

20

• Implement /adapt 3 classes :
• org.ariadne.oai.server.X.catalog.XCatalog.java
➡ Implements the OAI-PMH verbs

• org.ariadne.oai.server.X.catalog.XRecordFactory.java
➡ Creates OAI-PMH headers

• org.ariadne.oai.server.X.crosswalk.XCrosswalk.java
➡ Maps arbitrary object to LOM XML object

20


21


• XCatalog.java
• For each “verb” :
- get parameters
- query database to get matching metadata
- parse metadata into java objects (Vector, HashMap, ...)
- call RecordFactory and Crosswalk to create records

21


22


• XRecordFactory.java
• Two important methods :
- getLocalIdentifier(Object nativeItem);

- getDatestamp(Object nativeItem);

22


23


• XCrosswalk.java
• Map ﬁelds of your object to LOM XML object :
- createMetadata(Object nativeItem);

23

Overview

24

Overview

✓ How OAI works
✓ Setting up an OAI-PMH target
✓ Binding your database to the OAI-PMH target

24

Harvesting metadata - take 2

25

Harvesting metadata - take 2

Download ARIADNE harvester :
http://www.cs.kuleuven.be/~bramv/oaiharvester.war

Wiki page with detailed instructions :
http://ariadne.cs.kuleuven.be/lomi/index.php/Harvesting_Metadata

25

References
• http://ariadne.cs.kuleuven.be/lomi/index.php/
Setting_Up_OAI-PMH

• http://ariadne.cs.kuleuven.be/lomi/index.php/
Harvesting_Metadata

• http://oai.grainger.uiuc.edu/FinalReport/
JCDL_2003_OAI_Intro.ppt

• http://www.cs.kuleuven.ac.be/~hmdb/SqiOaiAspect/
• http://www.oclc.org/research/software/oai/cat.htm
• http://ariadne.cs.kuleuven.be/validationService

26

Oai Workshop Extended

Recommended

Recommended

More Related Content

Viewers also liked

Viewers also liked (7)

Similar to Oai Workshop Extended

Similar to Oai Workshop Extended (20)

More from Bram Vandeputte

More from Bram Vandeputte (11)

Recently uploaded

Recently uploaded (20)

Oai Workshop Extended