working on a lengthy article... how do you want it?
Category poll
Chris Toohey (or, as I affectionately call him, "Winnie the Tooh") and I have long dreamed of creating true REST API's for Domino applications. In fact, some of you may remember that Yellowcast was originally created to establish an auditory documentary of our explorations in that area. And yes, to the many who have asked us (and even publicly called us out for not yet doing so), some new episodes are on the drawing board... we just haven't had time yet to record them. Some of you may also remember that, at the time, we collided at full speed with some inherent limitations in the Domino platform that kept us from implementing a true REST architecture - at least, not without some gruesome hacks that we didn't quite have the stomach for. Well, as it turns out, this is one of many functional concepts that are just remarkably simple to implement in an XPage.
Chris has already been posting some intriguing stuff about how this is done, but one facet of it that I was playing with a while back is how to roll your own authentication for such an API, since standard Domino authentication unfortunately does not lend itself well to the sort of viral, consumer-platform-agnostic adoption services like Twitter currently enjoy. While the actual implementation of this is still dead simple, the underlying techniques used by the approach I settled upon are rather unconventional compared to traditional Domino development techniques. As such, in attempting to write up an explanation of the approach, I've found myself going into much more meticulous detail than is customary for this blog. In fact, when it's finished, it's unlikely the content would fit safely within the limits of NSF summary data. In other words, I can't just plop it into a single blog post.
So here are a few options I've considered, and I'd like your feedback on which you'd prefer (and feel free to suggest an alternative I haven't listed):
So there you have it. Do you see an option you prefer, or do you have other suggestions?
Chris Toohey (or, as I affectionately call him, "Winnie the Tooh") and I have long dreamed of creating true REST API's for Domino applications. In fact, some of you may remember that Yellowcast was originally created to establish an auditory documentary of our explorations in that area. And yes, to the many who have asked us (and even publicly called us out for not yet doing so), some new episodes are on the drawing board... we just haven't had time yet to record them. Some of you may also remember that, at the time, we collided at full speed with some inherent limitations in the Domino platform that kept us from implementing a true REST architecture - at least, not without some gruesome hacks that we didn't quite have the stomach for. Well, as it turns out, this is one of many functional concepts that are just remarkably simple to implement in an XPage.
Chris has already been posting some intriguing stuff about how this is done, but one facet of it that I was playing with a while back is how to roll your own authentication for such an API, since standard Domino authentication unfortunately does not lend itself well to the sort of viral, consumer-platform-agnostic adoption services like Twitter currently enjoy. While the actual implementation of this is still dead simple, the underlying techniques used by the approach I settled upon are rather unconventional compared to traditional Domino development techniques. As such, in attempting to write up an explanation of the approach, I've found myself going into much more meticulous detail than is customary for this blog. In fact, when it's finished, it's unlikely the content would fit safely within the limits of NSF summary data. In other words, I can't just plop it into a single blog post.
So here are a few options I've considered, and I'd like your feedback on which you'd prefer (and feel free to suggest an alternative I haven't listed):
- A series of blog posts, each functioning as a miniature "chapter" in a larger saga - the advantage of this is that you'd get a little bit at a time, and of course the suspense surrounding when the next chapter will be available (kidding, I know none of you are losing sleep over when I'm going to get around to blogging again). The disadvantage, of course, is that I might tease you with the first couple chapters, then leave you hanging because something shiny caught my eye and distracted me from finishing what I started.
- A VIEW article (assuming it becomes something they'd want to publish) - the advantage of this is that the content is guaranteed to be more polished, since they don't publish anything until it meets their high standards for technical content. The obvious disadvantage is that it wouldn't be freely available; you'd need to be a subscriber to read it... though, as I've mentioned before, their content is well worth the subscription price.
- One big PDF - just as with a VIEW article, you wouldn't see any of it until it's all done, but when it is, it'll be in a single, reasonably coherent form. And, of course, I could always post it in various stages of draft, so you could follow along as the overall content takes shape.
So there you have it. Do you see an option you prefer, or do you have other suggestions?

Comments
Posted by Ben Poole At 03:35:26 PM On 06/09/2010 | - Website - |
Hm... developerWorks... that's an intriguing idea. I hadn't thought of that, but I'll definitely consider it.
Posted by Tim Tripcony At 10:42:27 AM On 06/09/2010 | - Website - |
This way if something shinny catches your eye all you have to do is push the publish button for the next post.
Posted by Erskine Harris At 07:26:24 PM On 06/09/2010 | - Website - |
Does that make you Piglet?!
Have you considered talking to IBM about an article on developerWorks?
Posted by Chris Toohey At 10:30:05 AM On 06/09/2010 | - Website - |
Posted by Patrick Kwinten At 10:28:53 AM On 06/09/2010 | - Website - |
Posted by patrick picard At 07:14:07 AM On 06/09/2010 | - Website - |
Thanks for all your great contributions to the Lotus community.
Posted by Mike McGarel At 10:47:17 AM On 06/09/2010 | - Website - |
While you are at it, if you could include some examples of using REST API's between Domino and LotusLive and other Lotus products (such as Connections) that would be greatly appreciated as well.
Also if you could discuss the concept of using Atom or RSS feeds from LotusLive to trigger a Notification to an Agent in Domino (rather than manually activated Atom or RSS feeds), then that would also be greatly appreciated as well. Or if you have another idea that would achieve the same result that would be great.
I know that this is strecthing the scope of a REST API in Domino topic, but I can but ask.
Posted by Ian Randall At 03:32:59 AM On 06/09/2010 | - Website - |