net.sourceforge.cruisecontrol
Interface Publisher

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AntPublisher, ArtifactsPublisher, ClearCaseBaselinePublisher, CMSynergyBaselinePublisher, CMSynergyPublisher, CMSynergyTaskPublisher, CompoundPublisher, ConditionalPublisher, CurrentBuildStatusFTPPublisher, CurrentBuildStatusPublisher, EmailPublisher, ExecutePublisher, FTPPublisher, HTMLEmailPublisher, HTTPPublisher, JabberPublisher, LinkEmailPublisher, LinkJabberPublisher, OnFailurePublisher, OnSuccessPublisher, RSSPublisher, SametimeAnnouncementPublisher, SCPPublisher, SfeeDocumentManagerPublisher, SfeeFrsPublisher, SfeePublisher, SfeeTrackerPublisher, SocketPublisher, WeblogPublisher, X10Publisher, XSLTLogPublisher, YahooPublisher

public interface Publisher
extends java.io.Serializable

The Publisher interface is designed to perform any kind of publishing after a build occurs. Implementations could include, but are certainly not limited to, an XSLTPublisher or an EmailPublisher. Since a publisher can perform any task with any data from the build, it makes sense to pass the entire build log, which already holds all the information that we have.

Method Summary

void	publish(org.jdom.Element cruisecontrolLog) Define the publishing.
void	validate() Called after the configuration is read to make sure that all the mandatory parameters were specified..

Method Detail

publish

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

Define the publishing.

Parameters:

cruisecontrolLog - JDOM Element representation of the main cruisecontrol build log

Throws:

CruiseControlException

validate

void validate()
              throws CruiseControlException

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

Throws:

CruiseControlException - if there was a configuration error.