net.sourceforge.cruisecontrol.jmx
Interface ProjectMBean

All Known Subinterfaces:
ProjectControllerMBean
All Known Implementing Classes:
ProjectController

public interface ProjectMBean


Method Summary
 void build()
          Runs a build now
 void buildWithTarget(java.lang.String target)
          Runs a build now, overriding the target of the used builder
 long getBuildInterval()
           
 java.lang.String[] getBuildOutput(java.lang.Integer firstLine)
           
 java.lang.String getBuildStartTime()
           
 java.lang.String[][] getCommitMessages()
           
 java.lang.String getLabel()
           
 java.lang.String getLabelIncrementer()
           
 java.lang.String getLastBuild()
           
 java.lang.String getLastSuccessfulBuild()
           
 java.lang.String getLogDir()
           
 java.lang.String getProjectName()
           
 java.lang.String getStatus()
          Gets the human-readable version of the project status
 boolean isPaused()
          Is the project paused?
 void pause()
          Pauses the controlled project.
 void resume()
          Resumes the controlled project.
 void serialize()
          Serialize the project
 void setBuildInterval(long buildInterval)
          Change the interval between builds
 void setLabel(java.lang.String label)
          Change the Project label
 void setLabelIncrementer(java.lang.String classname)
          Change the Project label incrementer; will only succeed if the existing label is valid for the new label incrementer
 void setLastBuild(java.lang.String date)
          Change the last built date.
 void setLastSuccessfulBuild(java.lang.String date)
          Change the last built date.
 void setLogDir(java.lang.String logdir)
          Change the directory where CruiseControl logs are kept
 void setProjectName(java.lang.String name)
          Change the project name.
 

Method Detail

pause

public void pause()
Pauses the controlled project.


resume

public void resume()
Resumes the controlled project.


build

public void build()
Runs a build now


buildWithTarget

public void buildWithTarget(java.lang.String target)
Runs a build now, overriding the target of the used builder


serialize

public void serialize()
Serialize the project


isPaused

public boolean isPaused()
Is the project paused?

Returns:
Pause state

getBuildStartTime

public java.lang.String getBuildStartTime()
Returns:
start time of the last build, using the format 'yyyyMMddHHmmss'

setLabel

public void setLabel(java.lang.String label)
Change the Project label

Parameters:
label - a new label; should be valid for the current LabelIncrementer

getLabel

public java.lang.String getLabel()

setLabelIncrementer

public void setLabelIncrementer(java.lang.String classname)
                         throws CruiseControlException
Change the Project label incrementer; will only succeed if the existing label is valid for the new label incrementer

Parameters:
classname - fully qualified class name of the new label incrementer
Throws:
CruiseControlException

getLabelIncrementer

public java.lang.String getLabelIncrementer()
Returns:
name of the current label incrementer

setLastBuild

public void setLastBuild(java.lang.String date)
                  throws CruiseControlException
Change the last built date. This can be used to manipulate whether builds will be initiated.

Parameters:
date - date string in the form yyyyMMddHHmmss
Throws:
CruiseControlException

getLastBuild

public java.lang.String getLastBuild()

setLastSuccessfulBuild

public void setLastSuccessfulBuild(java.lang.String date)
                            throws CruiseControlException
Change the last built date. This can be used to manipulate whether builds will be initiated.

Parameters:
date - date string in the form yyyyMMddHHmmss
Throws:
CruiseControlException

getLastSuccessfulBuild

public java.lang.String getLastSuccessfulBuild()

setLogDir

public void setLogDir(java.lang.String logdir)
               throws CruiseControlException
Change the directory where CruiseControl logs are kept

Parameters:
logdir - Relative or absolute path to the log directory
Throws:
CruiseControlException

getLogDir

public java.lang.String getLogDir()

setProjectName

public void setProjectName(java.lang.String name)
Change the project name. May cause problems if configuration file is not also changed


getProjectName

public java.lang.String getProjectName()

setBuildInterval

public void setBuildInterval(long buildInterval)
Change the interval between builds

Parameters:
buildInterval - Build interval in milliseconds

getBuildInterval

public long getBuildInterval()

getStatus

public java.lang.String getStatus()
Gets the human-readable version of the project status


getCommitMessages

public java.lang.String[][] getCommitMessages()
Returns:
the commit message includes the commiter and message

getBuildOutput

public java.lang.String[] getBuildOutput(java.lang.Integer firstLine)