Difference between revisions of "ESciDoc Services DataAcquisitionHandler"
Jump to navigation
Jump to search
Kleinfercher (talk | contribs) |
Kleinfercher (talk | contribs) m (→Supported Systems: typo) |
||
(32 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
{{ESciDoc Services}} | {{ESciDoc Services}} | ||
==ID (Label)== | ==ID (Label)== | ||
DAAS | |||
== Complete Name == | == Complete Name == | ||
Line 11: | Line 11: | ||
== Description == | == Description == | ||
Acquisition Service for data from internal and external sources with an unAPI interface. | Acquisition Service for data from internal and external sources with an unAPI interface. | ||
== Operations Overview== | == Operations Overview== | ||
Line 28: | Line 25: | ||
|doFetch||implemented||sourceName: String<br/>identifier: String||byte[]||Scope:'''Public''' <br/>This operation fetches data from the specified source.<br/>The format of the requested data will be the default format defined in sources.xml | |doFetch||implemented||sourceName: String<br/>identifier: String||byte[]||Scope:'''Public''' <br/>This operation fetches data from the specified source.<br/>The format of the requested data will be the default format defined in sources.xml | ||
|- | |- | ||
|doFetch||implemented||sourceName: String<br/>identifier: String<br/>Format: String||byte[]||Scope:'''Public''' <br/>This operation fetches data from the specified source and returns it in the requested format. <br/>This format can either be the format the external source provides, <br/>or a format we can transform from a format the external source provides | |doFetch||implemented||sourceName: String<br/>identifier: String<br/>Format: String||byte[]||Scope:'''Public''' <br/>This operation fetches data from the specified source and returns it in the requested format. <br/>This format can either be the format the external source provides, <br/>or a format we can transform from a format the external source provides. The format properties are default | ||
|- | |- | ||
|doFetch||implemented||sourceName: String<br/>identifier: String<br/>Formats: String[]||byte[]||Scope:'''Public''' <br/>This operation fetches data from the specified source and returns it in the requested format.<br/> The fetched data will return in zip format,<br/> currently only file fetching is possible for multiple formats | |doFetch||implemented||sourceName: String<br/>identifier: String<br/>trgFormatName: String <br/>trgFormatType: String <br/>trgFormatEncoding: String ||byte[]||Scope:'''Public''' <br/>This operation fetches data from the specified source and returns it in the requested format. <br/>This format can either be the format the external source provides, <br/>or a format we can transform from a format the external source provides. The format properties are default | ||
|- | |||
|doFetch||implemented||sourceName: String<br/>identifier: String<br/>Formats: Format[]||byte[]||Scope:'''Public''' <br/>This operation fetches data from the specified source and returns it in the requested format.<br/> The fetched data will return in zip format,<br/> currently only file fetching is possible for multiple formats | |||
|- | |||
|doFetch||implemented||sourceName: String<br/>identifier: String<br/>Formats: String[]||byte[]||Scope:'''Public''' <br/>This operation fetches data from the specified source and returns it in the requested format.<br/> The fetched data will return in zip format,<br/> currently only file fetching is possible for multiple formats. The format properties are default | |||
|} | |} | ||
== Supported Systems == | == Supported Systems == | ||
* | * '''Implemented''': | ||
* [[PubMan_Func_Spec_Submission/arXiv_mapping | | ** [http://www.escidoc.org/ eSciDoc] [no mapping required] | ||
* [[PubMan_Func_Spec_Submission/PubMed_Central_Mapping | | ** [http://arxiv.org Arxiv] [find mapping [[PubMan_Func_Spec_Submission/arXiv_mapping | here]]] '''Important Note:''' Fetch from arxiv will only be successful if the PubMan server is registered at arxiv.org, otherwise your fetching attempts will be blocked | ||
* [[PubMan_Func_Spec_Submission/Spires_Mapping | | ** [http://www.ncbi.nlm.nih.gov/pubmed PubMed Central] [find mapping [[PubMan_Func_Spec_Submission/PubMed_Central_Mapping | here]]] | ||
* BioMed Central ( | ** [http://www-spires.fnal.gov/spires/ Spires] [find mapping [[PubMan_Func_Spec_Submission/Spires_Mapping | here]]] | ||
** [http://www.biomedcentral.com/ BioMed Central] [find mapping [[PubMan_Func_Spec_Submission/BioMed_Central_Mapping | here]]] | |||
* '''In Design''': | |||
* '''Considered''': | |||
** [http://www.crossref.org/ CrossRef], [[CrossRef | CoLab Page for CrossRef]] | |||
** [http://www.ams.org/mathscinet/ MathNetScience] | |||
** [http://www.adsabs.harvard.edu/ Astrophysics Data System (ADS)] | |||
== Service interfaces == | == Service interfaces == | ||
'''The four steps to fetch data:''' | '''The four steps to fetch data:''' | ||
1. Choose the presentation of the data | 1. Choose the presentation of the data <br/> | ||
dataacquisition/view: Views the fetched data in the browser | :dataacquisition/'''view''': Views the fetched data in the browser<br/> | ||
dataacquisition/download: The fetched data will be provided as a download | :dataacquisition/'''download''': The fetched data will be provided as a download<br/> | ||
2. | 2. Specify the interface you want to use (currently only unAPI)<br/> | ||
dataacquisition/view/unapi | :dataacquisition/view/'''unapi'''<br/> | ||
dataacquisition/download/unapi | :dataacquisition/download/'''unapi''' | ||
3. Provide the identifier of the item you want to fetch | 3. Provide the identifier of the item you want to fetch<br/> | ||
dataacquisition/view/unapi?id=escidoc:1234 | :dataacquisition/view/unapi?'''id'''=escidoc:1234<br/> | ||
dataacquisition/download/unapi?id=escidoc:1234 | :dataacquisition/download/unapi?'''id'''=escidoc:1234 | ||
4. Provide the format you want the fetched item in | 4. Provide the format you want the fetched item in<br/> | ||
dataacquisition/view/unapi?id=escidoc:1234&format=bibtex | :dataacquisition/view/unapi?id=escidoc:1234&'''format'''=bibtex<br/> | ||
dataacquisition/download/unapi?id=escidoc:1234&format=bibtex | :dataacquisition/download/unapi?id=escidoc:1234&'''format'''=bibtex | ||
'''Supported Identifiers:''' | '''Supported Identifiers:''' | ||
Line 66: | Line 77: | ||
:The format has to be set to "url". The response will be a zip file of the fetched content. The view option for url identifiers is disabled | :The format has to be set to "url". The response will be a zip file of the fetched content. The view option for url identifiers is disabled | ||
== Future Development == | |||
* Prioritize fetching formats for import (client or serverside?). E.g. fetch pdf if not possible fetch doc. | |||
* Prevent DAAS to be a security leak for the sources he fetches from. | |||
[[Category:ESciDoc| | [[Category:ESciDoc Services|Import Manager]] | ||
[[Category:ServiceOrientedArchitecture]] | [[Category:ServiceOrientedArchitecture|DataAcquisition Service]] |
Latest revision as of 08:30, 27 February 2012
ID (Label)[edit]
DAAS
Complete Name[edit]
Data Acquisition Service
Status[edit]
Implemented
Description[edit]
Acquisition Service for data from internal and external sources with an unAPI interface.
Operations Overview[edit]
Operation | Status | Input | Output | Description |
---|---|---|---|---|
explainSources | implemented | none | String | Scope:Public Gives back a list of all available sources for acquisition and which formats can be fetched from these sources |
doFetch | implemented | sourceName: String identifier: String |
byte[] | Scope:Public This operation fetches data from the specified source. The format of the requested data will be the default format defined in sources.xml |
doFetch | implemented | sourceName: String identifier: String Format: String |
byte[] | Scope:Public This operation fetches data from the specified source and returns it in the requested format. This format can either be the format the external source provides, or a format we can transform from a format the external source provides. The format properties are default |
doFetch | implemented | sourceName: String identifier: String trgFormatName: String trgFormatType: String trgFormatEncoding: String |
byte[] | Scope:Public This operation fetches data from the specified source and returns it in the requested format. This format can either be the format the external source provides, or a format we can transform from a format the external source provides. The format properties are default |
doFetch | implemented | sourceName: String identifier: String Formats: Format[] |
byte[] | Scope:Public This operation fetches data from the specified source and returns it in the requested format. The fetched data will return in zip format, currently only file fetching is possible for multiple formats |
doFetch | implemented | sourceName: String identifier: String Formats: String[] |
byte[] | Scope:Public This operation fetches data from the specified source and returns it in the requested format. The fetched data will return in zip format, currently only file fetching is possible for multiple formats. The format properties are default |
Supported Systems[edit]
- Implemented:
- eSciDoc [no mapping required]
- Arxiv [find mapping here] Important Note: Fetch from arxiv will only be successful if the PubMan server is registered at arxiv.org, otherwise your fetching attempts will be blocked
- PubMed Central [find mapping here]
- Spires [find mapping here]
- BioMed Central [find mapping here]
- In Design:
Service interfaces[edit]
The four steps to fetch data:
1. Choose the presentation of the data
- dataacquisition/view: Views the fetched data in the browser
- dataacquisition/download: The fetched data will be provided as a download
2. Specify the interface you want to use (currently only unAPI)
- dataacquisition/view/unapi
- dataacquisition/download/unapi
3. Provide the identifier of the item you want to fetch
- dataacquisition/view/unapi?id=escidoc:1234
- dataacquisition/download/unapi?id=escidoc:1234
4. Provide the format you want the fetched item in
- dataacquisition/view/unapi?id=escidoc:1234&format=bibtex
- dataacquisition/download/unapi?id=escidoc:1234&format=bibtex
Supported Identifiers:
1. A identifier from a supported source (explained in /dataacquisition).
2. A identifier = any URL (the eSciDoc DataAcquisition Service has no information about this source and can only try to call the given URL for the fetching request).
- The format has to be set to "url". The response will be a zip file of the fetched content. The view option for url identifiers is disabled
Future Development[edit]
- Prioritize fetching formats for import (client or serverside?). E.g. fetch pdf if not possible fetch doc.
- Prevent DAAS to be a security leak for the sources he fetches from.