org.eclipse.hyades.automation.client.adapters.ant
Class AutomationClientAdapter.Automation

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          org.eclipse.hyades.automation.client.adapters.ant.AutomationClientAdapter.Automation

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

AutomationClientAdapter.Execution, AutomationClientAdapter.Extraction, AutomationClientAdapter.Interrogation, AutomationClientAdapter.Publication, AutomationClientAdapter.Verification

Enclosing class:

AutomationClientAdapter

public static class AutomationClientAdapter.Automation

extends org.apache.tools.ant.Task

This ant task is a general TPTP ant task used to request the execution of published automatable TPTP services. A TPTP automatable service is published via the implementation of specific automation-related plug-in extension points and must implement automation-related Java interfaces as well.

Field Summary

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

target, taskName, taskType, wrapper

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

description, location, project

Constructor Summary

AutomationClientAdapter.Automation()

Method Summary

void	addConfiguredProperty(org.apache.tools.ant.taskdefs.Property property) Add the configured property to the properties
void	addProperty(java.lang.String name, boolean value) Add property to the list with the given name and value
void	addProperty(java.lang.String name, java.io.File file) Add the property with the given name and associated file value
void	addProperty(java.lang.String name, org.apache.tools.ant.types.Path path) Add the given named value with the value as a path
void	addProperty(java.lang.String name, java.lang.String value) Add the given named value property to the properties
void	appendFilelists(java.util.List resultList, java.util.Vector filelists)
void	appendFilelists(java.util.List resultList, java.util.Vector filelists, boolean absolutize)
void	appendFilesets(java.util.List resultList, java.util.Vector filesets)
void	appendFilesets(java.util.List resultList, java.util.Vector filesets, boolean absolutize)
void	execute()
java.lang.Object	getFromProperties(java.lang.String name) Add the given object to the properties hashmap
java.lang.String	getProperty(java.lang.String name) Retrieve the specified property's value
void	init()
void	putToProperties(java.lang.String name, java.lang.Object value) Add the given object to the properties hashmap
void	setCommand(java.lang.String command) Set the automation command to use
void	setIterations(int iterations) The number of iterations to execute this command
void	setQuiet(boolean quiet) Sets quiet mode on or off, quiet reduces chatter to the absolute minimum as defined by a particular service
void	setService(java.lang.String service) Identifies the service to invoke
void	setSynchronicity(AutomationClientAdapter.Synchronicity synchronicity) Set the synchronicity setting for this task instance
void	setVmArgs(java.lang.String vmargs) Set the VM arguments for the instance of the VM that will host the service

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

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

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AutomationClientAdapter.Automation

public AutomationClientAdapter.Automation()

Method Detail

addConfiguredProperty

public void addConfiguredProperty(org.apache.tools.ant.taskdefs.Property property)

Add the configured property to the properties

Parameters:

property - the property to add

addProperty

public void addProperty(java.lang.String name,
                        boolean value)

Add property to the list with the given name and value

Parameters:

name - name of the property

value - value of the property

addProperty

public void addProperty(java.lang.String name,
                        java.io.File file)

Add the property with the given name and associated file value

Parameters:

name - the name of the property

file - the value of the file, will be rendered to string

addProperty

public void addProperty(java.lang.String name,
                        org.apache.tools.ant.types.Path path)

Add the given named value with the value as a path

Parameters:

name - the name of the value

path - the value as a path, to be used for things like system paths or classpaths, standard ant path

addProperty

public void addProperty(java.lang.String name,
                        java.lang.String value)

Add the given named value property to the properties

Parameters:

name - the name of the value

value - the value

putToProperties

public void putToProperties(java.lang.String name,
                            java.lang.Object value)

Add the given object to the properties hashmap

getFromProperties

public java.lang.Object getFromProperties(java.lang.String name)

Add the given object to the properties hashmap

appendFilesets

public void appendFilesets(java.util.List resultList,
                           java.util.Vector filesets)

appendFilelists

public void appendFilelists(java.util.List resultList,
                            java.util.Vector filelists)

appendFilesets

public void appendFilesets(java.util.List resultList,
                           java.util.Vector filesets,
                           boolean absolutize)

Parameters:

absolutize -

appendFilelists

public void appendFilelists(java.util.List resultList,
                            java.util.Vector filelists,
                            boolean absolutize)

Parameters:

absolutize -

execute

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

Throws:

org.apache.tools.ant.BuildException

getProperty

public java.lang.String getProperty(java.lang.String name)

Retrieve the specified property's value

Parameters:

name - the name of the property to return the value of

Returns:

the property value

init

public void init()

setCommand

public void setCommand(java.lang.String command)

Set the automation command to use

Parameters:

command - the automation command, currently only execute is supported

setIterations

public void setIterations(int iterations)

The number of iterations to execute this command

Parameters:

iterations - the number of iterations from 1 to many

setQuiet

public void setQuiet(boolean quiet)

Sets quiet mode on or off, quiet reduces chatter to the absolute minimum as defined by a particular service

Parameters:

quiet - used to turn quiet mode on or off (true or false)

setService

public void setService(java.lang.String service)

Identifies the service to invoke

Parameters:

service - the service identifier, which matches the extension point id in the implementor within Eclipse

setSynchronicity

public void setSynchronicity(AutomationClientAdapter.Synchronicity synchronicity)

Set the synchronicity setting for this task instance

Parameters:

synchronicity - indicating blocking or non-blocking execution

setVmArgs

public void setVmArgs(java.lang.String vmargs)

Set the VM arguments for the instance of the VM that will host the service