fi.techila.user

Interface BundleManager

public interface BundleManager

Methods for bundle management.

Method Summary

Modifier and Type	Method and Description
int	approveUploadedBundles(int handle) Approve uploaded bundles.
boolean	bundleExists(java.lang.String bundleName) Does a bundle exist with given name.
boolean	bundleExists(java.lang.String bundlePrefix, java.lang.String bundleName) Does a bundle exists with given prefix and last part.
boolean	bundleVersionExists(java.lang.String bundleName, java.lang.String bundleVersion) Does a bundle exist with given name and version or any newer version.
int	createBundle(int handle, java.lang.String bundlePrefix, java.lang.String bundleName, java.lang.String description, java.lang.String bundleVersion, java.lang.String imports, java.lang.String exports, java.lang.String categoryName, java.lang.String resources, java.lang.String executor, java.util.Hashtable<java.lang.String,java.lang.String> extraLines, java.util.Hashtable<java.lang.String,java.lang.String> files) Deprecated. use signed version createSignedBundle( int, String, String, String, String, String, String, String, String, String, String, Hashtable, Hashtable)
int	createBundle(int handle, java.lang.String bundlePrefix, java.lang.String bundleName, java.lang.String description, java.lang.String bundleVersion, java.lang.String imports, java.lang.String exports, java.lang.String categoryName, java.lang.String resources, java.lang.String executor, java.lang.String[] extraLines, java.lang.String[] files) Deprecated. use signed version createSignedBundle( int, String, String, String, String, String, String, String, String, String, String, String[], String[])
int	createBundle(int handle, java.lang.String bundlePrefix, java.lang.String bundleName, java.lang.String description, java.lang.String bundleVersion, java.lang.String imports, java.lang.String exports, java.lang.String categoryName, java.lang.String resources, java.lang.String executor, java.util.Vector<java.lang.String> extraLines, java.util.Hashtable<java.lang.String,java.lang.String> files) Deprecated. use signed version (int, String, String, String, String, String, String, String, String, String, String, Hashtable, Hashtable)
int	createSignedBundle(int handle, java.lang.String bundleName, java.lang.String description, java.lang.String bundleVersion, java.lang.String imports, java.lang.String exports, java.lang.String natives, java.lang.String categoryName, java.lang.String resources, java.lang.String activator, java.lang.String executor, java.util.Hashtable<java.lang.String,java.lang.String> extras, java.util.Hashtable<java.lang.String,java.lang.String> files) Create a new signed bundle with given parameters and datafiles.
int	createSignedBundle(int handle, java.lang.String bundleName, java.lang.String description, java.lang.String bundleVersion, java.lang.String imports, java.lang.String exports, java.lang.String natives, java.lang.String categoryName, java.lang.String resources, java.lang.String activator, java.lang.String executor, java.util.Hashtable<java.lang.String,java.lang.String> extras, java.util.Hashtable<java.lang.String,java.lang.String> files, java.lang.String bundleFile) Create a signed bundle file (jar).
int	createSignedBundle(int handle, java.lang.String bundleName, java.lang.String description, java.lang.String bundleVersion, java.lang.String imports, java.lang.String exports, java.lang.String natives, java.lang.String categoryName, java.lang.String resources, java.lang.String activator, java.lang.String executor, java.lang.String[] extras, java.lang.String[] files) Create a signed bundle file (jar).
int	createSignedBundle(int handle, java.lang.String bundleName, java.lang.String description, java.lang.String bundleVersion, java.lang.String imports, java.lang.String exports, java.lang.String natives, java.lang.String categoryName, java.lang.String resources, java.lang.String activator, java.lang.String executor, java.lang.String[] extras, java.lang.String[] files, java.lang.String bundleFile) Create a signed bundle file (jar).
int	getBundleId(int handle) Get the bundle ID associated with the handle.
java.lang.String	getLastCreatedBundleName(int handle) Returns the name of the bundle last created.
int	setBundleId(int handle, int bundleId) Set bundle ID to be used with the handle.
int	signJar(java.lang.String infile, java.lang.String outfile) Sign a JAR file.
int	uploadBundle(int handle) Upload a bundle assiciated with the handle (created with createSignedBundle) to the server.
int	uploadBundle(int handle, java.lang.String bundleFile) Upload a bundle file to the server.
int	useBundle(int handle, java.lang.String bundleName) Set the bundle to be used in a project.
int	useBundle(int handle, java.lang.String bundlePrefix, java.lang.String bundleName) Set bundle to be used in a project.

