Version 5.3.1	SEARCH   CONTENTS   |   PDF PAGE   PDF BOOKS   |   HOME   UP   PREV   NEXT

Ant is a scripting language you can use to automate the building process for Java code. Ant is written in XML. Within an Ant script, you define a target. Each target contains a set of tasks. Some of the standard Ant tasks include:

• Get latest version from source control

• Compile the source code

• Create jar (Java archive) files

For example:

<Project name=”sample project”>
  <target name=”build”>
       <cvs … >   <!—get latest version 
       <javac …  > <!—compile the source code 
   </target>
</Project>

Natural Business Services includes several custom Ant tasks. These tasks help generate and deploy Java classes based on business services created on the server.

Prerequisites

The custom Ant tasks provided with Natural Business Services require the following prerequisites:

• Ant 1.6

• The following .jar files on the class path:

  • junit-4.3.1.jar

  • entirex.jar

  • nbsrt4j.jar

  • ndvserveraccess.jar

  • nbsAnt.jar

  • velocity-dep-1.4.jar

  • nbs.ui.jar

• CentraSite .jar file(s)

  This file(s) is only required if deploying to CentraSite.

Global Properties

The custom Ant tasks use the following global properties. These properties must be set using the Property node in Ant:

Supplied Ant Tasks

This section describes the Ant tasks supplied with Natural Business Services. All tasks are located in the com.softwareag.nbs.ant.tasks package.

The supplied Ant tasks are:

• Axis2Deploy

• CentraSiteRegister

• CreateAAR

• CreateClass

• PrintConfig

• Regenerate

Axis2Deploy

This task deploys an Axis2 Web service archive file (.aar) to an Axis2 web application server. The attributes for this task are:

CentraSiteRegister

This task registers a Web service with CentraSite. The attributes for this task are:

CreateAAR

This task creates a Web service archive file (.aar) for deployment to Axis2. The attributes for this task are:

Child Nodes

CreateClass

This task creates a Java class based on a business service on the server.

Note:
If the webservice attribute is set to true, the CreateClass task will not generate the .aar file because the Java code has not yet been compiled. Use the CreateAAR task instead.

The attributes for this task are:

Child Nodes

PrintConfig

This task prints a copy of the configuration settings used by Natural Business Services. The following example shows output from this task:

[nbs.printconfig] Configuration
[nbs.printconfig] Configuration File: S:/NBS52/Runtime/DispatchClient.config
[nbs.printconfig] ConnectionID: 52-NEW-DEV
[nbs.printconfig] User ID: DEV
[nbs.printconfig] Password: ****
[nbs.printconfig] Templates: S:\NBS52\Java\Workspace3.3\com.softwareag.nbs.ui\templates

Regenerate

This task regenerates files created by the CreateClass task. The attributes for this task are:

Child Nodes

Child Node Types

This section describes the Child node types for the Ant tasks supplied with Natural Business Services. All node types are located in the com.softwareag.nbs.ant package.

The Child node types are:

• ServerChange

• ServiceSet

• WebService

ServerChange

This task uses filtering criteria (such as domain, user ID, and date) to search the Natural Business Services log file on the server and find any changes to business services.

Note:
All purge changes are ignored because you cannot generate a class for a business service that has been purged.

The attributes for this task are:

[count][interval]

ServiceSet

This task lists the business services available for the specified connection ID and domain. The attributes for this task are:

Note:
If the includepattern and excludepattern attributes are both specified, includepattern will be applied before excludepattern.

WebService

This task specifies an Axis Web service. The attributes for this task are:

Example of Using Custom Ant Tasks

The following XML example demonstrates the use of custom Ant tasks supplied with Natural Business Services:

<?xml version="1.0" ?> 
- <project name="Test" default="build" basedir=".">
- <!-- 
 TODO: change the below path to match your nbs installation folder
  --> 
  <property name="nbs.install" value="C:\Program Files\Software AG\Natural Business Services\V5.3\" /> 
- <!-- 
 TODO: Modify the below settings to match your configuration 
  --> 
