com.gigaspaces.ant
Interface RemoteAnt

All Known Subinterfaces:

GSC

public interface RemoteAnt

Provides the capability to run Ant build files remotely. To this end the service provides the capability to run an Ant build file which is local to the service (accessible on the file system)remotely, or a build file that is remote. Using this capability, common administration, integration and potentially workflow oriented tasks can be submitted into the distributed environment, using Ant to automate the processing For more information on Ant, see http://ant.apache.org

Method Summary

boolean	abort(TaskDescriptor descriptor) Abort a running Ant task described by the TaskDescriptor.
TaskDescriptor[]	report() Get a report on all Ant tasks that were submitted
void	submit(TaskDescriptor descriptor) Submit an Ant task for processing.

Method Detail

submit

void submit(TaskDescriptor descriptor)
            throws java.rmi.RemoteException,
                   java.io.IOException

Submit an Ant task for processing. This method provide the capability to run an Ant build file remotely, by either processing a local (accessible on the service's file system) or remote Ant build file to the service.

Parameters:

descriptor - A TaskDescriptor to process

Throws:

java.lang.NullPointerException - If the descriptor parameter is null

java.rmi.RemoteException - If communication errors occur

java.io.IOException - If there are problems downloading or creating a temporary File from the TaskDescriptor attributes

report

TaskDescriptor[] report()
                        throws java.rmi.RemoteException

Get a report on all Ant tasks that were submitted

Returns:

An array of TaskDescriptor objects providing information on the Ant tasks that were submitted. A new array is allocated each time. If there are no processed tasks, return a zero length array

Throws:

java.rmi.RemoteException - If communication errors occur

abort

boolean abort(TaskDescriptor descriptor)
              throws java.rmi.RemoteException

Abort a running Ant task described by the TaskDescriptor. This method can only abort Ant tasks that have been submitted to run asynchronously

Parameters:

descriptor - A TaskDescriptor to abort

Returns:

If the Ant process has been aborted, return true, otherwise return false

Throws:

java.lang.NullPointerException - If the descriptor parameter is null

java.rmi.RemoteException - If communication errors occur