Method Detail

createBundle

int createBundle(int handle,
                 java.lang.String bundlePrefix,
                 java.lang.String bundleName,
                 java.lang.String description,
                 java.lang.String bundleVersion,
                 java.lang.String imports,
                 java.lang.String exports,
                 java.lang.String categoryName,
                 java.lang.String resources,
                 java.lang.String executor,
                 java.lang.String[] extraLines,
                 java.lang.String[] files)

Deprecated. use signed version createSignedBundle( int, String, String, String, String, String, String, String, String, String, String, String[], String[])

Create a new bundle with given parameters and datafiles. Final bundle name will consist of the bundle prefix, user login name and the bundle name (prefix.user.name). The prefix is usually in the format of "fi.techila.grid.cust.[name].[program].clientmodule.client.data".
If the bundleName is empty or null the name is generated automatically.

Parameters:

handle - the handle, see TechilaManager.open()

bundlePrefix - prefix of the bundle name

bundleName - name of the bundle (last part of the full name)

description - description of the bundle

bundleVersion - version of the bundle

imports - imports of the new bundle

exports - exports of the new bundle

categoryName - category in which this bundle belongs to

resources - resources this bundle offers

executor - the executor to execute calculations with

extraLines - array of strings of extra lines for the manifest

files - array of strings of "filename=/path/to/local/file"

Returns:

status code, see Support

See Also:

createBundle(int, String, String, String, String, String, String, String, String, String, Hashtable, Hashtable)

createBundle

int createBundle(int handle,
                 java.lang.String bundlePrefix,
                 java.lang.String bundleName,
                 java.lang.String description,
                 java.lang.String bundleVersion,
                 java.lang.String imports,
                 java.lang.String exports,
                 java.lang.String categoryName,
                 java.lang.String resources,
                 java.lang.String executor,
                 java.util.Vector<java.lang.String> extraLines,
                 java.util.Hashtable<java.lang.String,java.lang.String> files)

Deprecated. use signed version (int, String, String, String, String, String, String, String, String, String, String, Hashtable, Hashtable)

Create a new bundle with given parameters and datafiles. Final bundle name will consist of the bundle prefix, user login name and the bundle name (prefix.user.name). The prefix is usually in the format of "fi.techila.grid.cust.[name].[program].clientmodule.client.data".
If the bundleName is empty or null the name is generated automatically.

Parameters:

handle - the handle, see TechilaManager.open()

bundlePrefix - prefix of the bundle name

bundleName - name of the bundle (last part of the full name)

description - description of the bundle

bundleVersion - version of the bundle

imports - imports for the new bundles

exports - exports of the new bundle

categoryName - category in which this bundle belongs to

resources - resources this bundle offers

executor - the executor to execute calculations with

extraLines - array of strings of extra lines for the manifest

files - Hashtable of filename - local file (full path) pairs

Returns:

status code, see Support

See Also:

createBundle(int, String, String, String, String, String, String, String, String, String, Hashtable, Hashtable)

createBundle

int createBundle(int handle,
                 java.lang.String bundlePrefix,
                 java.lang.String bundleName,
                 java.lang.String description,
                 java.lang.String bundleVersion,
                 java.lang.String imports,
                 java.lang.String exports,
                 java.lang.String categoryName,
                 java.lang.String resources,
                 java.lang.String executor,
                 java.util.Hashtable<java.lang.String,java.lang.String> extraLines,
                 java.util.Hashtable<java.lang.String,java.lang.String> files)

