com.atlassian.confluence.rss

Class DefaultFeedBuilder

java.lang.Object

com.atlassian.confluence.rss.DefaultFeedBuilder

All Implemented Interfaces:

FeedBuilder

public class DefaultFeedBuilder
extends Object
implements FeedBuilder

Constructor Summary

Constructors

Constructor and Description
DefaultFeedBuilder(SearchManager searchManager, SettingsManager settingsManager, DefaultPermissionManager permissionManager, UserAccessor userAccessor, FormatSettingsManager formatSettingsManager, LocaleManager localeManager, Map<String,RssRenderSupport> renderSupport, com.atlassian.plugin.PluginAccessor pluginAccessor, com.atlassian.event.api.EventPublisher eventPublisher)

Method Summary

Modifier and Type	Method and Description
com.sun.syndication.feed.synd.SyndFeed	createFeed(ISearch search, FeedProperties feedProperties) Constructs a feed off the specified search.
com.sun.syndication.feed.synd.SyndFeed	createFeed(ListQuery listQuery, boolean showContent, boolean showDiff, com.atlassian.user.User user) Deprecated. since 4.0.
com.sun.syndication.feed.synd.SyndFeed	createFeed(ListQuery query, FeedProperties feedProperties) Deprecated. since 4.2
String	getDomainName()
UserAccessor	getUserAccessor()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultFeedBuilder

public DefaultFeedBuilder(SearchManager searchManager,
                          SettingsManager settingsManager,
                          DefaultPermissionManager permissionManager,
                          UserAccessor userAccessor,
                          FormatSettingsManager formatSettingsManager,
                          LocaleManager localeManager,
                          Map<String,RssRenderSupport> renderSupport,
                          com.atlassian.plugin.PluginAccessor pluginAccessor,
                          com.atlassian.event.api.EventPublisher eventPublisher)

Method Detail

createFeed

public com.sun.syndication.feed.synd.SyndFeed createFeed(ISearch search,
                                                         FeedProperties feedProperties)

Description copied from interface: FeedBuilder

Constructs a feed off the specified search.

Returns an empty feed with a title and description only if search is null.

Specified by:

createFeed in interface FeedBuilder

Returns:

a synd feed for the results of specified search

getDomainName

public String getDomainName()

getUserAccessor

public UserAccessor getUserAccessor()

createFeed

@Deprecated
public com.sun.syndication.feed.synd.SyndFeed createFeed(ListQuery listQuery,
                                                                     boolean showContent,
                                                                     boolean showDiff,
                                                                     com.atlassian.user.User user)

Deprecated. since 4.0.

Description copied from interface: FeedBuilder

Constructs a feed after running a search based on the given query.

This method can be used instead of FeedBuilder.createFeed(ISearch, FeedProperties) when it is impossible to create a corresponding ISearch object from the given ListQuery. Eg. when search results need to be further filtered to satisfy a query. see CONF-7745 and CONF-9312

Specified by:

createFeed in interface FeedBuilder

createFeed

@Deprecated
public com.sun.syndication.feed.synd.SyndFeed createFeed(ListQuery query,
                                                                     FeedProperties feedProperties)

Deprecated. since 4.2

Description copied from interface: FeedBuilder

Constructs a feed after running a search based on the given query.

This method can be used instead of FeedBuilder.createFeed(ISearch, FeedProperties) when it is impossible to create a corresponding ISearch object from the given ListQuery. Eg. when search results need to be further filtered to satisfy a query. See CONF-7745 and CONF-9312.

Specified by:

createFeed in interface FeedBuilder

Parameters:

query - the query to base the feed upon

feedProperties - metadata for the feed

Returns:

a synd feed for the results of the ListQuery