Difference between revisions of "Imeji Interfaces"
Kleinfercher (talk | contribs) (added link to fds) |
m (added property files paths) |
||
| Line 2: | Line 2: | ||
This page describes the interfaces for the imeji application. For data dissemination imeji exploits the [[ESciDoc_Services_FledgedDataService | '''Fledged Data Service''']] of the eSciDoc SOA infrastructure. | This page describes the interfaces for the imeji application. For data dissemination imeji exploits the [[ESciDoc_Services_FledgedDataService | '''Fledged Data Service''']] of the eSciDoc SOA infrastructure. | ||
* The properties file of the Fledged Data Service can be found in the presentation module under: fledgeddata_presentation/src/main/resources/fds.properties | |||
* The properties file of the OAI interface can be found under: \jboss\server\default\conf\oai.properties | |||
These need to be adjusted. | |||
==[[Image:Rdf.jpg | 70px ]] RDF Export == | ==[[Image:Rdf.jpg | 70px ]] RDF Export == | ||
| Line 41: | Line 46: | ||
=== Verb: ListIdentifiers === | === Verb: ListIdentifiers === | ||
Gives back the oai header for all images in the repository or, if set parameter is defined , all images of a set. <br/> | Gives back the oai header for all images in the repository or, if set parameter is defined, all images of a set. <br/> | ||
'''Parameter:''' metadataPrefix, set <br/> | '''Parameter:''' metadataPrefix, set <br/> | ||
'''Example:''' http://dev-faces.mpdl.mpg.de/fledgeddata/oai/?verb=ListIdentifiers&metadataPrefix=imeji&set=http://imeji.mpdl.mpg.de/collection/134 <br/> | '''Example:''' http://dev-faces.mpdl.mpg.de/fledgeddata/oai/?verb=ListIdentifiers&metadataPrefix=imeji&set=http://imeji.mpdl.mpg.de/collection/134 <br/> | ||
| Line 47: | Line 52: | ||
=== Verb: ListRecords === | === Verb: ListRecords === | ||
Gives back the metadata record of all images in the repository or, if set parameter is defined , all images of a set. <br/> | Gives back the metadata record of all images in the repository or, if set parameter is defined, all images of a set. <br/> | ||
'''Parameter:''' metadataPrefix, set <br/> | '''Parameter:''' metadataPrefix, set <br/> | ||
'''Example:''' http://dev-faces.mpdl.mpg.de/fledgeddata/oai/?verb=ListRecords&metadataPrefix=imeji <br/> | '''Example:''' http://dev-faces.mpdl.mpg.de/fledgeddata/oai/?verb=ListRecords&metadataPrefix=imeji <br/> | ||
Revision as of 10:22, 8 May 2012
This page describes the interfaces for the imeji application. For data dissemination imeji exploits the Fledged Data Service of the eSciDoc SOA infrastructure.
- The properties file of the Fledged Data Service can be found in the presentation module under: fledgeddata_presentation/src/main/resources/fds.properties
- The properties file of the OAI interface can be found under: \jboss\server\default\conf\oai.properties
These need to be adjusted.
RDF Export[edit]
RDF export interface for the imeji application.
Parameter: format, type, q, n
- format: rdf, sitemap
- type: Type of item (image, collection, album, mdprofile)
- q: The query
- n: The offset
OAI Interface[edit]
imeji allows the fetching of metadata from its repository by supporting the Open Archives Initiatives Protocol for Metadata Harvesting (OAI-PMH).
The mapping of the native imeji rdf to oai_dc can be found here
Verb: Identify[edit]
Gives back information on the imeji Repository.
Parameter: None
Example: http://dev-faces.mpdl.mpg.de/fledgeddata/oai/?verb=Identify
Not supported: None
Verb: ListMetadataFormats[edit]
Gives back all metadata formats which are supported by the repository. All listed formats can be used as a parameter for a GetRecord request (currently collections and albums can only be fetched in native imeji format).
Parameter: None
Example: http://dev-faces.mpdl.mpg.de/fledgeddata/oai/?verb=ListMetadataFormats
Not supported: identifier
Verb: ListSets[edit]
Gives back a list of sets which are provided by the repository. imeji provides by default, all collections and albums as sets.
Parameter: None
Example: http://dev-faces.mpdl.mpg.de/fledgeddata/oai/?verb=ListSets
Not supported: resumptionToken
Verb: GetRecord[edit]
Gives back a specific record, specified in the identifier parameter. A record can be everything with a url in imeji, currently: images, collections and albums.
Parameter: identifier, metadataPrefix
Example: http://dev-faces.mpdl.mpg.de/fledgeddata/oai/?verb=GetRecord&identifier=http://imeji.mpdl.mpg.de/image/14&metadataPrefix=imeji
Not supported: Handling of deleted records
Verb: ListIdentifiers[edit]
Gives back the oai header for all images in the repository or, if set parameter is defined, all images of a set.
Parameter: metadataPrefix, set
Example: http://dev-faces.mpdl.mpg.de/fledgeddata/oai/?verb=ListIdentifiers&metadataPrefix=imeji&set=http://imeji.mpdl.mpg.de/collection/134
Not supported: from, until, resumptionToken
Verb: ListRecords[edit]
Gives back the metadata record of all images in the repository or, if set parameter is defined, all images of a set.
Parameter: metadataPrefix, set
Example: http://dev-faces.mpdl.mpg.de/fledgeddata/oai/?verb=ListRecords&metadataPrefix=imeji
Not supported: from, until, resumptionToken
http://upload.wikimedia.org/wikipedia/commons/a/a2/Farm-Fresh_sitemap.png Sitemap[edit]
The sitemap functionality of the Fledged Data Service exploits the oai interface and creates a sitemap out of all items it retrieves with a ListIdentifiers call.
Therefore only image URLs will be listed in the sitemap.xml. The interval of the sitemap creation can be configured in the fds properties file.
Example: http://dev-faces.mpdl.mpg.de/fledgeddata/sitemap.xml