Deprecated. use signed version createSignedBundle( int, String, String, String, String, String, String, String, String, String, String, Hashtable, Hashtable)

Create a new bundle with given parameters and datafiles. Final bundle name will consist of the bundle prefix, user login name and the bundle name (prefix.user.name). The prefix is usually in the format of "fi.techila.grid.cust.[name].[program].clientmodule.client.data".
If the bundleName is empty or null the name is generated automatically.

Example:
Hashtable<String, String> extras = new Hashtable<String, String>();
extras.put("extraline1", "extralinedata");

Hashtable<String, String> files = new Hashtable<String, String>();
files.put("data1", "C:\\datafiles\\datafile1.dat");
files.put("data2", "C:\\datafiles\\datafile2.dat");

BundleManager bundleManager = techila.bundleManager();
int statuscode = bundleManager.createBundle(handle, "fi.techila.grid.cust.example", "databundle1", "description", "0.0.1", "fi.techila.grid.cust.example.clientmodule.client", "", "{user}", "dataresource", "fi.techila.grid.cust.example.clientmodule.client; specification-version=0.1.0", extras, files);

Parameters:

handle - the handle, see TechilaManager.open()

bundlePrefix - prefix of the bundle name

bundleName - name of the bundle (last part of the full name)

description - description of the bundle

bundleVersion - version of the bundle

imports - imports for the new bundles

exports - exports of the new bundle

categoryName - category in which this bundle belongs to

resources - resources this bundle offers

executor - the executor to execute calculations with

extraLines - hashtable of extra line name-value pairs

files - Hashtable of filename - local file (full path) pairs

Returns:

status code, see Support

createSignedBundle

int createSignedBundle(int handle,
                       java.lang.String bundleName,
                       java.lang.String description,
                       java.lang.String bundleVersion,
                       java.lang.String imports,
                       java.lang.String exports,
                       java.lang.String natives,
                       java.lang.String categoryName,
                       java.lang.String resources,
                       java.lang.String activator,
                       java.lang.String executor,
                       java.lang.String[] extras,
                       java.lang.String[] files)

Create a signed bundle file (jar).

Parameters:

handle - the handle, see TechilaManager.open()

bundleName - the name of the bundle

description - description of the bundle

bundleVersion - version of the bundle

imports - prerequired bundles

exports - exports

natives - natives

categoryName - category in which this bundle belongs to

resources - resources this bundle offers

activator - activator

executor - the executor to execute calculations with

extras - extra lines, array of strings of "key=value"

files - array of strings of "filename=/path/to/local/file"

Returns:

status code, see Support

See Also:

createSignedBundle(int, String, String, String, String, String, String, String, String, String, String, Hashtable, Hashtable, String)

createSignedBundle

int createSignedBundle(int handle,
                       java.lang.String bundleName,
                       java.lang.String description,
                       java.lang.String bundleVersion,
                       java.lang.String imports,
                       java.lang.String exports,
                       java.lang.String natives,
                       java.lang.String categoryName,
                       java.lang.String resources,
                       java.lang.String activator,
                       java.lang.String executor,
                       java.lang.String[] extras,
                       java.lang.String[] files,
                       java.lang.String bundleFile)

Create a signed bundle file (jar). Optionally giving filename.

Parameters:

handle - the handle, see TechilaManager.open()

bundleName - name of the bundle

description - description of the bundle

bundleVersion - version of the bundle

imports - prerequired bundles

exports - exports

natives - natives

categoryName - category in which this bundle belongs to

resources - resources this bundle offers

activator - activator

executor - the executor to execute the calculations with

extras - extra lines, array of strings of "key=value"

files - array of strings of "filename=/path/to/local/file"

bundleFile - output bundle filename, may be null

