fi.techila.user

Interface Peach

public interface Peach

Peach Interface. Peach is intended to simply run an executable in the Techila system as many times parallel as needed.
Peach name is mandatory, it is used as bundle prefixes and to save the state file (<name>.state).
Before using Peach, the SDK library must be initialized properly.
After getting a Peach instance with a selected name, the configuration methods should be called, these are the set, add and put methods.
Usually at least setExecutable or addExeFile should be called. Also setJobs must be called, otherwise a project won't be created.
After Peach has been configured properly execute() can be called. With normal configurateion the execute method will create all bundles if required depending on the saved state. After the bundles are created it will create a project and start it.
To get the results nextFile() method will return the result files one per each call. If streaming is used the method will return with a file as soon as one is available, otherwise it will return when all results have been downloaded. When no more files are available nextFile returns null.
After everything is done the done() method must be called. This will clean up everything.

Method Summary

Modifier and Type	Method and Description
void	addDataFile(java.lang.String file) Add a file into the current data bundle.
void	addDataFile(java.lang.String file, java.lang.String targetName) Add a file into the current data bundle.
void	addDataFileWithDir(java.lang.String dir, java.lang.String file) Add a file from a directory into the current data bundle.
void	addExeFile(java.lang.String file) Add a file into the Executor bundle.
void	addExeFile(java.lang.String res, java.lang.String file) Add a file into the Executor bundle with given resource name.
void	addExeFile(java.lang.String res, java.lang.String file, java.lang.String osname) Add a file into the Executor bundle with given parameters.
void	addExeFile(java.lang.String res, java.lang.String file, java.lang.String osname, java.lang.String processor) Add a file into the Executor bundle with given parameters.
void	addExeImport(java.lang.String importName) Add an import for the Executor bundle.
void	addJobFile(java.lang.String... files) Add files to be included in the Job Input Bundle.
void	addJobFileWithDir(java.lang.String dir, java.lang.String... files) Add files from a directory to be included in the Job Input Bundle.
void	addOutputFile(java.lang.String def) Add an outpuf file definition, eg.
void	addParamExternalResource(java.lang.String res) Add External Resource to Parameter Bundle.
void	addParamFile(java.lang.String file) Add a file into the parameter bundle.
void	addParamFile(java.lang.String file, java.lang.String targetName) Add a file into the parameter bundle and specify target name.
void	addParamFileWithDir(java.lang.String dir, java.lang.String file) Add file into parameter bundle from a given directory.
void	addParamImport(java.lang.String importName) Add an import for the Parameter bundle.
void	addSourceFile(java.lang.String file) Add a source file.
void	done() Mark Peach call as done.
int	execute() Run the Peach.
java.lang.String	getLastErrorMessage()
java.lang.String	getParamBundleName() Get Name of the Parameter bundle.
int	getProjectHandle() Get the handle used for project commands.
int	getProjectId() Get the project ID of the current project.
void	newDataBundle() Start defining a new data bundle.
void	newDataBundle(java.lang.String name) Use a named databundle that already exists on the server...
java.lang.String	nextFile() Get the result file.
void	postProcessed(int count)
void	putAllDataExtras(java.util.Map<java.lang.String,java.lang.String> extras) Put all values of given Map into the data bundles extra parameters.
void	putAllExeExtras(java.util.Map<java.lang.String,java.lang.String> extras) Put all values of given Map into the Executor bundles extra parameters.
void	putAllJobExtras(java.util.Map<java.lang.String,java.lang.String> extras) Put all values of given Map into the Job Input Bundles extra parameters.
void	putAllParamExtras(java.util.Map<java.lang.String,java.lang.String> extras) Put all values of given Map into the parameters bundles extra parameters.
void	putAllProjectParams(java.util.Map<java.lang.String,java.lang.String> params) Put all values of a given Map into project parameters.
void	putAllSourceExtras(java.util.Map<java.lang.String,java.lang.String> extras) Put all values of given Map into the source bundles extra parameters.
void	putDataExtras(java.lang.String name, java.lang.String value) Put a value into the current data bundles extra parameters.
void	putExeExtras(java.lang.String name, java.lang.String value) Put a value into the Executor bundles extra parameters.
void	putJobExtras(java.lang.String name, java.lang.String value) Put a value into the Job Input Bundle extra parameters.
void	putParamExtras(java.lang.String name, java.lang.String value) Put a value into the parameter bundles extra parameters.
void	putProjectParam(java.lang.String name, java.lang.String value) Set a project parameter to a given value.
void	putSourceExtras(java.lang.String name, java.lang.String value) Store source extra parameters.
void	setAllowPartial(boolean allowPartial) Allow partial results in download.
void	setCleanup(boolean cleanup) Cleanup handle temporary files at done().
void	setClose(boolean close) Close the handle at done().
void	setDataCopy(boolean copy) Set the bundle files copy parameter.
void	setDataResource(java.lang.String resource) Set Resources parameter for the data bundle.
void	setDataSkipDigest(boolean skipDigest) Set the skip digest bit for current data bundle.
void	setDescription(java.lang.String description) Set the description.
void	setExeBundleName(java.lang.String name) Use a precreated executor bundle.
void	setExecutable(java.lang.String executable) Set the executable.
void	setExeSkipDigest(boolean skipDigest) Set the skip digest bit for the executor bundle.
void	setIntermediateResultHandler(IntermediateResultHandler irh)
void	setJavaExecutable() Set the executable to use worker installed Java binary.
void	setJobFileNames(java.lang.String... names) Set job input file names.
void	setJobParams(java.util.Vector<java.util.Hashtable<java.lang.String,java.lang.String>> jobParams) Set the parameters for the jobs to be created.
void	setJobs(int jobs) Set number of jobs to be created.
void	setJobSkipDigest(boolean skipDigest) Set the skip digest bit for job input bundle.
void	setMessages(boolean messages) Enable messages printing.
void	setName(java.lang.String name) Set the peach name.
void	setParamBundleName(java.lang.String name) Set Name of the Parameter bundle.
void	setParamBundleVersion(java.lang.String version) Set Version of the Parameter bundle.
void	setParamCopy(boolean copy) Set the parameter bundle copy parameters.
void	setParamResource(java.lang.String resource) Set Resources parameter for the Parameter bundle.
void	setParamSkipDigest(boolean skipDigest) Set the Parameter bundle skip digest bit.
void	setPeachVector(java.util.Vector<java.lang.String> peachVector) Set the peachparam parameter for the jobs to be created.
void	setPriority(int priority) Set the project priority.
void	setPriority(java.lang.String priority) Set the project priority in String format.
void	setProjectId(int projectid) Set project ID.
void	setRemove(boolean remove) Remove project after it is done (done within done()).
void	setResultFile(java.lang.String resultFile) Set the result file to be used.
void	setStateDir(java.lang.String stateDir) Set the directory where state files are stored.
void	setStream(boolean stream) Set streaming mode.
void	setUseDefaultOutputFile(boolean use) When no output files are defined a default (techila_peach_result.dat) is used in executor bundle definition.
boolean	sourcesChanged() Check if the source files have changed compared to saved state.

