Update Notification Protocol

From Apache OpenOffice Wiki
Revision as of 09:52, 7 November 2006 by Obr (Talk | contribs)

Jump to: navigation, search

Status: Draft


Since version 2.0.3 OpenOffice.org users of builds providing an UpdateURL can manually check for available updates by invoking "Help -> Check for Updates .." . Starting with version 2.0.4 OpenOffice.org can perform this check automatically in a user configurable interval.

This is an attempt to define a second version of the update notification protocol, which is better extendable, can also be used for extensions and no longer uses http post requests.


The update notification request is a http get request to an URL, which may contain the operating system and processor type the OpenOffice.org instance is compiled for either as part of the URL or as URL parameter.



User Agent field

To reduce the amount of transfered data when asking for OpenOffice.org updates, the user agent field contains all information required to identify a specific build plus the UI language currently in use:

OpenOffice.org/2.2 (680m212 (Build:9263); Solaris; SPARC; BundledLanguages=en-US_fr) (lang=de)

Update documents and feeds

The simplest possible reply is of the following form:

<?xml version="1.0" encoding="utf-8"?>
<update xmlns="http://installation.openoffice.org/update">

ToDo: add extension sample

The other supported reply format, which also allows to include several components or several versions of a single component, is to embed the update document in an atom feed.

<?xml version="1.0" encoding="utf-8"?>
<feed xmlns="http://www.w3.org/2005/Atom" xml:lang”en-US”>

  <title>OpenOffice.org Update Feed</title>
  <link rel="alternate" type="text/html" href="http://update.services.openoffice.org/ooo/snapshot.html"/>
    <name>The OpenOffice.org Project</name>
    <title>OpenOffice.org 2.2 available</title>
    <link rel="alternate" type="text/html"
    <summary>Click here to go to the download page.</summary>
    <content type=”text/xml”>
      <update xmlns="http://installation.openoffice.org/update">

Note: to allow proper filtering, the <id> tag of the <atom:entry> element must contain the <id> string of the component to be updated.

Personal tools