Returns:

status code, see Support

See Also:

createSignedBundle(int, String, String, String, String, String, String, String, String, String, String, Hashtable, Hashtable, String)

createSignedBundle

int createSignedBundle(int handle,
                       java.lang.String bundleName,
                       java.lang.String description,
                       java.lang.String bundleVersion,
                       java.lang.String imports,
                       java.lang.String exports,
                       java.lang.String natives,
                       java.lang.String categoryName,
                       java.lang.String resources,
                       java.lang.String activator,
                       java.lang.String executor,
                       java.util.Hashtable<java.lang.String,java.lang.String> extras,
                       java.util.Hashtable<java.lang.String,java.lang.String> files)

Create a new signed bundle with given parameters and datafiles.

Example:
Hashtable<String, String> extras = new Hashtable<String, String>();
extras.put("extraline1", "extralinedata");

Hashtable<String, String> files = new Hashtable<String, String>();
files.put("data1", "C:\\datafiles\\datafile1.dat");
files.put("data2", "C:\\datafiles\\datafile2.dat");

BundleManager bundleManager = techila.bundleManager();
int statuscode = bundleManager.createSignedBundle(handle, "example.{user}.mcpi", "description", "0.0.1", "binarybundle;specification-version=0.0.1", "", "", "", "dataresource", "", "", extras, files);

Parameters:

handle - the handle, see TechilaManager.open()

bundleName - the name of the bundle

description - the description of the bundle

bundleVersion - the version of the bundle

imports - prerequirements

exports - exported names

natives - native files

categoryName - category in which this bundle belongs to

resources - resources this bundle offers

activator - activator

executor - the executor to execute calculations with

extras - extra lines, name-value pairs

files - included files, filename-local file (full path) pairs

Returns:

status code, see Support

See Also:

createSignedBundle(int, String, String, String, String, String, String, String, String, String, String, Hashtable, Hashtable, String)

createSignedBundle

int createSignedBundle(int handle,
                       java.lang.String bundleName,
                       java.lang.String description,
                       java.lang.String bundleVersion,
                       java.lang.String imports,
                       java.lang.String exports,
                       java.lang.String natives,
                       java.lang.String categoryName,
                       java.lang.String resources,
                       java.lang.String activator,
                       java.lang.String executor,
                       java.util.Hashtable<java.lang.String,java.lang.String> extras,
                       java.util.Hashtable<java.lang.String,java.lang.String> files,
                       java.lang.String bundleFile)

Create a signed bundle file (jar). Optionally giving filename.

Example:
Hashtable<String, String> extras = new Hashtable<String, String>();
extras.put("ResultHandler", "default");
extras.put("Splitter", "default");
extras.put("InternalResources", "example.exe; file=example.exe;destination=example.exe");
extras.put("Executable", "example.exe");
extras.put("OutputFiles", "output;file=result.dat");
extras.put("Parameters", "%P(jobidx) %O(output)");

Hashtable<String, String> files = new Hashtable<String, String>();
files.put("example.exe", "example.exe");
BundleManager bundleManager = techila.bundleManager();
int statuscode = bundleManager.createSignedBundle(handle, "fi.techila.grid.cust.example.clientmodule.client", "binary bundle description", "0.1.0", "fi.techila.grid.cust.example.clientmodule.client", "", "x86/Windows/example.exe;osname=Windows XP; processor=x86,x86/Windows/example.exe;osname=Windows 2000; processor=x86,x86/Windows/example.exe;osname=Windows Vista; processor=x86", "", "", "", "", extras, files);

Parameters:

handle - the handle, see TechilaManager.open()

bundleName - the name of the bundle

description - the description of the bundle

bundleVersion - the version of the bundle

imports - prerequirements

exports - exported names

natives - native files

categoryName - category in which this bundle belongs to

resources - resources this bundle offers

activator - activator

executor - the executor to execute calculations with

