net.sourceforge.cruisecontrol.publishers
Class CMSynergyBaselinePublisher

java.lang.Object
  net.sourceforge.cruisecontrol.publishers.CMSynergyPublisher
      net.sourceforge.cruisecontrol.publishers.CMSynergyBaselinePublisher

All Implemented Interfaces:

Publisher, java.io.Serializable

public class CMSynergyBaselinePublisher

extends CMSynergyPublisher

Creates an intermediate baseline encompassing the given project and all subprojects.
Note: This publisher requires CM Synergy version 6.3 or later.

Author:

Robert J. Smith

See Also:

Serialized Form

Field Summary

static java.lang.String

CCM_BASELINE_PURPOSE The default CM Synergy project purpose for the baseline

Constructor Summary

CMSynergyBaselinePublisher()

Method Summary

void	publish(org.jdom.Element log) Define the publishing.
void	setBaselineName(java.lang.String name) Sets the name (version label) which will be given to the newly created project versions.
void	setDescription(java.lang.String description) Sets the description of the baseline.
void	setPurpose(java.lang.String purpose) Sets the purpose of the baseline.
void	validate() Called after the configuration is read to make sure that all the mandatory parameters were specified..

Methods inherited from class net.sourceforge.cruisecontrol.publishers.CMSynergyPublisher

getBuildProperties, getCcmExe, getNewTasks, getProject, getSessionFile, getSessionName, setCcmExe, setProject, setSessionFile, setSessionName, shouldPublish

Methods inherited from class java.lang.Object

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

Field Detail

CCM_BASELINE_PURPOSE

public static final java.lang.String CCM_BASELINE_PURPOSE

The default CM Synergy project purpose for the baseline

See Also:

Constant Field Values

Constructor Detail

CMSynergyBaselinePublisher

public CMSynergyBaselinePublisher()

Method Detail

setPurpose

public void setPurpose(java.lang.String purpose)

Sets the purpose of the baseline. Default is "Integration Testing".

Parameters:

purpose - The baseline's purpose

setBaselineName

public void setBaselineName(java.lang.String name)

Sets the name (version label) which will be given to the newly created project versions. You may use macros to specify any of the default properties set by CruiseControl (i.e. those which appear in the info section of the log file).

example:

name="BUILD_@{cctimestamp}"

Parameters:

name - The name of the baseline

setDescription

public void setDescription(java.lang.String description)

Sets the description of the baseline.

Parameters:

description - The description

publish

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

Description copied from interface: Publisher

Define the publishing.

Parameters:

log - JDOM Element representation of the main cruisecontrol build log

Throws:

CruiseControlException

validate

public void validate()
              throws CruiseControlException

Description copied from interface: Publisher

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

Throws:

CruiseControlException - if there was a configuration error.