How to: Expose a Feed as both Atom and RSS

How to: Expose a Feed as both Atom and RSS
Windows Communication Foundation (WCF) allows you to create a service that exposes a syndication feed. This topic discusses how to create a syndication service that exposes a syndication feed using both Atom 1.0 and RSS 2.0. This service exposes one endpoint that can return either syndication format. For simplicity the service used in this sample is self hosted. In a production environment a service of this type would be hosted under IIS or WAS. For more information about the different WCF hosting options, see Hosting of Windows Communication Foundation Services.

To create a basic syndication service

  1. Define a service contract using an interface marked with the WebGetAttribute attribute. Each operation that is exposed as a syndication feed returns a SyndicationFeedFormatter object. Note the parameters for the WebGetAttribute. UriTemplate specifies the URL used to invoke this service operation. The string for this parameter contains literals and a variable in braces ({format}). This variable corresponds to the service operation's format parameter. For more information, see UriTemplate. BodyStyle affects how the messages that this service operation sends and receives are written. Bare specifies that the data sent to and from this service operation are not wrapped by infrastructure-defined XML elements. For more information, see WebMessageBodyStyle.
    Visual Basic 

     _
GetType(Atom10FeedFormatter))> _
GetType(Rss20FeedFormatter))> _
Public Interface IBlog
     _
    "GetBlog?format={format}")> _
    Function GetBlog(ByVal format As String) As SyndicationFeedFormatter
End Interface
    C# 

    [ServiceContract]
[ServiceKnownType(typeof(Atom10FeedFormatter))]
[ServiceKnownType(typeof(Rss20FeedFormatter))]
public interface IBlog
{
    [OperationContract]
    [WebGet(UriTemplate = "GetBlog?format={format}")]
    SyndicationFeedFormatter GetBlog(string format);
}
    Bb412205.note(en-us,VS.90).gifNote:
    Use the ServiceKnownTypeAttribute to specify the types that are returned by the service operations in this interface.
  2. Implement the service contract.
    Visual Basic 

    Public Class BlogService
    implements IBlog

    Public Function GetBlog(ByVal format As String) As SyndicationFeedFormatter Implements IBlog.GetBlog
        Dim feed As New SyndicationFeed("My Blog Feed", "This is a test feed", New Uri("http://SomeURI"))
        feed.Authors.Add(New SyndicationPerson("someone@microsoft.com"))
        feed.Categories.Add(New SyndicationCategory("How To Sample Code"))
        feed.Description = New TextSyndicationContent("This is a sample that demonstrates how to expose a feed through RSS and Atom with WCF")
        Dim item1 As New SyndicationItem( _
            "Item One", _
            "This is the content for item one", _
            New Uri("http://localhost/Content/One"), _
            "ItemOneID", _
            DateTime.Now)

        Dim item2 As New SyndicationItem( _
            "Item Two", _
            "This is the content for item two", _
            New Uri("http://localhost/Content/Two"), _
            "ItemTwoID", _
            DateTime.Now)

        Dim item3 As New SyndicationItem( _
            "Item Three", _
            "This is the content for item three", _
            New Uri("http://localhost/Content/three"), _
            "ItemThreeID", _
            DateTime.Now)
        Dim items As New List(Of SyndicationItem)()
        items.Add(item1)
        items.Add(item2)
        items.Add(item3)

        feed.Items = items

        If (format = "rss") Then
            Return New Rss20FeedFormatter(feed)
        Else
            Return New Atom10FeedFormatter(feed)
        End If
    End Function
End Class
    C# 

    public class BlogService : IBlog
{
    public SyndicationFeedFormatter GetBlog(string format)
    {
        SyndicationFeed feed = new SyndicationFeed("My Blog Feed", "This is a test feed", new Uri("http://SomeURI"));
        feed.Authors.Add(new SyndicationPerson("someone@microsoft.com"));
        feed.Categories.Add(new SyndicationCategory("How To Sample Code"));
        feed.Description = new TextSyndicationContent("This is a sample that demonstrates how to expose a feed through RSS and Atom with WCF");
        SyndicationItem item1 = new SyndicationItem(
            "Item One",
            "This is the content for item one",
            new Uri("http://localhost/Content/One"),
            "ItemOneID",
            DateTime.Now);

        SyndicationItem item2 = new SyndicationItem(
            "Item Two",
            "This is the content for item two",
            new Uri("http://localhost/Content/Two"),
            "ItemTwoID",
            DateTime.Now);

        SyndicationItem item3 = new SyndicationItem(
            "Item Three",
            "This is the content for item three",
            new Uri("http://localhost/Content/three"),
            "ItemThreeID",
            DateTime.Now);
        List items = new List();
        items.Add(item1);
        items.Add(item2);
        items.Add(item3);

        feed.Items = items;

        if (format == "rss")
            return new Rss20FeedFormatter(feed);
        else if (format == "atom")
            return new Atom10FeedFormatter(feed);
        else return null;
    }
}
  3. Create a SyndicationFeed object and add an author, category, and description.
    Visual Basic 

    Dim feed As New SyndicationFeed("My Blog Feed", "This is a test feed", New Uri("http://SomeURI"))
