io.micronaut.rss

Class FeedController

java.lang.Object

io.micronaut.rss.FeedController

@Requires(beans={RssFeedProvider.class,RssFeedRenderer.class}) @Requires(property="micronaut.rss.feed.enabled",notEquals="false")
 @Controller(value="${micronaut.rss.feed.path:/feed}")
public class FeedController
extends java.lang.Object

Micronaut Controller which exposes an RSS 2.0 Feed.

Since:

1.0

Author:

Sergio del Amo

Constructor Summary

Constructors

Constructor and Description
FeedController(RssFeedProvider rssFeedProvider, RssFeedRenderer rssFeedRenderer)

Method Summary

Modifier and Type	Method and Description
io.micronaut.http.HttpResponse<io.micronaut.core.io.Writable>	find(java.io.Serializable id)
io.micronaut.http.HttpResponse	head() Provides a HEAD endpoint for the default RSS 2.0 feed.
io.micronaut.http.HttpResponse	headFind(java.io.Serializable id)
io.micronaut.http.HttpResponse<io.micronaut.core.io.Writable>	index()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FeedController

public FeedController(RssFeedProvider rssFeedProvider,
                      RssFeedRenderer rssFeedRenderer)

Parameters:

rssFeedProvider - A bean which returns RSS 2.0 feeds.

rssFeedRenderer - Provides a bean to render RssChannel

Method Detail

index

@Produces(value="application/xml")
 @Get
public io.micronaut.http.HttpResponse<io.micronaut.core.io.Writable> index()

Returns:

Return the default RSS 2.0 provided by RssFeedProvider and rendered by RssFeedRenderer.

head

@Head
 @Produces(value="application/xml")
public io.micronaut.http.HttpResponse head()

Provides a HEAD endpoint for the default RSS 2.0 feed.

Returns:

200 or 404

find

@Produces(value="application/xml")
 @Get(value="/{id}")
public io.micronaut.http.HttpResponse<io.micronaut.core.io.Writable> find(java.io.Serializable id)

Parameters:

id - RSS guid

Returns:

Return the RSS 2.0 identified by the path parameter provided by RssFeedProvider and rendered by RssFeedRenderer.

headFind

@Produces(value="application/xml")
 @Head(value="/{id}")
public io.micronaut.http.HttpResponse headFind(java.io.Serializable id)

Parameters:

id - RSS guid Provides a HEAD endpoint for the RSS 2.0 feed identified by the path parameter.

Returns:

200 or 404