Top Description Fields Constructors Methods
org.apache.tools.ant.taskdefs.optional.ejb

public Class BorlandGenerateClient

extends Task
Class Inheritance
Imports
java.io.File, org.apache.tools.ant.BuildException, .Project, .Task, org.apache.tools.ant.taskdefs.ExecTask, .Java, org.apache.tools.ant.types.Path, .Reference

Generates a Borland Application Server 4.5 client JAR using as input the EJB JAR file. Two mode are available: java mode (default) and fork mode. With the fork mode, it is impossible to add classpath to the command line.

Field Summary

Modifier and TypeField and Description
pack-priv Path
classpath

hold the classpath

pack-priv File
clientjarfile

hold the client jar file name

pack-priv boolean
debug

debug the generateclient task

pack-priv File
ejbjarfile

hold the ejbjar file name

pack-priv static final String
pack-priv static final String
pack-priv String
mode

hold the mode (java|fork)

pack-priv int
version

hold the version

Inherited from org.apache.tools.ant.Task:
targettaskNametaskTypewrapper

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public Path

Returns:

a path to be configured as a nested element.
createClasspath
()

Adds path to the classpath.

public void
execute()

Overrides org.apache.tools.ant.Task.execute.

Do the work.
protected void
executeFork()

launch the generate client using system api.

protected void
executeForkV4()

launch the generate client using system api.

protected void
executeForkV5()

launch the generate client using system api.

protected void
executeJava()

launch the generate client using java api.

public void
setClasspath(Path
the path to use.
classpath
)

Path to use for classpath.

public void
setClasspathRef(Reference
the reference to use.
r
)

Reference to existing path, to use as a classpath.

public void
setClientjar(File
the file to use.
clientjar
)

Client JAR file name.

public void
setDebug(boolean
a boolean value.
debug
)

If true, turn on the debug mode for each of the Borland tools launched.

public void
setEjbjar(File
the file to use.
ejbfile
)

EJB JAR file.

public void
setMode(String
the mode to use.
s
)

Command launching mode: java or fork.

public void
setVersion(int
the value to use.
version
)

Set the version attribute.

Inherited from org.apache.tools.ant.Task:
bindToOwnergetOwningTargetgetRuntimeConfigurableWrappergetTaskNamegetTaskTypegetWrapperhandleErrorFlushhandleErrorOutputhandleFlushhandleInputhandleOutputinitisInvalidloglogloglogmaybeConfigureperformreconfiguresetOwningTargetsetRuntimeConfigurableWrappersetTaskNamesetTaskType

Field Detail

classpathback to summary
pack-priv Path classpath

hold the classpath

clientjarfileback to summary
pack-priv File clientjarfile

hold the client jar file name

debugback to summary
pack-priv boolean debug

debug the generateclient task

ejbjarfileback to summary
pack-priv File ejbjarfile

hold the ejbjar file name

FORK_MODEback to summary
pack-priv static final String FORK_MODE
JAVA_MODEback to summary
pack-priv static final String JAVA_MODE
modeback to summary
pack-priv String mode

hold the mode (java|fork)

versionback to summary
pack-priv int version

hold the version

Constructor Detail

BorlandGenerateClientback to summary
public BorlandGenerateClient()

Method Detail

createClasspathback to summary
public Path createClasspath()

Adds path to the classpath.

Returns:Path

a path to be configured as a nested element.

executeback to summary
public void execute() throws BuildException

Overrides org.apache.tools.ant.Task.execute.

Do the work. The work is actually done by creating a separate JVM to run a java task.

Annotations
@Override
Exceptions
BuildException:
if something goes wrong with the build
executeForkback to summary
protected void executeFork() throws BuildException

launch the generate client using system api.

Exceptions
BuildException:
if there is an error.
executeForkV4back to summary
protected void executeForkV4() throws BuildException

launch the generate client using system api.

Exceptions
BuildException:
if there is an error.
executeForkV5back to summary
protected void executeForkV5() throws BuildException

launch the generate client using system api.

Exceptions
BuildException:
if there is an error.
executeJavaback to summary
protected void executeJava() throws BuildException

launch the generate client using java api.

Exceptions
BuildException:
if there is an error.
setClasspathback to summary
public void setClasspath(Path classpath)

Path to use for classpath.

Parameters
classpath:Path

the path to use.

setClasspathRefback to summary
public void setClasspathRef(Reference r)

Reference to existing path, to use as a classpath.

Parameters
r:Reference

the reference to use.

setClientjarback to summary
public void setClientjar(File clientjar)

Client JAR file name.

Parameters
clientjar:File

the file to use.

setDebugback to summary
public void setDebug(boolean debug)

If true, turn on the debug mode for each of the Borland tools launched.

Parameters
debug:boolean

a boolean value.

setEjbjarback to summary
public void setEjbjar(File ejbfile)

EJB JAR file.

Parameters
ejbfile:File

the file to use.

setModeback to summary
public void setMode(String s)

Command launching mode: java or fork.

Parameters
s:String

the mode to use.

setVersionback to summary
public void setVersion(int version)

Set the version attribute.

Parameters
version:int

the value to use.