net.sourceforge.cruisecontrol.bootstrappers
Class CMSynergyBootstrapper

java.lang.Object
  extended bynet.sourceforge.cruisecontrol.bootstrappers.CMSynergyBootstrapper
All Implemented Interfaces:
Bootstrapper, java.io.Serializable

public class CMSynergyBootstrapper
extends java.lang.Object
implements Bootstrapper

The CMSynergyBootstrapper will reconfigure the project (and by default all subprojects) in order to pull in the latest changes.

If you do not wish to reconfigure subprojects, please set the recurse attribute to false.

Author:
Robert J. Smith
See Also:
Serialized Form

Constructor Summary
CMSynergyBootstrapper()
           
 
Method Summary
 void bootstrap()
          Perform the bootstrapping.
 void setCcmExe(java.lang.String ccmExe)
          Sets the name of the CM Synergy executable to use when issuing commands.
 void setProject(java.lang.String projectSpec)
          Sets the CM Synergy project you wish to reconfigure
 void setRecurse(boolean recurse)
          Sets the value of the recurse attribute.
 void setSessionFile(java.lang.String sessionFile)
          Sets the file which contains the mapping between CM Synergy session names and IDs.
 void setSessionName(java.lang.String sessionName)
          Sets the name of the CM Synergy session to use with this plugin.
 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

CMSynergyBootstrapper

public CMSynergyBootstrapper()
Method Detail

setCcmExe

public void setCcmExe(java.lang.String ccmExe)
Sets the name of the CM Synergy executable to use when issuing commands.

Parameters:
ccmExe - the name of the CM Synergy executable

setProject

public void setProject(java.lang.String projectSpec)
Sets the CM Synergy project you wish to reconfigure

Parameters:
projectSpec - The project spec (in 2 part name format).

setRecurse

public void setRecurse(boolean recurse)
Sets the value of the recurse attribute. If set to true, all subprojects will be reconfigured.

Parameters:
recurse -

setSessionFile

public void setSessionFile(java.lang.String sessionFile)
Sets the file which contains the mapping between CM Synergy session names and IDs. This file should be in the standard properties file format. Each line should map one name to a CM Synergy session ID (as returned by the "ccm status" command).

example:

session1=localhost:65024:192.168.1.17

Parameters:
sessionFile - The session file

setSessionName

public void setSessionName(java.lang.String sessionName)
Sets the name of the CM Synergy session to use with this plugin. This name should appear in the specified session file.

Parameters:
sessionName - The session name
See Also:
setSessionFile(String)

bootstrap

public void bootstrap()
               throws CruiseControlException
Description copied from interface: Bootstrapper
Perform the bootstrapping.

Specified by:
bootstrap in interface Bootstrapper
Throws:
CruiseControlException - if bootstrap fails

validate

public void validate()
              throws CruiseControlException
Description copied from interface: Bootstrapper
Called after the configuration is read to make sure that all the mandatory parameters were specified..

Specified by:
validate in interface Bootstrapper
Throws:
CruiseControlException - if there was a configuration error.