Collectors
Producers
- Basic
- Code Analysis Reports
- Core Java
- External Dependencies
- Java Unit Testing
- Miscellaneous
- Web
Executors
Collectors
BuildNumber
Generates the next number from a sequence. This collector simply
wraps the Ant BuildNumber task
Settings
| Name | Description | Default Value |
| antHome | | C:/apache-ant-1.6.2 |
| javaHome | | C:/j2sdk1.4.1_01 |
| antScript | | /plugin_build.xml |
| antTarget | | main |
| property | | todo |
| buildNumberFilename | | todo |
Component
Settings
| Name | Description | Default Value |
| antHome | | C:/apache-ant-1.6.2 |
| javaHome | | C:/j2sdk1.4.1_01 |
| antScript | | /plugin_build.xml |
| antTarget | | main |
| projectFilename | | todo |
| componentFilename | | todo |
Properties
Settings
| Name | Description | Default Value |
| filename | | todo |
Timestamp
Generates a timestamp. This collector simply wraps the Ant TStamp
task
Settings
| Name | Description | Default Value |
| antHome | | C:/apache-ant-1.6.2 |
| javaHome | | C:/j2sdk1.4.1_01 |
| antScript | | /plugin_build.xml |
| antTarget | | main |
| property | | todo |
| pattern | | todo |
Producers
Basic
Subdirectory
The subdirectory puts files into a sub-directory. It should
typically be transient, placing the re-structured files directly
into some target artifact.
Settings
| Name | Description | Default Value |
| antHome |
The home directory of the Ant distribution to use when
building the artifact
| C:/apache-ant-1.6.2 |
| javaHome |
The home directory of the JDK to use when building the
artifact
| C:/j2sdk1.4.1_01 |
| path |
The new path to be created by the subdirectory producer.
| subdirectory |
Dependencies
| Name | Description | Allows Transient |
| files |
The files to be placed in the subdirectory configured by the
path setting.
| true |
Code Analysis Reports
CheckstyleReport
Runs Checkstyle over Java code to produce a report.
Settings
| Name | Description | Default Value |
| antHome |
The home directory of the Ant distribution to use when
building the artifact
| C:/apache-ant-1.6.2 |
| javaHome |
The home directory of the JDK to use when building the
artifact
| C:/j2sdk1.4.1_01 |
Dependencies
| Name | Description | Allows Transient |
| java |
The Java source code to analyze and report on.
| false |
JDependReport
Runs JDepend over the supplied classtree dependency
to produce a report.
Settings
| Name | Description | Default Value |
| antHome |
The home directory of the Ant distribution to use when
building the artifact
| C:/apache-ant-1.6.2 |
| javaHome |
The home directory of the JDK to use when building the
artifact
| C:/j2sdk1.4.1_01 |
Dependencies
| Name | Description | Allows Transient |
| classtree |
Class tree structure containing the classes to report on
| false |
Core Java
Classtree
Produces a complete Java classtree that can consist of classes
compiled from source, pre-existing classes, and resource files
Settings
| Name | Description | Default Value |
| antHome |
The home directory of the Ant distribution to use when
building the artifact
| C:/apache-ant-1.6.2 |
| javaHome |
The home directory of the JDK to use when building the
artifact
| C:/j2sdk1.4.1_01 |
| source |
The source specification to be passed to javac.
| 1.1 |
| target |
The target specification to be passed to javac.
| 1.1 |
Dependencies
| Name | Description | Allows Transient |
| java |
Java source code to be compiled into classes.
| false |
| compilejars |
JARs to be linked in during the compilation of Java source
code
| false |
| importclasses |
Pre-built classes or other files that should be incorporated
into the classtree unchanged.
| true |
| resources |
UTF-8 encoded resource file that should be native2ascii'd,
and added to the classtree
| false |
JarFile
Packages a classtree up as a JAR file.
Settings
| Name | Description | Default Value |
| antHome |
The home directory of the Ant distribution to use when
building the artifact
| C:/apache-ant-1.6.2 |
| javaHome |
The home directory of the JDK to use when building the
artifact
| C:/j2sdk1.4.1_01 |
| jarFilename |
The name to give to the created JAR file.
| output.jar |
Dependencies
| Name | Description | Allows Transient |
| classtree |
The classtree that should be bundled up as a JAR file.
| false |
JavaApp
Assembles the standard Java application structure consisting of a
root directory with child etc, lib and classes directories.
Settings
| Name | Description | Default Value |
| antHome |
The home directory of the Ant distribution to use when
building the artifact
| C:/apache-ant-1.6.2 |
| javaHome |
The home directory of the JDK to use when building the
artifact
| C:/j2sdk1.4.1_01 |
Dependencies
| Name | Description | Allows Transient |
| lib |
All JAR files supplied as this dependency are placed in the
lib directory of the assembled application.
| true |
| classes |
All class files supplied as this dependency are placed in the
classes directory of the assembled application.
| true |
| etc |
All files supplied in this dependency are placed in the root
directory of the assembled application.
| true |
Javadoc
Produces a Javadoc bundle for the Java source code supplied on it's
java dependency.
Settings
| Name | Description | Default Value |
| antHome |
The home directory of the Ant distribution to use when
building the artifact
| C:/apache-ant-1.6.2 |
| javaHome |
The home directory of the JDK to use when building the
artifact
| C:/j2sdk1.4.1_01 |
| source |
The JDK version that the code was written for.
| 1.1 |
Dependencies
| Name | Description | Allows Transient |
| java |
The Java source code to be documented.
| false |
UnzippedFileset
Unpacks ZIP files.
Settings
| Name | Description | Default Value |
| antHome |
The home directory of the Ant distribution to use when
building the artifact
| C:/apache-ant-1.6.5 |
| javaHome |
The home directory of the JDK to use when building the
artifact
| C:/j2sdk1.5 |
Dependencies
| Name | Description | Allows Transient |
| files |
The ZIP files that should be unpacked.
| false |
Webapp
Assembles the standard Java application structure consisting of a
root directory with child etc, lib and classes directories.
Settings
| Name | Description | Default Value |
| antHome |
The home directory of the Ant distribution to use when
building the artifact
| C:/apache-ant-1.6.2 |
| javaHome |
The home directory of the JDK to use when building the
artifact
| C:/j2sdk1.4.1_01 |
Dependencies
| Name | Description | Allows Transient |
| lib |
All JAR files supplied as this dependency are placed in the
lib directory of the assembled application.
| true |
| classes |
All class files supplied as this dependency are placed in the
classes directory of the assembled application.
| true |
| etc |
All files supplied in this dependency are placed in the root
directory of the assembled application.
| true |
ZipFile
Packages a directory tree up as a ZIP file.
Settings
| Name | Description | Default Value |
| antHome |
The home directory of the Ant distribution to use when
building the artifact
| C:/apache-ant-1.6.5 |
| javaHome |
The home directory of the JDK to use when building the
artifact
| C:/j2sdk1.5 |
| zipFilename |
The name to give to the created ZIP file.
| output.zip |
Dependencies
| Name | Description | Allows Transient |
| files |
The files that should be packaged up as a ZIP file.
| false |
External Dependencies
AntProjekt
Produces an artifact through an external Ant script that can reside
on any accessible file system.
The two main uses for this producer are to build and import a
cross-component or cross-projekt dependency that is built through
Ant, or to augment the Krypton build of the local component with a
normal Ant build script.
This producer has settings for ANT_HOME and JAVA_HOME so that you can
execute the build with the suitable environment.
The directory setting specifies the base directory for the Ant-built
projekt, and the antScript setting specifies the filename of the
Ant script. The antTarget setting specifies the target to invoke
within that script.
After the build is complete, this producer imports the artifact
specified in the path setting into the local Krypton build.
Settings
| Name | Description | Default Value |
| antHome |
The home directory of the Ant distribution that should be
used to execute the Ant script.
| todo |
| javaHome |
The home directory of the Java SDK that should be used when
running Ant.
| todo |
| directory |
The directory where the Ant projekt resides.
| todo |
| antScript |
The filename of the Ant script within the specified
directory
| todo |
| antTarget |
The target to build from the specified antScript.
| todo |
| path |
The path to the artifact directory that should be imported
into the Krypton-managed build upon successful completion
of the Ant script.
| todo |
Dependencies
| Name | Description | Allows Transient |
| (none) |
KryptonProjekt
Produces an artifact from another Krypton-based projekt that can
reside on any accessible file system.
The target projekt is executed by the same instance of Krypton as the
source projekt.
Settings
| Name | Description | Default Value |
| projektFile |
The Krypton projekt file.
| todo |
| artifact |
The artifact to be built out of the target projekt
| todo |
Dependencies
| Name | Description | Allows Transient |
| (none) |
Maven2RepoArtifact
Retrieves an artifact from a Maven local or remote repository.
Internally, this producer uses the Maven 2 Ant tasks, so it has the
full capabilities of Maven including transitive dependency
resolution.
Should you want to simply grab a JAR from a repository without the
administrative overhead of Maven POM's, and if you don't require
Maven's transitive dependency resolution, then you might find the
SimpleMavenRepoArtifact producer more suited to your needs.
Settings
| Name | Description | Default Value |
| antHome |
The home directory of the Ant distribution to use when
building the artifact
| C:/apache-ant-1.6.2 |
| javaHome |
The home directory of the JDK to use when building the
artifact
| C:/j2sdk1.4.1_01 |
| remoteRepository |
The URL of the remote Maven repository to use when retrieving
artifacts. E.g: http://www.ibiblio.org/maven2
| |
| localRepository |
The path to the local repository to use when retrieving
artifacts. E.g: C:/MyRepo
| |
| groupId |
The group who published the artifact.
| |
| artifactId |
The artifact's unique name. E.g: log4j.
| |
| version |
The particular version of the artifact that should be
retrieved.
| |
| type |
The type of the artifact.
| jar |
Dependencies
| Name | Description | Allows Transient |
| (none) |
SimpleMaven1RepoArtifact
Performs a simple retrieval of the specified artifact from the
configured local / remote Maven 1.x repositories. Provides a simple
alternative to the full MavenRepoArtifact producer which is
POM-aware, and can perform transitive dependency resolution.
Settings
| Name | Description | Default Value |
| antHome |
The home directory of the Ant distribution to use when
building the artifact
| C:/apache-ant-1.6.2 |
| javaHome |
The home directory of the JDK to use when building the
artifact
| C:/j2sdk1.4.1_01 |
| remoteRepository |
The URL of the remote Maven repository to use when retrieving
artifacts. E.g: http://www.ibiblio.org/maven2
| |
| localRepository |
The path to the local repository to use when retrieving
artifacts. E.g: C:/MyRepo
| |
| artifactId |
The artifact's unique name. E.g: log4j.
| |
| version |
The particular version of the artifact that should be
retrieved.
| |
| type |
The type of the artifact. E.g: jar
| |
Dependencies
| Name | Description | Allows Transient |
| (none) |
Java Unit Testing
JUnitReport
Executes a suite of JUnit-based automated tests to produce a
HTML-formatted report.
Currently not functional due to yet to be resolved ClassLoader
problems.
Settings
| Name | Description | Default Value |
| antHome |
The home directory of the Ant distribution to use when
building the artifact
| C:/apache-ant-1.6.2 |
| javaHome |
The home directory of the JDK to use when building the
artifact
| C:/j2sdk1.4.1_01 |
Dependencies
| Name | Description | Allows Transient |
| app |
The application to test. This should include both the core
classes under test and the test classes.
| false |
| testjava |
The Java code for the test classes that will be exercised by
JUnit. This is required so that JUnit can examine the
code annotations and figure out what to run.
| false |
TestNgReport
Executes a suite of TestNG-based automated tests to produce a
HTML-formatted report.
Settings
| Name | Description | Default Value |
| antHome |
The home directory of the Ant distribution to use when
building the artifact
| C:/apache-ant-1.6.2 |
| javaHome |
The home directory of the JDK to use when building the
artifact
| C:/j2sdk1.4.1_01 |
Dependencies
| Name | Description | Allows Transient |
| app |
The application to test. This should include both the core
classes under test and the test classes.
| false |
| testjava |
The Java code for the test classes that will be exercised by
TestNG. This is required so that TestNG can examine the
code annotations and figure out what to run.
| false |
Miscellaneous
Echo
Echoes the supplied message. More for simple testing of Krypton than
for use in real projekts
Settings
| Name | Description | Default Value |
| antHome |
The home directory of the Ant distribution to use when
building the artifact
| C:/apache-ant-1.6.2 |
| javaHome |
The home directory of the JDK to use when building the
artifact
| C:/j2sdk1.4.1_01 |
| message |
The message that will be echoed back to the user
| (no message supplied) |
Dependencies
| Name | Description | Allows Transient |
| (none) |
Web
Site
Builds a projekt website which can include:
- Pre-built HTML pages and other web resources
- HTML pages generated from DocBook articles and / or Apache
XDoc articles
For pages generated from DocBook or Apache XDoc, you can specify a
site index document which is rendered as a nav bar.
Settings
| Name | Description | Default Value |
| antHome |
The home directory of the Ant distribution to use when
building the artifact
| C:/apache-ant-1.6.2 |
| javaHome |
The home directory of the JDK to use when building the
artifact
| C:/j2sdk1.4.1_01 |
| sitecontext |
The filename of the sitecontext file to look for within the
sitecontext dependency.
| sitecontext.xml |
| resPath |
The path to include CSS files and other resources from in
generated pages. To change the look and feel, specify a
different resource path
| |
Dependencies
| Name | Description | Allows Transient |
| web |
This dependency can be used to provide pre-built HTML pages
or other static web resources such as image files and CSS
stylesheets that should be incorporated in the assembled
website.
| true |
| skin |
The skin files (CSS, images and other resources) that should
also be added to the web site. The Site producer will look
for CSS stylesheets in the skin dependency, and
automatically import all stylesheets found into each
page.
TODO: Implement this feature once the scriptdef issue is
sorted out. Also then retire the resPath setting which will
then be obsolete.
| false |
| docbook |
Used to supply DocBook articles for transformation into HTML.
The same directory structure that articles are provided in
is applied to the HTML output.
| false |
| docbookxsl |
Can be used to supply an alternative set of DocBook XSLT
stylesheets for transforming DocBook article's to HTML. If
this dependency is not supplied, the producer will use it's
own internal stylesheet.
The item supplied on this dependency must contain a file
called artifact.xsl.
| false |
| xdoc |
Used to supply Apache XDoc articles for transformation into
HTML. The same directory structure that articles are
provided in is applied to the HTML output.
| false |
| xdocxsl |
Used to supply an alternative set of Apache XDoc XSLT
stylesheets for transforming XDoc article's to HTML. If
this dependency is not supplied, the producer will use it's
own internal stylesheet.
The item supplied on this dependency must contain a file
called xdoc.xsl.
| false |
| sitecontext |
Must contain the sitecontext file that is used to create a
navigation bar in HTML generated from DocBook or XDoc
articles.
Note that you also need to specify the name of the file to
look for within this dependency on the
index setting.
| false |
| sitexsl |
Used to supply an alternative set of XSLT stylesheets for
rendering wrapped DocBook and XDoc articles as pages. These
stylesheets create the outer framing, such as the header,
footer and the navbar. The site XSLT templates delegate to
the DocBook and XDoc stylsheets to produce HTML from those
article types.
| false |
Executors
JavaAppRunner
Settings
| Name | Description | Default Value |
| antHome | | C:/apache-ant-1.6.2 |
| javaHome | | C:/j2sdk1.4.1_01 |
| antScript | | /apprunner_build.xml |
| antTarget | | apprunner |
| className | | Main |
ScpUploader
Settings
| Name | Description | Default Value |
| antHome | | C:/apache-ant-1.6.2 |
| javaHome | | C:/j2sdk1.4.1_01 |
| antScript | | /apprunner_build.xml |
| antTarget | | apprunner |
| host | | host |
| username | | username |
| keyfile | | keyfile |
| passphrase | | passphrase |
| todir | | todir |
| trust | | false |
WebAppTomcatDeployer
Settings
| Name | Description | Default Value |
| antHome | | C:/apache-ant-1.6.2 |
| javaHome | | C:/j2sdk1.4.1_01 |
| antScript | | /plugin_build.xml |
| antTarget | | main |
| tomcatManagerUrl | | http://localhost:8080/manager |
| tomcatManagerUsername | | todo |
| tomcatManagerPassword | | todo |
| webappContext | | /todo |
WebAppTomcatUndeployer
Settings
| Name | Description | Default Value |
| antHome | | C:/apache-ant-1.6.2 |
| javaHome | | C:/j2sdk1.4.1_01 |
| antScript | | /plugin_build.xml |
| antTarget | | main |
| tomcatManagerUrl | | http://localhost:8080/manager |
| tomcatManagerUsername | | todo |
| tomcatManagerPassword | | todo |
| webappContext | | /todo |
