《searchRetrieve Part . searchRetrieve Operation APD Binding.doc》由会员分享，可在线阅读，更多相关《searchRetrieve Part . searchRetrieve Operation APD Binding.doc（34页珍藏版）》请在三一文库上搜索。
1、searchRetrieve: Part 2. searchRetrieve Operation: APD Binding for SRU 1.2 Version 1.0OASIS Standard30 January 2013Specification URIsThis version:http:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/os/part2-sru1.2/searchRetrieve-v1.0-os-part2-sru1.2.doc (Authoritative)http:/docs.oasis-open.org/se
2、arch-ws/searchRetrieve/v1.0/os/part2-sru1.2/searchRetrieve-v1.0-os-part2-sru1.2.html http:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/os/part2-sru1.2/searchRetrieve-v1.0-os-part2-sru1.2.pdf Previous version:N/ALatest version:http:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/searchRetrie
3、ve-v1.0-part2-sru1.2.doc (Authoritative)http:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/searchRetrieve-v1.0-part2-sru1.2.htmlhttp:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/searchRetrieve-v1.0-part2-sru1.2.pdfTechnical Committee:OASIS Search Web Services TCChairs:Ray Denenberg (rdenl
4、oc.gov), Library of CongressMatthew Dovey (m.doveyjisc.ac.uk), JISC Executive, University of BristolEditors:Ray Denenberg (rdenloc.gov), Library of CongressLarry Dixson (ldixloc.gov), Library of CongressRalph Levan (levanoclc.org), OCLCJanifer Gatenby (Janifer.Gatenbyoclc.org), OCLCTony Hammond (),
5、Nature Publishing GroupMatthew Dovey (m.doveyjisc.ac.uk), JISC Executive, University of BristolAdditional artifacts:This prose specification is one component of a Work Product which also includes: XML schemas: http:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/os/schemas/ searchRetrieve: Part 0
6、. Overview Version 1.0.http:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/os/part0-overview/searchRetrieve-v1.0-os-part0-overview.html searchRetrieve: Part 1. Abstract Protocol Definition Version 1.0.http:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/os/part1-apd/searchRetrieve-v1.0-os-par
7、t1-apd.html searchRetrieve: Part 2. searchRetrieve Operation: APD Binding for SRU 1.2 Version 1.0. (this document)http:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/os/part2-sru1.2/searchRetrieve-v1.0-os-part2-sru1.2.html searchRetrieve: Part 3. searchRetrieve Operation: APD Binding for SRU 2.0
8、 Version 1.0.http:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/os/part3-sru2.0/searchRetrieve-v1.0-os-part3-sru2.0.html searchRetrieve: Part 4. APD Binding for OpenSearch Version 1.0.http:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/os/part4-opensearch/searchRetrieve-v1.0-os-part4-opense
9、arch.html searchRetrieve: Part 5. CQL: The Contextual Query Language Version 1.0.http:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/os/part5-cql/searchRetrieve-v1.0-os-part5-cql.html searchRetrieve: Part 6. SRU Scan Operation Version 1.0.http:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/o
10、s/part6-scan/searchRetrieve-v1.0-os-part6-scan.html searchRetrieve: Part 7. SRU Explain Operation Version 1.0.http:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/os/part7-explain/searchRetrieve-v1.0-os-part7-explain.html Related work:This specification is related to: Search/Retrieval via URL. Th
11、e Library of Congress. http:/www.loc.gov/standards/sru/Abstract:This document specifies a binding of the OASIS SWS Abstract Protocol Definition to the specification of version 1.2 of the protocol SRU: Search/Retrieve via URL. This is one of a set of documents for the OASIS Search Web Services (SWS)
12、initiative.Status:This document was last revised or approved by the membership of OASIS on the above date. The level of approval is also listed above. Check the “Latest version” location noted above for possible later revisions of this document.Technical Committee members should send comments on thi
13、s specification to the Technical Committees email list. Others should send comments to the Technical Committee by using the “Send A Comment” button on the Technical Committees web page at http:/www.oasis-open.org/committees/search-ws/.For information on whether any patents have been disclosed that m
14、ay be essential to implementing this specification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of the Technical Committee web page (http:/www.oasis-open.org/committees/search-ws/ipr.php).Citation format:When referencing this specification the f
15、ollowing citation format should be used:SearchRetrievePt2searchRetrieve: Part 2. searchRetrieve Operation: APD Binding for SRU 1.2 Version 1.0. 30 January 2013. OASIS Standard. http:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/os/part2-sru1.2/searchRetrieve-v1.0-os-part2-sru1.2.html. NoticesCo
16、pyright OASIS Open 2013. All Rights Reserved.All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual Property Rights Policy (the OASIS IPR Policy). The full Policy may be found at the OASIS website.This document and translations of it may be copied an
17、d furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this section are included on all
18、 such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to OASIS, except as needed for the purpose of developing any document or deliverable produced by an OASIS Technical Committee (in which case the r
19、ules applicable to copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required to translate it into languages other than English.The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns.This document and the information
20、contained herein is provided on an AS IS basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURP
21、OSE.OASIS requests that any OASIS Party or any other party that believes it has patent claims that would necessarily be infringed by implementations of this OASIS Committee Specification or OASIS Standard, to notify OASIS TC Administrator and provide an indication of its willingness to grant patent
22、licenses to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification.OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of any patent claims that would necessarily be infringed by i
23、mplementations of this specification by a patent holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification. OASIS may include such claims on its website, but disclaims any obligatio
24、n to do so.OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be availa
25、ble; neither does it represent that it has made any effort to identify any such rights. Information on OASIS procedures with respect to rights in any document or deliverable produced by an OASIS Technical Committee can be found on the OASIS website. Copies of claims of rights made available for publ
26、ication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this OASIS Committee Specification or OASIS Standard, can be obtained from the OASIS TC Administr
27、ator. OASIS makes no representation that any information or list of intellectual property rights will at any time be complete, or that any claims in such list are, in fact, Essential Claims.The name OASIS is a trademark of OASIS, the owner and developer of this specification, and should be used only
28、 to refer to the organization and its official outputs. OASIS welcomes reference to, and implementation and use of, specifications, while reserving the right to enforce its marks against misleading uses. Please see http:/www.oasis-open.org/policies-guidelines/trademark for above guidance.Table of Co
29、ntents1Introduction61.1Terminology61.2References61.3Namespace62Overview and Model72.1Relationship to Abstract Protocol Definition72.2Operation Model72.3Data model72.4Protocol Model82.5Query model92.6Result Set Model92.7Diagnostic Model102.8Explain Model103Request Parameters (Summary)113.1Actual Requ
30、est Parameters for this Binding113.2Relationship of Actual Parameters to Abstract Parameters114Response Elements (Summary)134.1Actual Response Elements for this Binding134.2Relationship of Actual Elements to Abstract Elements135Parameter and Element Descriptions155.1startRecord and maximumRecords155
31、.2resultSetTTL, and resultSetIdleTime155.3numberofRecords155.4nextRecordPosition155.5resultSetId165.6Echoed Request166Record Serialization and formatting Parameters176.1recordPacking176.2recordSchema176.3Stylesheet177Response Records18Example188Diagnostics208.1Diagnostic List208.2Diagnostic Data Ele
32、ments208.3Diagnostic Examples208.3.1Non-Surrogate Example208.3.2Surrogate Example219Extensions229.1Extension Request Parameter229.2Extension Response Element: extraResponseData229.3Behavior229.4Echoing the Extension Request2310Conformance2410.1Client Conformance2410.1.1Protocol2410.1.2Query2410.1.3R
33、esponse Format2410.1.4Diagnostics2410.1.5Explain2410.2Server Conformance2410.2.1Protocol2410.2.2Query2410.2.3Response Format2510.2.4Diagnostics2510.2.5Explain25Appendix A.Acknowledgements26Appendix B.SRU 1.2 Bindings to Lower Level Protocol27B.1 Binding to HTTP GET27B.1.1 Syntax27B.1.2 Encoding (Cli
34、ent Procedure)27B.1.3 Decoding (Server Procedure)27B.1.4 Example28B.2 Binding to HTTP POST28B.3 Binding to HTTP SOAP28B.3.1 SOAP Requirements28B.3.2 Parameter Differences29B.3.3 Example SOAP Request29B.3.4 WSDL29Appendix C.Diagnostics for use with SRU 1.230C.1 Notes32searchRetrieve-v1.0-os-part2-sru
35、1.230 January 2013Standards Track Work ProductCopyright OASIS Open 2013. All Rights Reserved.Page 34 of 341 IntroductionThis is one of a set of documents for the OASIS Search Web Services (SWS) initiative. This document, “searchRetrieve: Part 1.SearchRetrieve Operation: Binding for SRU 1.2” is the s
36、pecification of version 1.2 of the protocol SRU: Search/Retrieve via URL. This specification is intended to be compatible with the specification at http:/www.loc.gov/standards/sru/specs/The set of documents includes the Abstract Protocol Definition (APD) for searchRetrieve operation, which presents
37、the model for the SearchRetrieve operation and serves as a guideline for the development of application protocol bindings describing the capabilities and general characteristic of a server or search engine, and how it is to be accessed. The collection of documents also includes three bindings. This
38、document is one of the three. Scan, a companion protocol to SRU, supports index browsing, to help a user formulate a query. The Scan specification is also one of the documents in this collection. Finally, the Explain specification, also in this collection, describes a servers Explain file, which pro
39、vides information for a client to access, query and process results from that server. The set of documents in this collection of specifications are:1. Overview2. APD 3. SRU1.2 (this document)4. SRU2.0 5. OpenSearch6. CQL 7. Scan 8. Explain1.1 TerminologyThe key words “MUST”, “MUST NOT”, “REQUIRED”,
40、“SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC2119.1.2 ReferencesAll references for the set of documents in this collection are supplied in the Overview document:searchRetrieve: Part 0. Overview Version 1.
41、0http:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/csd01/part0-overview/searchRetrieve-v1.0-csd01-part0-overview.doc 1.3 NamespaceAll XML namespaces for the set of documents in this collection are supplied in the Overview document: searchRetrieve: Part 0. Overview Version 1.0http:/docs.oasis-o
42、pen.org/search-ws/searchRetrieve/v1.0/csd01/part0-overview/searchRetrieve-v1.0-csd01-part0-overview.doc.2 Overview and Model2.1 Relationship to Abstract Protocol DefinitionThe APD defines abstract request parameters and abstract response elements. A binding lists those abstract parameters and elemen
43、ts applicable to that binding and indicates the corresponding actual name of the parameter or element to be transmitted in a request or response.Example.The APD defines the abstract parameter: startPosition as “The position within the result set of the first item to be returned. “And this specificat
44、ion refers to that abstract parameter and notes that its name, as used in this specification is startRecord. Thus the request parameter startRecord in this specification represents the abstract parameter startPosition in the APD. Different bindings may use different names to represent this same abst
45、ract parameter, and its semantics may differ across those bindings as the binding models differ. It is the responsibility of the binding to explain these differences in terms of their respective models.2.2 Operation ModelThis specification defines the protocol SRU: Search/Retrieve via URL. Different
46、 bindings may define different protocols for search/retrieve. The SRU protocol defines a request message (sent from an SRU client to an SRU server) and a response message (sent from the server to the client). This transmission of an SRU request followed by an SRU response is called a SearchResponse
47、operation. For the SRU protocol, three operations are defined:1. SearchResponse Operation. The SearchResponse operation is defined by the SRU protocol, which is this specification.2. Scan Operation. 3. Explain Operation. See Explain Model below.2.3 Data modelA server exposes a database for access by a remote client for purposes of search and retrieval. The database is a collection of units of data, each referred to as an abstract record. In this model there is a single database at any given server. Associated with a database are one or more formats that the server may apply to