A SIP Event Package for Subscribing to Changes to an HTTP Resource

The Session Initiation Protocol (SIP) is increasingly being used in systems that are tightly coupled with Hypertext Transport Protocol (HTTP) servers for a variety of reasons. In many of these cases, applications can benefit from learning of changes to specified HTTP resources in near-real-time. For example, user agent terminals may elect to store service-related data in an HTTP tree, such as is described in and . When such configuration information is stored and retrieved using HTTP, clients may need to be informed when information changes, so as to make appropriate changes to their local behavior and user interface. This document defines a mechanism, based on the SIP Event Framework , for subscribing to changes in the resource referenced by an HTTP server. It further defines a mechanism by which the proper SIP and/or SIPS URI to be used for such subscriptions can be determined from the HTTP server.

One of the key challenges in subscribing to the changes of a resource indicated by an HTTP URL is determining which SIP URI corresponds to a specific HTTP URL. This specification takes the approach of having the HTTP server responsible for the URL in question select an appropriate SIP URI for the corresponding resource, and to return that URI within an HTTP transaction. In particular, HTTP servers use the HTTP Link: header with a relation type of "monitor" to convey the URI that can be used to discover changes to the resource. This document defines behavior for SIP and SIPS URIs in this header. Handling for other URI schemes is out of scope for the current document, although we expect future specifications to define procedures for monitoring via other protocols. Because a single resource may have the ability to be monitored via multiple protocols, it is perfectly legal for an HTTP response to contain multiple "Link:" headers with a relation type of "monitor". Implementors are cautioned to search the entire HTTP response header block to locate a "Link:" header that corresponds with their preferred change monitoring protocol. If an HTTP server provides the ability to subscribe to a changes in a resource's value using this event package, it MUST return a Link: header containing a SIP or SIPS URI with a relation type of "monitor" in any successful response to a GET or HEAD request on that resource. It MAY return both. A client wishing to subscribe to the change state of an HTTP resource obtains a SIP or SIPS URI by sending a GET or HEAD request to the HTTP URL it wishes to monitor. This SIP or SIPS URI is then used in a SUBSCRIBE request, according to the event package defined in section . [This indented text to be removed before publication as an RFC] Several potential mechanisms for retrieving the SIP URI from the HTTP server were evaluated. Of them, the HTTP Link: header was determined to have the most favorable set of properties. Two key candidates that were considered but rejected in favor of Link: are discussed below. The HTTP PROPFIND method (, section 9.1) can be used to retrieve the value of a specific property associated with an HTTP URL. However, this cannot be done in conjunction with retrieval of the document itself, which is usually desirable. If a PROPFIND approach is employed, clients will typically perform both a GET and a PROPFIND on resources of interest. Additionally, the use of PROPFIND requires support of the PROPFIND method in HTTP User Agents -- which, although fairly well implemented, still lacks the penetration of GET implementations. Similar to PROPFIND, XRDS can be used to retrieve properties associated with an HTTP URL. It has the advantage of using GET instead of PROPFIND; however, it suffers from both the two-round-trip issue discussed above, as well as an unfortunately large number of options in specifying how to retrieve the properties.

The name of this event package is "http-monitor".

This event package defines no parameters. [TODO: should we define a simple filter that allows subscribers to request the body be sent in notifications? Something like "body=true"?]

This event package defines no bodies to be used in the SUBSCRIBE message. Future extensions may define filter criteria to be sent in the SUBSCRIBE bodies.

Reasonable values for the duration of subscriptions to the http-monitor event package vary widely with the nature of the HTTP resource being monitored. Some HTTP resources change infrequently (if ever), while other can change comparatively rapidly. For rapidly changing documents, the ability to recover more rapidly from a subscription failure is relatively important, so implementations will be well served by selecting smaller durations for their subscriptions, on the order of 1800 to 3600 seconds (30 minutes to an hour). Subscriptions to slower-changing resources lack this property, and the need to periodically refresh subscriptions render short subscriptions wasteful. For these type of subscriptions, expirations as long as 604800 (one week) or even longer may well make sense. Given the broad range of reasonable expirations involved, selecting a single default expiration is somewhat tricky. However, in the absence of an expires value in a subscription, the notifier shall assume a default expiration value of 86400 (one day).

By default, the bodies of NOTIFY messages for the http-monitor event package will be of content-type "message/httpfrag". This content-type is defined below, as is its use in the http-monitor event package.

A valid message/httpfrag part is one that could be obtained by starting with some valid HTTP message and deleting any of the following: the entire start line one or more entire header fields the body The following Augmented Backus-Naur Form (ABNF) rule describes a message/httpfrag part using the HTTP grammar elements defined in . The expansion of any element is subject to the restrictions on valid HTTP message syntax defined in .

httpfrag = [ start-line ] *(message-header CRLF) [ CRLF [ message-body ] ] If the message/httpfrag part contains a body, it MUST also contain the appropriate header fields describing that body (such as Content-Length) and the blank line separating the headers from the body.

