org.ow2.proactive.scheduler.task.utils

Class ForkerUtils

java.lang.Object

org.ow2.proactive.scheduler.task.utils.ForkerUtils

public final class ForkerUtils
extends Object

ForkerUtils is a helper to cache OSBuilder factory and provide some helping methods to launcher and executable.

Since:

ProActive Scheduling 2.2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ForkerUtils.ForkMethod

Field Summary

Fields

Modifier and Type	Field and Description
static String	FORK_METHOD_KEY System property Key of the fork method
static String	RUNAS_DOMAIN_GENERIC_INFO
static String	RUNAS_METHOD_GENERIC_INFO
static String	RUNAS_PWD_CRED_GENERIC_INFO
static String	RUNAS_PWD_GENERIC_INFO
static String	RUNAS_SSH_KEY_CRED_GENERIC_INFO
static String	RUNAS_USER_GENERIC_INFO

Method Summary

Modifier and Type	Method and Description
org.objectweb.proactive.extensions.processbuilder.OSUser	checkConfigAndGetUser(TaskContext taskContext) If the process must be run under a specific user, check the configuration of '"pas.launcher.forkas.method"' property and proceed as follow: if "pas.launcher.forkas.method"=none : throws IllegalAccessException if "pas.launcher.forkas.method"=pwd : return the user using its login and password if "pas.launcher.forkas.method"=key : return the user using its ssh key
static ForkerUtils	getInstance()
org.objectweb.proactive.extensions.processbuilder.PAOSProcessBuilderFactory	getOSProcessBuilderFactory(String nativeScriptPath) Get the singleton instance of PAOSProcessBuilderFactory
void	setSharedExecutablePermissions(File file)
void	setSharedPermissions(File file)

Methods inherited from class java.lang.Object

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

Field Detail

FORK_METHOD_KEY

public static final String FORK_METHOD_KEY

System property Key of the fork method

See Also:

Constant Field Values

RUNAS_METHOD_GENERIC_INFO

public static final String RUNAS_METHOD_GENERIC_INFO

See Also:

Constant Field Values

RUNAS_USER_GENERIC_INFO

public static final String RUNAS_USER_GENERIC_INFO

See Also:

Constant Field Values

RUNAS_DOMAIN_GENERIC_INFO

public static final String RUNAS_DOMAIN_GENERIC_INFO

See Also:

Constant Field Values

RUNAS_PWD_GENERIC_INFO

public static final String RUNAS_PWD_GENERIC_INFO

See Also:

Constant Field Values

RUNAS_PWD_CRED_GENERIC_INFO

public static final String RUNAS_PWD_CRED_GENERIC_INFO

See Also:

Constant Field Values

RUNAS_SSH_KEY_CRED_GENERIC_INFO

public static final String RUNAS_SSH_KEY_CRED_GENERIC_INFO

See Also:

Constant Field Values

Method Detail

getInstance

public static ForkerUtils getInstance()

getOSProcessBuilderFactory

public org.objectweb.proactive.extensions.processbuilder.PAOSProcessBuilderFactory getOSProcessBuilderFactory(String nativeScriptPath)

Get the singleton instance of PAOSProcessBuilderFactory

Returns:

the singleton instance of PAOSProcessBuilderFactory

checkConfigAndGetUser

public org.objectweb.proactive.extensions.processbuilder.OSUser checkConfigAndGetUser(TaskContext taskContext)
                                                                               throws IllegalAccessException,
                                                                                      KeyException

If the process must be run under a specific user, check the configuration of '"pas.launcher.forkas.method"' property and proceed as follow:

• if "pas.launcher.forkas.method"=none : throws IllegalAccessException
• if "pas.launcher.forkas.method"=pwd : return the user using its login and password
• if "pas.launcher.forkas.method"=key : return the user using its ssh key

Parameters:

taskContext - the task context.

Returns:

the OSUser to be passed to the OSPRocess if node fork method is configured.

Throws:

IllegalAccessException - if the node configuration method is not compatible with incoming credentials

KeyException - decryption failure, malformed data

IllegalArgumentException - if decrypter is null

IllegalAccessException - if node fork method is not set

setSharedExecutablePermissions

public void setSharedExecutablePermissions(File file)

setSharedPermissions

public void setSharedPermissions(File file)