Method Detail

setStateDir

void setStateDir(java.lang.String stateDir)

Set the directory where state files are stored. If null the current working directory is used.

Parameters:

stateDir - the directory

setName

void setName(java.lang.String name)

Set the peach name.

Parameters:

name - the name

setDescription

void setDescription(java.lang.String description)

Set the description.

Parameters:

description - description

setMessages

void setMessages(boolean messages)

Enable messages printing.

Parameters:

messages - true or false

setPriority

void setPriority(int priority)

Set the project priority.

Parameters:

priority -

setPriority

void setPriority(java.lang.String priority)

Set the project priority in String format. Valid values are "HIGHEST", "HIGH", "ABOVE_NORMAL", "NORMAL", "BELOW_NORMAL" "LOW" ans "LOWEST".

Parameters:

priority - Priority string

setProjectId

void setProjectId(int projectid)

Set project ID. Use for attaching to a previously created project.

Parameters:

projectid -

setResultFile

void setResultFile(java.lang.String resultFile)

Set the result file to be used. This can be used to process a previously downloaded (e.g. manually) result file. When this is set, the result is not downloaded from the server.

Parameters:

resultFile -

setJobs

void setJobs(int jobs)

Set number of jobs to be created.

Parameters:

jobs -

setPeachVector

void setPeachVector(java.util.Vector<java.lang.String> peachVector)

Set the peachparam parameter for the jobs to be created. The number of jobs to be created equals the length of the vector. Each job will get a single value from the vector into parameter "peachparam".

Parameters:

peachVector -

setJobParams

void setJobParams(java.util.Vector<java.util.Hashtable<java.lang.String,java.lang.String>> jobParams)

Set the parameters for the jobs to be created. The number of jobs to be created equals the length of the vector. Each job will get a single set of values from the vector into job parameters.

Parameters:

jobParams -

setAllowPartial

void setAllowPartial(boolean allowPartial)

Allow partial results in download. Ignored when streaming is enabled.

Parameters:

allowPartial -

setRemove

void setRemove(boolean remove)

Remove project after it is done (done within done()). Default false.

Parameters:

remove -

See Also:

done()

setCleanup

void setCleanup(boolean cleanup)

Cleanup handle temporary files at done(). Default true.

Parameters:

cleanup -

setClose

void setClose(boolean close)

Close the handle at done(). Default true.

