net.sf.logdistiller.publishers

Class FeedPublisher

java.lang.Object

net.sf.logdistiller.Publisher

net.sf.logdistiller.publishers.FeedPublisher

public class FeedPublisher
extends Publisher

Adds LogDistillation reports to a feed file (at the beginning). Any feed format supported by Rome can be used.

Parameters (as direct publisher param or global feed.* param):

• filename (default: feed.xml): the feed file name (relative to output directory)
• maxEntries (default: 100): maximum entries in the feed file: if new entries are added, oldest ones are removed

When the feed file must be created, these parameters are used:

• type (default: atom_0.3): the feed type (any value supported by Rome)
• title: the feed title (default: "LogDistiller [logdistillation id]"
• link: the feed link (default: LogDistiller's site)
• description: the feed description (default: "LogDistiller reports for [logdistillation id]"

Since:

0.7

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.logdistiller.Publisher

Publisher.PublishException

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_FEED_TYPE

Constructor Summary

Constructors

Constructor and Description
FeedPublisher()

Method Summary

Methods

Modifier and Type	Method and Description
String	getId() Get the publisher-id for this class.
void	publish(LogDistillation.Group group, LogDistiller.Report report) Publish a group report.
void	publish(LogDistillation logdistillation, LogDistiller.Report report) Publish a global report.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FEED_TYPE

public static final String DEFAULT_FEED_TYPE

See Also:

Constant Field Values

Constructor Detail

FeedPublisher

public FeedPublisher()

Method Detail

getId

public String getId()

Description copied from class: Publisher

Get the publisher-id for this class.

Specified by:

getId in class Publisher

Returns:

a unique publisher id

publish

public void publish(LogDistillation logdistillation,
           LogDistiller.Report report)
             throws IOException,
                    Publisher.PublishException

Description copied from class: Publisher

Publish a global report.

Specified by:

publish in class Publisher

Parameters:

logdistillation - the logdistillation containing the results to publish

report - the report configuration

Throws:

IOException

Publisher.PublishException

publish

public void publish(LogDistillation.Group group,
           LogDistiller.Report report)
             throws IOException,
                    Publisher.PublishException

Description copied from class: Publisher

Publish a group report.

Specified by:

publish in class Publisher

Parameters:

group - the logdstillation group containing the results to publish

report - the report configuration

Throws:

IOException

Publisher.PublishException