The Bean Generator provides a utility to generate Java classes conforming to the Java Bean conventions. The utility requires two pieces of information to generate a Java Bean(s).

The toolbox.services package simplifies the development of coarse grained services capable of exposing logic at various levels. The Service Generator is capable of generating toolbox.services implementation classes and configuration that is ready to be exposed as an API or Web Services. The utility can be invoked using the servicegen script located in the bin directory of the Toolbox distribution. The command has the following synopsis:

The Toolbox APIs provide various classes and interfaces to develop applications and utilities. Most of these API's require some form of configuration to achieve the desired outcome. The configurations are based in XML and Java properties. The process of setting up the initial configurations for an application or utility can be tedious and error prone. For this reason the Toolbox provides a utility that can generate the initial configuration for the desired Toolbox API's.

The Configuration Generator contains a module for each type of configuration it supports. Each module is associated with a default FreeMarker template that is responsible for rendering the desired configuration. The default templates can be changed to accomodate different environments and settings.

The utility has the following command synopsis and can be invoked using the confgen script located in the bin directory of the Toolbox distribution.

When developing source code, developers create a source tree, or file system, to store and organise the application source code, configuration and documentation. The dirgen utility is a simple script that generates a very generic directory structure that can be used as an initial source tree. The source tree does not resemble a specific deployment structure like WAR or EAR. This keeps the source code independent of it's deployment platform, making the source tree adaptable to any assembly and deployment scenario.

                            <myapp>
                               |
                  ----------------------------
                  |        |        |        |
                 doc      etc     htdocs   java
                           |
                 --------------------
                 |         |        |
               beans   resources  services
        

Follow these steps to successfully execute the dirgen utility:

Macro to create a war file that includes all the Toolbox specific configurations and directories. The following table contains all the attributes and elements supported by the macro. The default values of optional attributes make reference to ant macro properties.

Example

Use the following target definintion to create a war file with the name mywebapp.war and jars located in the directory java.

<target name="war" depends="tbmproperties">
  <tbwar warname="mywebapp">
    <webinflib>
      <fileset dir="java" includes="*.jar"/>
    </webinflib>
  </tbwar>
</target>
        

Macro to create a zip archive that contains a Toolbox application distribution. The application must be based on the Toolbox services API. The following table contains all the attributes and elements supported by the macro. The default values of optional attributes make reference to ant macro properties.

Example

Use the following target definintion to create a zip file with the name myapp.zip and jars located in the directory java.

<target name="app" depends="tbmproperties">
  <tbsvcapp appname="myapp">
    <applib>
      <fileset dir="java" includes="*.jar"/>
    </applib>
  </tbsvcapp>
</target>
        

Macro to perform clean up after the tbwar and tbsvcapp macros. It will delete the application zip file, war file and the ${dist} directory. The following table contains all the attributes and elements supported by the macro. The default values of optional attributes make reference to ant macro properties.

Example

Use the following target definintion to clean the build results of an application with a zip file named myapp.zip and a war file named mywebapp.war.

<target name="clean" depends="tbmproperties">
  <tbclean appname="myapp" warname="mywebapp"/>
</target>
        

Macro to perform Java compilations. The following table contains all the attributes and elements supported by the macro. The default values of optional attributes make reference to ant macro properties.

Example

Use the following target definition to compile the sources in the directory my/java/package

<target name="mypackage" depends="tbmproperties">
  <tbjavac srcdir="my/java/package"/>
</target>
        

Macro to create jar files. The following table contains all the attributes and elements supported by the macro. The default values of optional attributes make reference to ant macro properties.

Example

Use the following target definition to create a jar file named myapp.jar

<target name="jar" depends="tbmproperties">
  <tbjar jarfile="myapp.jar"/>
</target>
        

Macro to generate Javadoc API documentation. The following table contains all the attributes and elements supported by the macro. The default values of optional attributes make reference to ant macro properties.

Example

Use the following target definition to generate the API documentation for all packages in the current directory.

<target name="api-doc" depends="tbmproperties">
  <tbjavadoc windowtitle="My API Docs"
                doctitle="<h2>My API Docs</h2>"/>
</target>
        

Macro perform clean up after tbjavac, tbjar and tbjavadoc operations. The following table contains all the attributes and elements supported by the macro. The default values of optional attributes make reference to ant macro properties.

Example

Use the following target definition to perform clean up after compilation.

<target name="clean" depends="tbmproperties">
  <tbcompileclean jarfile="myapp.jar"/>
</target>
        

Macro to deploy a war to the Java Enterpise System Application Server 7. The following table contains all the attributes and elements supported by the macro. The default values of optional attributes make reference to ant macro properties.

Example

Use the following target definition to deploy a war file named mywebapp.war.

