Syncml HTTP Binding 1 of 19 Pages Version 1.0 2000-12-07
Total Page:16
File Type:pdf, Size:1020Kb
SyncML HTTP Binding 1 of 19 Pages http://www.syncml.org/docs/syncml_http_v10_20001207.pdf Version 1.0 2000-12-07 SyncML HTTP Binding, version 1.0 Abstract THIS SPECIFICATION IS A SYNCML DRAFT DOCUMENT AND MAY BE UPDATED, REPLACED OR OBSOLETED BY ANOTHER DOCUMENT AT ANY TIME. IT IS INAPPROPRIATE TO USE THIS SPECIFICATION FOR PRODUCT IMPLEMENTATION UNTIL PUBLISHED OR TO REFERENCE THE MATERIAL OR TO CITE IT OTHER THAN AS "WORK IN PROGRESS". This document describes how to use the SyncML over HTTP. The document uses the primitives and methods defined in the HTTP specification V1.1 as defined in [1]. The document assumes a scenario consisting of a data synchronization client (e.g., a mobile phone) and a data synchronization server where the master for the data resides. Within wide area networks, the data synchronization server could be a remote web server. Copyright © Ericsson, IBM, Lotus, Matsushita Communications Industrial Co., LTD, Motorola, Nokia, Palm, Inc., Psion, Starfish Software (2000) All Rights Reserved. SyncML HTTP Binding 2 of 19 Pages http://www.syncml.org/docs/syncml_http_v10_20001207.pdf Version 1.0 2000-12-07 SyncML Initiative The following companies are Sponsors of the SyncML initiative: Ericsson IBM Lotus Matsushita Communications Industrial Co. Motorola Nokia Palm, Inc. Psion Starfish Software Revision History Revision Date Comments V0.9 2000-05-31 Version 0.9. V1.0 2000-08-29 Reformatted for v1.0 Alpha release. No technical changes. Alpha V1.0 Beta 2000-11-10 Revised headers for v1.0 Beta release. No technical changes. V1.0 2000-12-07 The candidate version for the final release. Copyright © Ericsson, IBM, Lotus, Matsushita Communication Industrial Co., LTD, Motorola, Nokia, Palm, Inc., Psion, Starfish Software (2000) All Rights Reserved. SyncML HTTP Binding 3 of 19 Pages http://www.syncml.org/docs/syncml_http_v10_20001207.pdf Version 1.0 2000-12-07 Copyright Notice Copyright (c) Ericsson, IBM, Lotus, Matsushita Communication Industrial Co., LTD, Motorola, Nokia, Palm, Inc., Psion, Starfish Software (2000). All Rights Reserved. Implementation of all or part of any Specification may require licenses under third party intellectual property rights, including without limitation, patent rights (such a third party may or may not be a Supporter). The Sponsors of the Specification are not responsible and shall not be held responsible in any manner for identifying or failing to identify any or all such third party intellectual property rights. THIS DOCUMENT AND THE INFORMATION CONTAINED HEREIN ARE PROVIDED ON AN "AS IS" BASIS WITHOUT WARRANTY OF ANY KIND AND ERICSSON, IBM, LOTUS, MATSUSHITA COMMUNICATION INDUSTRIAL CO. LTD, MOTOROLA, NOKIA, PALM INC., PSION, STARFISH SOFTWARE AND ALL OTHER SYNCML SPONSORS DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ERICSSON, IBM, LOTUS, MATSUSHITA COMMUNICATION INDUSTRIAL CO., LTD, MOTOROLA, NOKIA, PALM INC., PSION, STARFISH SOFTWARE OR ANY OTHER SYNCML SPONSOR BE LIABLE TO ANY PARTY FOR ANY LOSS OF PROFITS, LOSS OF BUSINESS, LOSS OF USE OF DATA, INTERRUPTION OF BUSINESS, OR FOR DIRECT, INDIRECT, SPECIAL OR EXEMPLARY, INCIDENTAL, PUNITIVE OR CONSEQUENTIAL DAMAGES OF ANY KIND IN CONNECTION WITH THIS DOCUMENT OR THE INFORMATION CONTAINED HEREIN, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE. The above notice and this paragraph must be included on all copies of this document that are made. Copyright © Ericsson, IBM, Lotus, Matsushita Communication Industrial Co., LTD, Motorola, Nokia, Palm, Inc., Psion, Starfish Software (2000) All Rights Reserved. SyncML HTTP Binding 4 of 19 Pages http://www.syncml.org/docs/syncml_http_v10_20001207.pdf Version 1.0 2000-12-07 Table of Contents 1 Introduction..................................................................................................5 2 Formatting Conventions .............................................................................5 3 Terminology.................................................................................................5 4 HTTP Introduction .......................................................................................8 5 SyncML Binding to HTTP............................................................................8 5.1 TCP Transport Service ....................................................................8 5.1.1 Connection .........................................................................8 5.1.2 Connection Options............................................................8 5.1.3 Disconnection.....................................................................9 5.1.4 Abort...................................................................................9 5.1.5 Timeouts.............................................................................9 5.2 Exchanging SyncML Messages.......................................................9 5.2.1 Single Message Per Package...........................................10 5.2.2 Multiple Messages Per Package ......................................10 5.3 Transport Commands....................................................................11 5.3.1 Methods............................................................................11 5.3.2 General Headers ..............................................................11 5.3.3 Request Headers..............................................................12 5.3.4 Response Headers...........................................................14 5.4 Security..........................................................................................16 6 Examples....................................................................................................16 7 References .................................................................................................19 Copyright © Ericsson, IBM, Lotus, Matsushita Communication Industrial Co., LTD, Motorola, Nokia, Palm, Inc., Psion, Starfish Software (2000) All Rights Reserved. SyncML HTTP Binding 5 of 19 Pages http://www.syncml.org/docs/syncml_http_v10_20001207.pdf Version 1.0 2000-12-07 1 Introduction This document defines the binding requirements for communicating SyncML over the Hypertext Transfer Protocol (HTTP) as defined by [1]. HTTP is an application-level protocol for distributing information between two Internet based applications. HTTP can be an ideal protocol for building wide area, distributed systems, such as the collaborative framework of the World-Wide Web (Web) environment. HTTP is expected to be the primary wireline protocol used by SyncML clients and servers to communicate with each other. In addition, as wireless networks increase in bandwidth (e.g., deployment of GPRS networks) and are adapted to support the IP protocol, HTTP will become the preferred application protocol for connecting wireless SyncML clients and servers. The HTTP protocol defines a request/response form of communication between two network computers supporting HTTP applications. Normally, the originator of the request is called the HTTP client. And normally, the recipient of the request is called the HTTP server. There are emerging Internet standards for notification or "push" technologies that will allow HTTP servers to also originate HTTP requests. However, this technology is not currently included in this version of the specification. HTTP is an ideal protocol for connecting a SyncML client to a SyncML server; and vice a versa. SyncML is intended to be registered as a MIME media type. This makes it adapted for transfer over HTTP. HTTP is widely supported across the Internet. There are numerous examples of common implementations of both client and server HTTP applications. HTTP servers can be adapted to support new HTTP-based application in a straightforward manner. SyncML messages can be transferred across the Internet and pass through "firewalls", at the perimeter of individual intranets with relative ease. 2 Formatting Conventions The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY" and "OPTIONAL" in this document are to be interoperated as described in [3]. Any reference to components of the Device Information DTD or XML [5] snipets are specified in this type face. 3 Terminology See [6] and [7] for definitions of SyncML terms used within this specification. The following terms are copied from [1]. Cache A program's local store of response messages and the subsystem that controls its message storage, retrieval, and deletion. A cache stores cacheable responses in order to reduce the response time and network bandwidth consumption on future, equivalent requests. Any client or server may include a cache, though a cache cannot be used by a server that is acting as a tunnel. Copyright © Ericsson, IBM, Lotus, Matsushita Communication Industrial Co., LTD, Motorola, Nokia, Palm, Inc., Psion, Starfish Software (2000) All Rights Reserved. SyncML HTTP Binding 6 of 19 Pages http://www.syncml.org/docs/syncml_http_v10_20001207.pdf Version 1.0 2000-12-07 Cacheable A response is cacheable if a cache is allowed to store a copy of the response message for use in answering subsequent requests. The rules for determining the cacheability of HTTP responses are defined in section 13 of [1]. Even if a resource is cacheable, there may be additional constraints on whether a cache can use the