org.rhq.core.db.ant.dbupgrade

Class SST_JavaTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.rhq.core.db.ant.dbupgrade.SchemaSpecTask

org.rhq.core.db.ant.dbupgrade.SST_JavaTask

public class SST_JavaTask
extends SchemaSpecTask

Task that allows more complicated upgrade logic to be externalized into a Java class. The JavaTask must implement the DatabaseUpgradeTask interface, which will pass the active Connection and DatabaseType objects used by the main upgrader to it. Authors of JavaTasks are encouraged to use the helper methods provided by the DatabaseType object, which will help keep the implementation vendor agnostic with respect to the set of databases supported by DBUpgrader at the time it was written. Ant task to invoke an external JavaTask, which can perform arbitrarily DDL and DML against the database. This task accepts one required attribute:

• className

Author:

Joseph Marques

Field Summary

Fields inherited from class org.apache.tools.ant.Task

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

Constructors

Constructor and Description
SST_JavaTask()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Launches the DatabaseUpgradeTask defined by the className attribute, passing the Connection and DatabaseType from the main DBUpgrader.
void	setClassName(String className) Sets the name of the class that implements the DatabaseUpgradeTask interface.

Methods inherited from class org.rhq.core.db.ant.dbupgrade.SchemaSpecTask

getConnection, getDatabaseType, getDBSpecificTypeName, getIgnoreError, getNewConnection, getTargetDBVendor, getTargetDBVersion, initialize, isDBTargeted, isIgnoreError, setIgnoreError, setTargetDBVendor, setTargetDBVersion, translateSqlType

Methods inherited from class org.apache.tools.ant.Task

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

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, setProject

Methods inherited from class java.lang.Object

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

Constructor Detail

SST_JavaTask

public SST_JavaTask()

Method Detail

setClassName

public void setClassName(String className)

Sets the name of the class that implements the DatabaseUpgradeTask interface. If the name is not package-prefixed, the default "org.rhq.core.db.upgrade" will be assumed.

Parameters:

className -

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Launches the DatabaseUpgradeTask defined by the className attribute, passing the Connection and DatabaseType from the main DBUpgrader.

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException

See Also:

Task.execute()