<target name="deploy" depends="tbmproperties">
  <tbjesas7wardeploy name="mywebapp" war="mywebapp.war"/>
</target>
        

Macro to deploy a war to the Java Enterpise System Application Server 8. The following table contains all the attributes and elements supported by the macro. The default values of optional attributes make reference to ant macro properties.

Example

Use the following target definition to deploy a war file named mywebapp.war.

<target name="deploy" depends="tbmproperties">
  <tbjesas8wardeploy name="mywebapp" war="mywebapp.war"/>
</target>
        

Macro to deploy a war to the Java Enterpise System Web Server. The following table contains all the attributes and elements supported by the macro. The default values of optional attributes make reference to ant macro properties.

Example

Use the following target definition to deploy a war file named mywebapp.war to the virtual server with id foo.com on the instance https-blah.com.

<target name="deploy" depends="tbmproperties">
  <tbjeswswardeploy context="mywebapp" 
                       wsintance="blah.com" 
                       wsvsid="foo.com" 
                       war="mywebapp.war"/>
</target>
        

Macro to deploy a war to a Tomcat 4 Servlet Container. The following table contains all the attributes and elements supported by the macro. The default values of optional attributes make reference to ant macro properties.

Example

Use the following target definition to deploy a war file named mywebapp.war.

<target name="deploy" depends="tbmproperties">
  <tbtomcat4wardeploy name="mywebapp" war="mywebapp.war"/>
</target>
        

Macro to perform DocBook XSL transformations using the Ant XSLT task. The following table contains all the attributes and elements supported by the macro. The default values of optional attributes make reference to ant macro properties.

Example

Use the following target definition to create a HTML file named out.html from an XML file named mydoc.xml.

<target name="doc" depends="tbmproperties">
  <tbdocbook in="mydoc.xml" out="out.html"/>
</target>
        

Macro to render the XHTML document type definition and html start and end tag. This macro does not support any parameters. This macro supports nested content. The entire template's content should be wrapped inside this macro.

Example

          <@xhtml.xhtml>
            <body>
              <p>Hello World</p>
            </body>
          </@xhtml.xhtml>
        

Macro to render the html head tag. This macro supports nested content. All html head related markup should be nested inside this macro. The following table contains a list of all the parameters supported by this macro.

Example

          <@xhtml.head title="My Page" style=/styles/mystyle.css"/>
        

Macro to render the html form tag. This macro supports nested content. All html form related markup should be nested inside this macro. The following table contains a list of all the parameters supported by this macro.

Example

          <@xhtml.form name="myform" 
                          action="action/url">
            .....

          </@xhtml.form>
        

Macro to render the html input tag. This macro does not support nested content. This macro should be used inside the form macro. The following table contains a list of all the parameters supported by this macro.

Example

          <@xhtml.form_input name="myinput" value="foo"/>
        

Macro to render the html textarea tag. This macro does not support nested content. This macro should be used inside the form macro. The following table contains a list of all the parameters supported by this macro.

Example

          <@xhtml.form_textarea name="mytext" value="foo"/>
        

Macro to render the html select tag with options. This macro does not support nested content. This macro should be used inside the form macro. The following table contains a list of all the parameters supported by this macro.

Example

          Given the following sequence of hashes: 

          optionSeq=[{"product":"prod1","productcode":"001"},
                     {"product":"prod2","productcode":"002"}]
         
          This template fragment:

          <@xhtml.form_select name="myselect" 
                                 options=optionSeq
                                 displaykey="product"
                                 valuekey="productcode"/>
 
          Will render the following html:

          <select id="myselect"
                     name="myselect"
                     class="">

            <option value="001">prod1</option>
            <option value="002">prod2</option>
          </select>
        

Macro to render the html submission input tags. This macro does not support nested content. This macro should be used inside the form macro. The following table contains a list of all the parameters supported by this macro.

Example

          <@xhtml.form_submit type="submit" value="Add"/>
        

Macro to render the html table tag with headers. This macro supports nested content. All table rows and columns must be nested inside this macro. The following table contains a list of all the parameters supported by this macro.

Example

          <@xhtml.table headers=["name","surname"] >
            ...
          </@xhtml.table>
        

Macro to render the html tr tag. This macro supports nested content. All table columns can be nested inside this macro. The following table contains a list of all the parameters supported by this macro.

Example

          <@xhtml.table_tr>
            ...
          </@xhtml.table_tr>
        

Macro to render the html td tag. This macro does not support nested content. The following table contains a list of all the parameters supported by this macro.

Example

          <@xhtml.table_td value="foo"/>
        

Macro to render an html paragraph to display a sequence of informational messages. This macro does not support nested content. The following table contains a list of all the parameters supported by this macro.

Example

          <@xhtml.messages req=request key="errors" heading=""/>