net.sourceforge.cruisecontrol.publishers
Class RSSPublisher

java.lang.Object
  net.sourceforge.cruisecontrol.publishers.RSSPublisher

All Implemented Interfaces:

Publisher, java.io.Serializable

public class RSSPublisher

extends java.lang.Object

implements Publisher

Publisher Plugin which publishes the most recent build information to an RSS (Really Simple Syndication) Feed. Copyright (c) 2005 Hewlett-Packard Development Company, L.P.

Author:

Patrick Conant

See Also:

Serialized Form

Constructor Summary

RSSPublisher()

Method Summary

static CruiseControlFeed	getRSSFeed(java.io.File publishToFile) Static method that allows multiple project RSSPublishers to share a single RSSFeed instance.
void	publish(org.jdom.Element cruisecontrolLog) Define the publishing.
protected void	publishFeed()
void	setBuildResultsURL(java.lang.String buildResultsURL) Set the build results URL.
void	setChannelLinkURL(java.lang.String channelLinkURL) Set the channel link URL.
void	setFile(java.lang.String fileName) Set the name of the file to which the RSS feed should be pushed.
void	setMaxLength(int max) The maximum number of entries to include in the RSS feed.
void	validate() Called after the configuration is read to make sure that all the mandatory parameters were specified..

Methods inherited from class java.lang.Object

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

Constructor Detail

RSSPublisher

public RSSPublisher()

Method Detail

getRSSFeed

public static CruiseControlFeed getRSSFeed(java.io.File publishToFile)

Static method that allows multiple project RSSPublishers to share a single RSSFeed instance.

publish

public void publish(org.jdom.Element cruisecontrolLog)
             throws CruiseControlException

Define the publishing.

Specified by:

publish in interface Publisher

Parameters:

cruisecontrolLog - JDOM Element representation of the main cruisecontrol build log

Throws:

CruiseControlException

publishFeed

protected void publishFeed()
                    throws CruiseControlException

Throws:

CruiseControlException

validate

public void validate()
              throws CruiseControlException

Called after the configuration is read to make sure that all the mandatory parameters were specified..

Specified by:

validate in interface Publisher

Throws:

CruiseControlException - if there was a configuration error.

setFile

public void setFile(java.lang.String fileName)

Set the name of the file to which the RSS feed should be pushed.

setBuildResultsURL

public void setBuildResultsURL(java.lang.String buildResultsURL)

Set the build results URL. This should be of the format: http://[SERVER]/cruisecontrol/buildresults/[OPTIONAL_PROJECT_NAME]

setChannelLinkURL

public void setChannelLinkURL(java.lang.String channelLinkURL)

Set the channel link URL. In many newsreaders, this is the URL linked from the feed title.

setMaxLength

public void setMaxLength(int max)

The maximum number of entries to include in the RSS feed. Default is 10.