Parameters:

close -

addSourceFile

void addSourceFile(java.lang.String file)

Add a source file.

Parameters:

file - source file name

putSourceExtras

void putSourceExtras(java.lang.String name,
                     java.lang.String value)

Store source extra parameters. Use for example compiler version, 32/64 -bits, etc...

Parameters:

name - name of the parameter

value - value of the parameter

putAllSourceExtras

void putAllSourceExtras(java.util.Map<java.lang.String,java.lang.String> extras)

Put all values of given Map into the source bundles extra parameters.

Parameters:

extras -

sourcesChanged

boolean sourcesChanged()

Check if the source files have changed compared to saved state.

Returns:

true if source files have changed

setExeBundleName

void setExeBundleName(java.lang.String name)

Use a precreated executor bundle.

Parameters:

name - name of the bundle

setExecutable

void setExecutable(java.lang.String executable)

Set the executable. This can be used the if executable is not within the executor bundle but already exists on the worker. E.g. %L(resource) can be used here or a reference to a preinstalled binary, or %A(feature) to use a feature configured for the worker.

Parameters:

executable -

setJavaExecutable

void setJavaExecutable()

Set the executable to use worker installed Java binary. A convenience method to define executable for Java applications.

setExeSkipDigest

void setExeSkipDigest(boolean skipDigest)

Set the skip digest bit for the executor bundle.

Parameters:

skipDigest -

addExeFile

void addExeFile(java.lang.String file)

Add a file into the Executor bundle. Resource "exe" will be used, i.e. the file must be the executable.

Parameters:

file -

addExeFile

void addExeFile(java.lang.String res,
                java.lang.String file)

Add a file into the Executor bundle with given resource name. Use "exe" as resource name for the actual executable files which are to be run. Other files can have any resource name, even null.

Parameters:

res - resource name, if null the file basename is used

file - the actual file (with path if not in the current directory)

addExeFile

void addExeFile(java.lang.String res,
                java.lang.String file,
                java.lang.String osname)

Add a file into the Executor bundle with given parameters.

Parameters:

res -

file -

osname -

addExeFile

void addExeFile(java.lang.String res,
                java.lang.String file,
                java.lang.String osname,
                java.lang.String processor)

Add a file into the Executor bundle with given parameters.

Parameters:

res - resource name

file - the file name (with path)

osname - osname

processor - processor architechture

putExeExtras

void putExeExtras(java.lang.String name,
                  java.lang.String value)

Put a value into the Executor bundles extra parameters.

Parameters:

name -

value -

putAllExeExtras

void putAllExeExtras(java.util.Map<java.lang.String,java.lang.String> extras)

Put all values of given Map into the Executor bundles extra parameters.

Parameters:

extras -

addExeImport

void addExeImport(java.lang.String importName)

Add an import for the Executor bundle.

Parameters:

importName -

addOutputFile

void addOutputFile(java.lang.String def)

Add an outpuf file definition, eg. "output;file=outputfile.dat". If no output files are defined the default "output;file=techila_peach_outputfile.dat" is used.

Parameters:

def -

setUseDefaultOutputFile

void setUseDefaultOutputFile(boolean use)

When no output files are defined a default (techila_peach_result.dat) is used in executor bundle definition. By setting this to false the default is not set. Use this when OutputFiles parameter has been defined in an imported bundle (e.g. runtime bundle). When output file definitions have been added this setting has no effect.

Parameters:

set - true or false

newDataBundle

void newDataBundle()

Start defining a new data bundle. This must be called first before any other data bundle related commands.

newDataBundle

void newDataBundle(java.lang.String name)

Use a named databundle that already exists on the server... adding files to this has no effect. Bundles can be created with for example bundle creater tool or createSignedBundle -method.

Parameters:

name -

setDataSkipDigest

void setDataSkipDigest(boolean skipDigest)

Set the skip digest bit for current data bundle. Setting this to true will skip generating digests of files added to the bundle. Only affect files added after changing the bit.

Parameters:

skipDigest -

addDataFile

void addDataFile(java.lang.String file)

Add a file into the current data bundle.

Parameters:

file -

addDataFile

void addDataFile(java.lang.String file,
                 java.lang.String targetName)

Add a file into the current data bundle.

Parameters:

file -

targetName - the file name to be used on the worker

addDataFileWithDir

void addDataFileWithDir(java.lang.String dir,
                        java.lang.String file)

Add a file from a directory into the current data bundle.

Parameters:

dir - the directory where the file is, null for current dir

file - filename

putDataExtras

void putDataExtras(java.lang.String name,
                   java.lang.String value)

Put a value into the current data bundles extra parameters.

Parameters:

name -

value -

putAllDataExtras

void putAllDataExtras(java.util.Map<java.lang.String,java.lang.String> extras)

