{"id":884,"date":"2006-12-04T23:47:50","date_gmt":"2006-12-05T07:47:50","guid":{"rendered":"http:\/\/cephas.net\/blog\/2006\/12\/04\/rssatom-feeds-last-modified-and-etags\/"},"modified":"2006-12-05T14:42:46","modified_gmt":"2006-12-05T22:42:46","slug":"rssatom-feeds-last-modified-and-etags","status":"publish","type":"post","link":"https:\/\/cephas.net\/blog\/2006\/12\/04\/rssatom-feeds-last-modified-and-etags\/","title":{"rendered":"RSS\/Atom feeds, Last Modified and Etags"},"content":{"rendered":"

Sometime last week I read this piece<\/a> by Sam Ruby<\/a>, which summarized says this:<\/p>\n

\n…don\u00e2\u20ac\u2122t send Etag and Last-Modified headers unless you really mean it. But if you can support it, please do. It will save you some bandwidth and your readers some processing.\n<\/p><\/blockquote>\n

The product I’ve been working on at work<\/a> (which I should be able to start talking about soon<\/strike> which I can talk about now) for the last couple months uses feeds (either Atom, RSS 1.0 or RSS 2.0, your choice) extensively but didn’t have Etag or Last-Modified<\/a> support so I spent a couple hours working on it this past weekend. We’re using ROME<\/a>, so the code ended up looking something like this:<\/p>\n

\r\nHttpServletRequest request = ...\r\nHttpServletResponse response = ....\r\nSyndFeed feed = ...\r\nif (!isModified(request, feed)) {\r\n  response.setStatus(HttpServletResponse.SC_NOT_MODIFIED);\r\n} else {\r\n  long publishDate = feed.getPublishedDate().getTime();\r\n  response.setDateHeader(\"Last-Modified\", publishDate);\r\n  response.setHeader(\"Etag\", getEtag(feed));\r\n}\r\n...\r\nprivate String getEtag(SyndFeed feed) {\r\n  return \"\\\"\" + String.valueOf(feed.getPublishedDate().getTime()) + \"\\\"\";\r\n}\r\n...\r\nprivate boolean isModified(HttpServletRequest request, SyndFeed feed) {\r\n  if (request.getHeader(\"If-Modified-Since\") != null && request.getHeader(\"If-None-Match\") != null) {\r\n  String feedTag = getEtag(feed);\r\n    String eTag = request.getHeader(\"If-None-Match\");\r\n    Calendar ifModifiedSince = Calendar.getInstance();\r\n    ifModifiedSince.setTimeInMillis(request.getDateHeader(\"If-Modified-Since\"));\r\n    Calendar publishDate = Calendar.getInstance();\r\n    publishDate.setTime(feed.getPublishedDate());\r\n    publishDate.set(Calendar.MILLISECOND, 0);\r\n    int diff = ifModifiedSince.compareTo(publishDate);\r\n    return diff != 0 || !eTag.equalsIgnoreCase(feedTag);\r\n  } else {\r\n    return true;\r\n  }\r\n}\r\n<\/pre>\n
There are only a two gotchas in the code:<\/p>\n
    \n
  1. The value of the Etag must be quoted, hence the getEtag(...)<\/code> method above returning a string wrapped in quotes.  Not hard to do, but easy to miss.<\/li>\n
  2. The first block of code above uses the setDateHeader(String name, long date)<\/code> to set the ‘Last-Modified’ HTTP header, which conveniently takes care of formatting the given date according to the RFC 822 specification for dates and times<\/a>. The published date<\/a> comes from ROME.  Here’s where it gets tricky: if the client returns the ‘If-Modified-Since’ header and you retrieve said date from the request using getDateHeader(String name)<\/code>, you’ll get a Date in the GMT timezone, which means if you want to compare the date you’ll have to get the date into your own timezone.  That’s relatively easy to do by creating a Calendar<\/code> instance and setting the time of the instance to the value you retrieved from the header. The Calendar instance will transparently take care of the timezone change for you.  But there’s still one thing left: the date specification for RFC 822 doesn’t specify a millisecond so if the long<\/code> value you hand to setDateHeader(long date)<\/code> method contains a millisecond value and you then try to use the same value to compare against the ‘If-Modified-Since’ header, you’ll never get a match.  The easy way around that is to manually set the millisecond bits on the date you get back from the ‘If-Modified-Since’ header to zero. <\/li>\n<\/ol>\n
    If you’re interested, there are a number of other blogs \/ articles about Etags and Last-Modified headers:<\/p>\n