Class BorlandGenerateClient

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.tools.ant.taskdefs.optional.ejb.BorlandGenerateClient

All Implemented Interfaces:

Cloneable

public class BorlandGenerateClient
extends Task

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

Fields inherited from class Task

target, taskName, taskType, wrapper

Modifier and Type	Field	Description
protected Target	target	Deprecated. since 1.6.x.
protected String	taskName	Deprecated. since 1.6.x.
protected String	taskType	Deprecated. since 1.6.x.
protected RuntimeConfigurable	wrapper	Deprecated. since 1.6.x.

Fields inherited from class ProjectComponent

description, location, project

Modifier and Type	Field	Description
protected String	description	Deprecated. since 1.6.x.
protected Location	location	Deprecated. since 1.6.x.
protected Project	project	Deprecated. since 1.6.x.

Constructor Summary

Constructors

Constructor	Description
BorlandGenerateClient()

Method Summary

Modifier and Type	Method	Description
Path	createClasspath()	Adds path to the classpath.
void	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.
void	setClasspath(Path classpath)	Path to use for classpath.
void	setClasspathRef(Reference r)	Reference to existing path, to use as a classpath.
void	setClientjar(File clientjar)	Client JAR file name.
void	setDebug(boolean debug)	If true, turn on the debug mode for each of the Borland tools launched.
void	setEjbjar(File ejbfile)	EJB JAR file.
void	setMode(String s)	Command launching mode: java or fork.
void	setVersion(int version)	Set the version attribute.

Methods inherited from class Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Modifier and Type	Method	Description
final void	bindToOwner(Task owner)	Bind a task to another; use this when configuring a newly created task to do work on behalf of another.
Target	getOwningTarget()	Returns the container target of this task.
RuntimeConfigurable	getRuntimeConfigurableWrapper()	Returns the wrapper used for runtime configuration.
String	getTaskName()	Returns the name to use in logging messages.
String	getTaskType()	Return the type of task.
protected RuntimeConfigurable	getWrapper()	Return the runtime configurable structure for this task.
protected void	handleErrorFlush(String output)	Handles an error line by logging it with the WARN priority.
protected void	handleErrorOutput(String output)	Handles an error output by logging it with the WARN priority.
protected void	handleFlush(String output)	Handles output by logging it with the INFO priority.
protected int	handleInput(byte[] buffer, int offset, int length)	Handle an input request by this task.
protected void	handleOutput(String output)	Handles output by logging it with the INFO priority.
void	init()	Called by the project to let the task initialize properly.
protected final boolean	isInvalid()	Has this task been marked invalid?
void	log(String msg)	Logs a message with the default (INFO) priority.
void	log(String msg, int msgLevel)	Logs a message with the given priority.
void	log(String msg, Throwable t, int msgLevel)	Logs a message with the given priority.
void	log(Throwable t, int msgLevel)	Logs a message with the given priority.
void	maybeConfigure()	Configures this task - if it hasn't been done already.
final void	perform()	Performs this task if it's still valid, or gets a replacement version and performs that otherwise.
void	reconfigure()	Force the task to be reconfigured from its RuntimeConfigurable.
void	setOwningTarget(Target target)	Sets the target container of this task.
void	setRuntimeConfigurableWrapper(RuntimeConfigurable wrapper)	Sets the wrapper to be used for runtime configuration.
void	setTaskName(String name)	Sets the name to use in logging messages.
void	setTaskType(String type)	Sets the name with which the task has been invoked.

Methods inherited from class ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Modifier and Type	Method	Description
Object	clone()
String	getDescription()	Returns the description of the current action.
Location	getLocation()	Returns the file/location where this task was defined.
Project	getProject()	Returns the project to which this component belongs.
void	setDescription(String desc)	Sets a description of the current action.
void	setLocation(Location location)	Sets the file/location where this task was defined.
void	setProject(Project project)	Sets the project object of this component.

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BorlandGenerateClient

public BorlandGenerateClient()

Method Details

setVersion

public void setVersion(int version)

Set the version attribute.

Parameters:

version - the value to use.

setMode

public void setMode(String s)

Command launching mode: java or fork.

Parameters:

s - the mode to use.

setDebug

public void setDebug(boolean debug)

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

Parameters:

debug - a boolean value.

setEjbjar

public void setEjbjar(File ejbfile)

EJB JAR file.

Parameters:

ejbfile - the file to use.

setClientjar

public void setClientjar(File clientjar)

Client JAR file name.

Parameters:

clientjar - the file to use.

setClasspath

public void setClasspath(Path classpath)

Path to use for classpath.

Parameters:

classpath - the path to use.

createClasspath

public Path createClasspath()

Adds path to the classpath.

Returns:

a path to be configured as a nested element.

setClasspathRef

public void setClasspathRef(Reference r)

Reference to existing path, to use as a classpath.

Parameters:

r - the reference to use.

execute

public void execute()
             throws BuildException

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

Overrides:

execute in class Task

Throws:

BuildException - if something goes wrong with the build

executeJava

protected void executeJava()
                    throws BuildException

launch the generate client using java api.

Throws:

BuildException - if there is an error.

executeFork

protected void executeFork()
                    throws BuildException

launch the generate client using system api.

Throws:

BuildException - if there is an error.

executeForkV4

protected void executeForkV4()
                      throws BuildException

launch the generate client using system api.

Throws:

BuildException - if there is an error.

executeForkV5

protected void executeForkV5()
                      throws BuildException

launch the generate client using system api.

Throws:

BuildException - if there is an error.