The message/httpfrag NOTIFY bodies used in the HTTP monitor event package represent a subset of the HTTP response that would be returned if the client used an HTTP GET to retrieve the HTTP resource. Except for the normative constraints described in the remainder of this section, the notifier MAY include any arbitrary subset of the HTTP response, including the entire set of headers. An example of a message/httpfrag body as used in this event package is shown below.

ETag: 38fe6-58b-1840e7d0 Last-Modified: Sat, 13 Nov 2010 23:29:00 GMT Content-MD5: 4e3b50421829c7c379a5c6154e560449 When used in the HTTP monitor event package defined in this document, the message/httpfrag MUST contain at least one of an ETag or Content-MD5 header, unless returning a null state as described in . It MAY contain both. Inclusion of a Last-Modified header is also RECOMMENDED. When used in the HTTP monitor event package, the message/httpfrag MUST NOT contain a message-body component, unless the corresponding subscription has explicitly indicated the desire to receive such bodies in the form of a filter. Filters for this event package are out of scope for this specification. If the change to the resource being communicated represents a modification of the resource's value, the message/httpfrag MAY contain a start line. If present, this start line will contain a the same 2xx-class HTTP response that would be returned if a user agent attempted to access the HTTP resource with a GET request (e.g., "200 OK"). If the change to the resource being communicated represents a renaming of the HTTP resource, the message/httpfrag MUST contain a start line; this start line will contain a the same 3xx-class HTTP response that would be returned if a user agent attempted to access the relocated HTTP resource with a GET request (e.g., "301 Moved Permanently"). The message/httpfrag also SHOULD contain a Location: header that communicates the new name of the resource. If the change to the resource being communicated represents a deletion of the HTTP resource, the message/httpfrag MUST contain a start line; this start line will contain a the same 4xx-class HTTP response that would be returned if a user agent attempted to access the missing HTTP resource with a GET request (e.g., "404 Not Found" or "410 Gone").

Upon receipt of a SUBSCRIBE request, the notifier applies authorization according to local policy. Typically, this policy will be aligned with the HTTP server authorization policies regarding access to the resource whose change state is being requested.

NOTIFY messages should be generated whenever the underlying resource indicated by the corresponding HTTP URL has been modified. In the case that the NOTIFIER has insufficient information to return any useful information about the underlying HTTP resource, it may return a message/httpfrag that is zero bytes long (which is a proper empty subset of the syntax described in section ).

Upon receipt of a NOTIFY message, subscriber should use any information in the message/httpfrag to update its view of the underlying HTTP resource. In most cases, this results in an invalidation of its view of the HTTP resource. It is up to the subscriber implementation to decide whether it is appropriate to fetch a new copy of the HTTP resource as a reaction to a NOTIFY message.

Multiple notifiers for a single HTTP resource is semantically nonsensical. In the aberrant circumstance that a SUBSCRIBE request is forked, the SUBSCRIBER SHOULD terminate all but one subscription, as described in section 4.4.9 of RFC 3265 .

Because the data stored in HTTP for the purpose of SIP services may change rapidly due to user input, and because it may potentially be rendered to users and/or used to impact call routing, a high degree of responsiveness is appropriate. However, for the protection of the network, notifiers for the http-monitor event package SHOULD NOT send notifications more frequently than once every second.

Decomposition of the authority for the HTTP resource into an HTTP Server and a SIP Events Server is likely to be useful, due to the potentially different scaling properties associated with serving HTTP resources and managing subscriptions. In the case of such decomposition, implementors are encouraged to familiarize themselves with the PUBLISH mechanism described in RFC 3903 .

| | |(2) HTTP 200 OK | | |<------------------| | |(3) SIP SUBSCRIBE | | |-------------------------------------->| |(4) SIP 200 OK | | |<--------------------------------------| |(5) SIP NOTIFY | | |<--------------------------------------| |(6) SIP 200 OK | | |-------------------------------------->| | |(7) SIP PUBLISH | | |------------------>| | |(8) SIP 200 OK | | |<------------------| |(9) SIP NOTIFY | | |<--------------------------------------| |(10) SIP 200 | | |-------------------------------------->| | | | | | | ]]> [TBD: include full example messages]

[TBD: these sections need some prose to describe which registry we're putting the values in to]

Relation Name: monitor Description: Refers to a resource that can be used to monitor changes. Reference: RFC XXXX [[Note to RFC Editor: replace with the RFC number for this specification]]

http-monitor package Adam Roach, adam.roach@tekelec.com RFC XXXX [[Note to RFC Editor: replace with the RFC number for this specification]]

This document proposes a new message/httpfrag Message Media Type, to be registered at http://www.iana.org/assignments/media-types/message/. This body type is described in section

Media Type name: message Media subtype name: httpfrag Required parameters: none Optional parameters: version, msgtype The HTTP-Version number of the enclosed message (e.g., "1.1"). If not present, the version can be determined from the first line of the body. The message type -- "request" or "response".

Encoding considerations: only "7bit", "8bit", or "binary" are permitted Security considerations: none

Thanks to Lisa Dusseault and Mark Nottingham for significant input on the mechanisms to bind an HTTP URL to a SIP URI. Thanks to Robert Sparks for the message/sipfrag specification, from which the message/httpfrag definition was lifted wholesale.