Put all values of given Map into the data bundles extra parameters.

Parameters:

extras -

setDataCopy

void setDataCopy(boolean copy)

Set the bundle files copy parameter. When true (default) the files in the data bundle are copied into the working directory (execution directory). When false the files are not copied and can be referenced by using %L(peach_datafiles_X) where X is the index of the data bundle.

Parameters:

copy -

setDataResource

void setDataResource(java.lang.String resource)

Set Resources parameter for the data bundle.

Parameters:

resources -

setJobSkipDigest

void setJobSkipDigest(boolean skipDigest)

Set the skip digest bit for job input bundle.

Parameters:

skipDigest - skip

setJobFileNames

void setJobFileNames(java.lang.String... names)

Set job input file names. This will clear all previously added / set names.

Parameters:

names -

addJobFile

void addJobFile(java.lang.String... files)

Add files to be included in the Job Input Bundle.

Parameters:

files - The names of the files

addJobFileWithDir

void addJobFileWithDir(java.lang.String dir,
                       java.lang.String... files)

Add files from a directory to be included in the Job Input Bundle.

Parameters:

dir - The directory where the file is, null = current dir

files - The names of the files

putJobExtras

void putJobExtras(java.lang.String name,
                  java.lang.String value)

Put a value into the Job Input Bundle extra parameters.

Parameters:

name -

value -

putAllJobExtras

void putAllJobExtras(java.util.Map<java.lang.String,java.lang.String> extras)

Put all values of given Map into the Job Input Bundles extra parameters.

Parameters:

extras -

setParamSkipDigest

void setParamSkipDigest(boolean skipDigest)

Set the Parameter bundle skip digest bit.

Parameters:

skipDigest -

addParamFile

void addParamFile(java.lang.String file)

Add a file into the parameter bundle.

Parameters:

file - The file

addParamFileWithDir

void addParamFileWithDir(java.lang.String dir,
                         java.lang.String file)

Add file into parameter bundle from a given directory.

Parameters:

dir - directory where the file is, null for current dir

file - the filename

addParamFile

void addParamFile(java.lang.String file,
                  java.lang.String targetName)

Add a file into the parameter bundle and specify target name.

Parameters:

file - the file

targetName - target file name in the bundle

putParamExtras

void putParamExtras(java.lang.String name,
                    java.lang.String value)

Put a value into the parameter bundles extra parameters.

Parameters:

name -

value -

putAllParamExtras

void putAllParamExtras(java.util.Map<java.lang.String,java.lang.String> extras)

Put all values of given Map into the parameters bundles extra parameters.

Parameters:

extras -

addParamExternalResource

void addParamExternalResource(java.lang.String res)

Add External Resource to Parameter Bundle.

Parameters:

res -

setParamCopy

void setParamCopy(boolean copy)

Set the parameter bundle copy parameters.

Parameters:

copy -

See Also:

setDataCopy(boolean)

addParamImport

void addParamImport(java.lang.String importName)

Add an import for the Parameter bundle.

Parameters:

importName -

setParamResource

void setParamResource(java.lang.String resource)

Set Resources parameter for the Parameter bundle.

Parameters:

resources -

setParamBundleName

void setParamBundleName(java.lang.String name)

Set Name of the Parameter bundle.

Parameters:

name -

getParamBundleName

java.lang.String getParamBundleName()

Get Name of the Parameter bundle.

Returns:

setParamBundleVersion

void setParamBundleVersion(java.lang.String version)

Set Version of the Parameter bundle.

Parameters:

version -

putProjectParam

void putProjectParam(java.lang.String name,
                     java.lang.String value)

Set a project parameter to a given value.

Parameters:

name - parameter name

value - parameter value

putAllProjectParams

void putAllProjectParams(java.util.Map<java.lang.String,java.lang.String> params)

Put all values of a given Map into project parameters.

Parameters:

params -

setStream

void setStream(boolean stream)

Set streaming mode.

Parameters:

stream -

setIntermediateResultHandler

void setIntermediateResultHandler(IntermediateResultHandler irh)

execute

int execute()

Run the Peach. This will create all bundles if necessary and then create and start the project.

Returns:

status code

nextFile

java.lang.String nextFile()

Get the result file. This will return null if no more files are available, i.e. the project is done or failed.

Returns:

filename and path to a result file or null.

done

void done()

Mark Peach call as done. Remove and cleanup leftovers. This must be called always.

getProjectHandle

int getProjectHandle()

Get the handle used for project commands.

Returns:

the project handle

getProjectId

int getProjectId()

Get the project ID of the current project.

Returns:

the project id or -1 if not yet set.

getLastErrorMessage

java.lang.String getLastErrorMessage()

postProcessed

void postProcessed(int count)