feed.Authors.Add(New SyndicationPerson("someone@microsoft.com"))
feed.Categories.Add(New SyndicationCategory("How To Sample Code"))
feed.Description = New TextSyndicationContent("This is a sample that demonstrates how to expose a feed through RSS and Atom with WCF")
    C# 

    SyndicationFeed feed = new SyndicationFeed("My Blog Feed", "This is a test feed", new Uri("http://SomeURI"));
feed.Authors.Add(new SyndicationPerson("someone@microsoft.com"));
feed.Categories.Add(new SyndicationCategory("How To Sample Code"));
feed.Description = new TextSyndicationContent("This is a sample that demonstrates how to expose a feed through RSS and Atom with WCF");
  4. Create several SyndicationItem objects.
    Visual Basic 

    Dim item1 As New SyndicationItem( _
    "Item One", _
    "This is the content for item one", _
    New Uri("http://localhost/Content/One"), _
    "ItemOneID", _
    DateTime.Now)

Dim item2 As New SyndicationItem( _
    "Item Two", _
    "This is the content for item two", _
    New Uri("http://localhost/Content/Two"), _
    "ItemTwoID", _
    DateTime.Now)

Dim item3 As New SyndicationItem( _
    "Item Three", _
    "This is the content for item three", _
    New Uri("http://localhost/Content/three"), _
    "ItemThreeID", _
    DateTime.Now)
    C# 

    SyndicationItem item1 = new SyndicationItem(
    "Item One",
    "This is the content for item one",
    new Uri("http://localhost/Content/One"),
    "ItemOneID",
    DateTime.Now);

SyndicationItem item2 = new SyndicationItem(
    "Item Two",
    "This is the content for item two",
    new Uri("http://localhost/Content/Two"),
    "ItemTwoID",
    DateTime.Now);

SyndicationItem item3 = new SyndicationItem(
    "Item Three",
    "This is the content for item three",
    new Uri("http://localhost/Content/three"),
    "ItemThreeID",
    DateTime.Now);
  5. Add the SyndicationItem objects to the feed.
    Visual Basic 

    Dim items As New List(Of SyndicationItem)()
items.Add(item1)
items.Add(item2)
items.Add(item3)

feed.Items = items
    C# 

    List items = new List();
items.Add(item1);
items.Add(item2);
items.Add(item3);

feed.Items = items;
  6. Use the format parameter to return the requested format.
    Visual Basic 

    If (format = "rss") Then
    Return New Rss20FeedFormatter(feed)
Else
    Return New Atom10FeedFormatter(feed)
End If



See full details: http://msdn.microsoft.com/en-us/library/bb412205.aspx

Comments

Post a Comment

Popular posts from this blog

Very fast test data generation using exponential INSERT

Image
Introduction This article (my first) will describe an algorithm that enables a large amount of data to be generated very quickly using a SQL query. The test data can be static or incremental, such as “Item Name” and “Item ID”, respectively, as shown below: Background One of the tasks I did in a project involves generating a testing table with 103,680,000 records. The conventional method of data generation would take a month; hence, a fast method of data insertion was required. The new method took only 5 hours. Using the code Conventional method – Sequential INSERT The conventional way of generating a list of numbers from 0…100000 would be using a loop and an INSERT statement as follows: CREATE TABLE #tempTable([Item ID] [ bigint ], [Item Name] nvarchar ( 30 )) DECLARE @counter int SET @counter = 1 WHILE (@counter 100000 ) BEGIN INSERT INTO #tempTable VALUES (@counter, ' Hammer' ) SET @counter = @counter + 1 END SELECT * FROM #tem...
Read more

Basic concept and fundamentals of ASP.NET MVC (Model View Controller) Architecture

Image
This is basic concepts and fundamentals of ASP.NET Model View Controller (MVC) architecture workflow. MVC is stands for MODEL VIEW CONTROLLER. ASP.NET MVC is an architecture to develop ASP.NET web applications in a different manner than the traditional ASP.NET web development. Web applications developed with ASP.NET MVC are even more SEO (Search Engine) friendly. Microsoft .Net Framework 3.5 is minimum requirement to develop ASP.net MVC application.   MVC (Model View Controller) Interaction with Browser Like a normal web server interaction, MVC application also accepts requests and responds to the web browser in the same way.   Inside MVC Architecture The entire ASP.NET MVC architecture is based on Microsoft .NET Framework 3.5 and in addition uses LINQ to SQL Server. What is a Model? MVC   model   is basically a C# or VB.NET class A   model   is accessible by both   controller   and   view A   model   can be used to pass data ...
Read more

MVC Architecture Model In ASP.NET

Image
When developing ASP.NET applications the need of reducing code duplication increases along with their complexity. This is because testing and performing changes become very difficult tasks when having many different sources of code with the same functionality. Model View Controller architecture (or pattern) allows us to separate different parts of our applications into tiers to fulfill this need. MVC Overview Model View Controller architecture aims to separate an application into three parts: Model:  It is the business logic of an application. From an object oriented perspective it would consist of a set of classes that implement the critical functionality of an application from a business point of view. View:  It can consist of every type of interface given to the user. In ASP.NET the view is the set of web pages presented by a web application. Controller:  This part of the architecture is the most difficult to explain, hence the most difficult to implement in ...
Read more