- <target name="init">
  <property name="nbs.userID" value="GUEST" /> 
  <property name="nbs.connectionID" value="Default Broker" /> 
  <property name="nbs.password" value="" /> 
  <property name="nbs.config.location" value="${nbs.install}\dispatchclient.config" /> 
  <property name="nbs.target.jvm" value="1.4" /> 
  <property name="nbs.templates" value="${nbs.install}\templates\java" /> 
  </target>
- <!-- 
 jars to be used while ant is running 
  --> 
- <path id="runtimeJars">
- <fileset dir="${nbs.install}\javaruntime">
  <include name="*.jar" /> 
  </fileset>
- <fileset dir="${nbs.install}\EclipsePlugin\plugins">
  <include name="com.softwareag.nbs.ui_*.jar" /> 
  </fileset>
  </path>
- <!-- 
 jars to be used by the compiler 
  --> 
- <path id="compileJars">
- <fileset dir="${nbs.install}\javaruntime">
  <include name="*.jar" /> 
  </fileset>
  </path>
- <!-- 
 NBS Task definitions 
  -->  
  <taskdef classname="com.softwareag.nbs.ant.tasks.Test" name="nbstest" classpathref="runtimeJars" loaderref="NBSRef" /> 
  <taskdef classname="com.softwareag.nbs.ant.tasks.CreateClass" classpathref="runtimeJars" name="nbs.createclass" loaderref="NBSRef" /> 
  <taskdef classname="com.softwareag.nbs.ant.tasks.Regenerate" name="nbs.regenerate" classpathref="runtimeJars" loaderref="NBSRef" /> 
  <taskdef classname="com.softwareag.nbs.ant.tasks.CreateAAR" name="nbs.createaar" classpathref="runtimeJars" loaderref="NBSRef" /> 
  <taskdef classname="com.softwareag.nbs.ant.tasks.Axis2Deploy" name="nbs.axis2deploy" classpathref="runtimeJars" loaderref="NBSRef" /> 
  <taskdef classname="com.softwareag.nbs.ant.tasks.CentraSiteRegister" name="nbs.centrasite" classpathref="runtimeJars" loaderref="NBSRef" /> 
- <!-- 
 NBS Type definitions 
  --> 
  <typedef name="serviceset" classname="com.softwareag.nbs.ant.ServiceSet" classpathref="runtimeJars" loaderref="NBSRef" /> 
  <typedef name="serverchange" classname="com.softwareag.nbs.ant.ServerChange" classpathref="runtimeJars" loaderref="NBSRef" /> 
  <typedef name="webservice" classname="com.softwareag.nbs.ant.WebService" classpathref="runtimeJars" loaderref="NBSRef" /> 
- <target name="build" depends="init">
- <!-- 
 Sample create class 
  --> 
- <nbs.createclass destdir="c:\temp\root\src" metadir="c:\temp\root\.metadata" domain="DEMO" servicename="product" version="1.1.1" package="ant1.ant2" junit="true" webservice="true" axisversion="2">
  <serviceset domain="DEMO" includePattern="Calc.*" /> 
  <serverchange duration="1y" userid="PWRUSR" domain="DEMO" /> 
  </nbs.createclass>
- <!-- 
 Sample regenerate 
  --> 
- <nbs.regenerate destdir="c:\temp\root\src" metadir="c:\temp\root\.metadata">
- <fileset dir="c:\temp\root\src" casesensitive="false">
  <include name="**/*.java" /> 
  </fileset>
  </nbs.regenerate>
- <!-- 
 Compile the above generated classes 
  --> 
  <mkdir dir="c:\temp\bin" /> 
  <javac executable="C:\Program Files\Java\jdk1.5.0_11\bin\javac.exe" fork="true" classpathref="compileJars" compiler="javac1.5" destdir="c:\temp\bin" srcdir="c:\temp\root\src" /> 
  </target>
  </project>

www.softwareag.com

Copyright © 2006-2010 Software AG, Darmstadt, Germany.

SEARCH   CONTENTS   |   PDF PAGE   PDF BOOKS   |   HOME   UP   PREV   NEXT