extras - extra lines, name-value pairs

files - included files, filename-local file (full path) pairs

bundleFile - output filename, may be null.

Returns:

status code, see Support

signJar

int signJar(java.lang.String infile,
            java.lang.String outfile)

Sign a JAR file. The input jar file is signed and the resulting signed jar is written to the defined output jar file. The key and certificate used are those defined in init.

Parameters:

infile - input jar filename

outfile - output jar filename

Returns:

status code, see Support

uploadBundle

int uploadBundle(int handle)

Upload a bundle assiciated with the handle (created with createSignedBundle) to the server.

Returns:

status code, see Support

See Also:

createSignedBundle(int, String, String, String, String, String, String, String, String, String, String, Hashtable, Hashtable, String), ManagementInterface#approveUploadedBundles(int)

uploadBundle

int uploadBundle(int handle,
                 java.lang.String bundleFile)

Upload a bundle file to the server. Uploaded bundles must be approved before they are taken into use.

Parameters:

handle - the handle, see TechilaManager.open()

bundleFile - the file to be uploaded

Returns:

status code, see Support

See Also:

approveUploadedBundles(int)

approveUploadedBundles

int approveUploadedBundles(int handle)

Approve uploaded bundles. All bundles uploaded with the given handle are approved. Possible errors are available in the log.

Parameters:

handle - the handle, see TechilaManager.open()

Returns:

status code, see Support

useBundle

int useBundle(int handle,
              java.lang.String bundleName)

Set the bundle to be used in a project.

Parameters:

handle - the handle, see TechilaManager.open()

bundleName - full name of the bundle

Returns:

status code, see Support

See Also:

ProjectManager.createProject(int, int, String), ProjectManager.createProject(int, int, String, Hashtable)

useBundle

int useBundle(int handle,
              java.lang.String bundlePrefix,
              java.lang.String bundleName)

Set bundle to be used in a project.

Parameters:

handle - the handle, see TechilaManager.open()

bundlePrefix - prefix of the bundle name

bundleName - the name of the bundle

Returns:

status code, see Support

See Also:

ProjectManager.createProject(int, int, String), ProjectManager.createProject(int, int, String, Hashtable)

bundleExists

boolean bundleExists(java.lang.String bundleName)

Does a bundle exist with given name.

Parameters:

bundleName - of the bundle to check

Returns:

true if exists

bundleVersionExists

boolean bundleVersionExists(java.lang.String bundleName,
                            java.lang.String bundleVersion)

Does a bundle exist with given name and version or any newer version.

Parameters:

bundleName - name of the bundle to check

bundleVersion - minimum version of the bundle to check

Returns:

true if exists

bundleExists

boolean bundleExists(java.lang.String bundlePrefix,
                     java.lang.String bundleName)

Does a bundle exists with given prefix and last part.

Parameters:

bundlePrefix - prefix of the bundle name

bundleName - the name of the bundle

Returns:

true if exists

getBundleId

int getBundleId(int handle)

Get the bundle ID associated with the handle. The returned bundle ID can be used with new handles by setting it with setBundleId(int, int) without the need to create new bundles each time.

Parameters:

handle - the handle, see TechilaManager.open()

Returns:

bundle id or error code < 0

See Also:

setBundleId(int, int)

setBundleId

int setBundleId(int handle,
                int bundleId)

Set bundle ID to be used with the handle. This method does not check the server if the bundle exists and should only be used with a value returned by getBundleId(int) after createBundle (or useBundle).

Parameters:

handle - the handle, see TechilaManager.open()

bundleId - the id of the bundle

Returns:

status code, see Support

See Also:

ProjectManager.createProject(int, int, String), ProjectManager.createProject(int, int, String, Hashtable)

getLastCreatedBundleName

java.lang.String getLastCreatedBundleName(int handle)

Returns the name of the bundle last created.

Parameters:

handle - the handle, see TechilaManager.open()

Returns:

bundle name