net.sourceforge.cruisecontrol.publishers
Class AntPublisher

java.lang.Object
  extended bynet.sourceforge.cruisecontrol.publishers.AntPublisher
All Implemented Interfaces:
Publisher, java.io.Serializable

public class AntPublisher
extends java.lang.Object
implements Publisher

A thin wrapper around the AntBuilder class, this class allows you to call an Ant script as a publisher.

All properties set by CC and passed to the builder will be available as properties within Ant.

Author:
Robert J. Smith
See Also:
Serialized Form

Constructor Summary
AntPublisher()
           
 
Method Summary
 java.lang.Object createJVMArg()
           
 Property createProperty()
           
 java.lang.String getLoggerClassName()
           
 void publish(org.jdom.Element log)
          Define the publishing.
 void setAntHome(java.lang.String antHome)
           
 void setAntScript(java.lang.String antScript)
           
 void setAntWorkingDir(java.lang.String dir)
           
 void setBuildFile(java.lang.String buildFile)
           
 void setLoggerClassName(java.lang.String string)
           
 void setSaveLogDir(java.lang.String dir)
           
 void setTarget(java.lang.String target)
           
 void setTempFile(java.lang.String tempFileName)
           
 void setTimeout(long timeout)
           
 void setUseDebug(boolean debug)
           
 void setUseLogger(boolean useLogger)
           
 void setUseQuiet(boolean quiet)
           
 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

AntPublisher

public AntPublisher()
Method Detail

publish

public void publish(org.jdom.Element log)
             throws CruiseControlException
Description copied from interface: Publisher
Define the publishing.

Specified by:
publish in interface Publisher
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..

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

setSaveLogDir

public void setSaveLogDir(java.lang.String dir)
See Also:
AntBuilder.setSaveLogDir(String)

setAntWorkingDir

public void setAntWorkingDir(java.lang.String dir)
See Also:
AntBuilder.setAntWorkingDir(String)

setAntScript

public void setAntScript(java.lang.String antScript)
See Also:
AntBuilder.setAntScript(String)

setAntHome

public void setAntHome(java.lang.String antHome)
See Also:
AntBuilder.setAntHome(String)

setTempFile

public void setTempFile(java.lang.String tempFileName)
See Also:
AntBuilder.setTempFile(String)

setTarget

public void setTarget(java.lang.String target)
See Also:
AntBuilder.setTarget(String)

setBuildFile

public void setBuildFile(java.lang.String buildFile)
See Also:
AntBuilder.setBuildFile(String)

setUseLogger

public void setUseLogger(boolean useLogger)
See Also:
AntBuilder.setUseLogger(boolean)

createJVMArg

public java.lang.Object createJVMArg()
See Also:
AntBuilder.createJVMArg()

createProperty

public Property createProperty()
See Also:
AntBuilder.createProperty()

setUseDebug

public void setUseDebug(boolean debug)
See Also:
AntBuilder.setUseDebug(boolean)

setUseQuiet

public void setUseQuiet(boolean quiet)
See Also:
AntBuilder.setUseQuiet(boolean)

getLoggerClassName

public java.lang.String getLoggerClassName()
See Also:
AntBuilder.getLoggerClassName()

setLoggerClassName

public void setLoggerClassName(java.lang.String string)
See Also:
AntBuilder.setLoggerClassName(String)

setTimeout

public void setTimeout(long timeout)
See Also:
AntBuilder.setTimeout(long)