org.ow2.proactive.scheduler.common.task

Class ForkEnvironment

java.lang.Object

org.ow2.proactive.scheduler.common.task.ForkEnvironment

All Implemented Interfaces:

Serializable

@PublicAPI
public class ForkEnvironment
extends Object
implements Serializable

Class representing a forked environment of a JVM created specifically for an execution of a Java Task. A Java Task can be executed in the current JVM - then all Java Tasks are dependent on the same JVM (provider) and JVM options (like memory), or can be executed in a dedicated JVM with additional options specified like javaHome, javaArguments, classpath, ...

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOCKER_FORK_WINDOWS2LINUX

Constructor Summary

Constructors

Constructor and Description
ForkEnvironment()
ForkEnvironment(ForkEnvironment forkEnvironment) Copy constructor.
ForkEnvironment(String workingDir)

Method Summary

Modifier and Type	Method and Description
void	addAdditionalClasspath(String... values) Add one or more classpath entries to the forked JVM classpath
void	addAdditionalClasspath(String value) Add a new additional Classpath value.
void	addJVMArgument(String value) Add a new JVM argument value.
void	addPreJavaCommand(String commandOrParameter) Add an item to the list of (command + argument) which will be prepended to the java command
String	addSystemEnvironmentVariable(String name, String value) Add a new system environment variables value from its name and value.
static String	convertToLinuxClassPath(String windowsClassPath)
static String	convertToLinuxPath(String windowsPath)
static String	convertToLinuxPathInJVMArgument(String jvmArgument)
boolean	equals(Object o)
List<String>	getAdditionalClasspath() Return a copy of the additional classpath, empty list if no arguments.
Script<?>	getEnvScript() Get the environment script.
String	getJavaHome() Returns the javaHome.
List<String>	getJVMArguments() Return a copy of the JVM arguments, empty list if no arguments.
List<String>	getPreJavaCommand() Returns the list of (command + argument) which will be prepended to the java command e.g.
Map<String,String>	getSystemEnvironment() Return a copy of the system environment, empty map if no variables.
String	getSystemEnvironmentVariable(String name) Get the system environment variable value associated with the given name.
String	getWorkingDir() Return the working Directory.
int	hashCode()
boolean	isDockerWindowsToLinux() Returns true if the current fork environment aims at running a linux docker container on a windows host
void	setDockerWindowsToLinux(boolean dockerWindowsToLinux) Set true if the current fork environment aims at running a linux docker container on a windows host
void	setEnvScript(Script<?> script) Set the environment script value to the given script value.
void	setJavaHome(String javaHome) Sets the javaHome to the given javaHome value.
void	setPreJavaCommand(List<String> preJavaCommand) Sets the list of (command + argument) which will be prepended to the java command
void	setWorkingDir(String workingDir) Set the working directory value to the given workingDir value.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DOCKER_FORK_WINDOWS2LINUX

public static final String DOCKER_FORK_WINDOWS2LINUX

See Also:

Constant Field Values

Constructor Detail

ForkEnvironment

public ForkEnvironment()

ForkEnvironment

public ForkEnvironment(ForkEnvironment forkEnvironment)

Copy constructor.

Parameters:

forkEnvironment - the object to copy

ForkEnvironment

public ForkEnvironment(String workingDir)

Method Detail

getJavaHome

public String getJavaHome()

Returns the javaHome.

Returns:

the javaHome.

setJavaHome

public void setJavaHome(String javaHome)

Sets the javaHome to the given javaHome value.

Parameters:

javaHome - the javaHome to set.

getWorkingDir

public String getWorkingDir()

Return the working Directory.

Returns:

the working Directory.

setWorkingDir

public void setWorkingDir(String workingDir)

Set the working directory value to the given workingDir value.

Parameters:

workingDir - the working directory to set

getSystemEnvironment

public Map<String,String> getSystemEnvironment()

Return a copy of the system environment, empty map if no variables.

Returns:

a copy of the system environment, empty map if no variables.

getSystemEnvironmentVariable

public String getSystemEnvironmentVariable(String name)

Get the system environment variable value associated with the given name.

Parameters:

name - the name of the variable value to get

Returns:

the system variable value associated with the given name, or null if the variable does not exist.

addSystemEnvironmentVariable

public String addSystemEnvironmentVariable(String name,
                                           String value)

Add a new system environment variables value from its name and value.

Parameters:

name - the name of the variable to add

value - the the value associated to the given name

Returns:

the previous value associated to the system environment variable.

Throws:

IllegalArgumentException - if name is null

getJVMArguments

public List<String> getJVMArguments()

Return a copy of the JVM arguments, empty list if no arguments.

Returns:

a copy of the JVM arguments, empty list if no arguments.

addJVMArgument

public void addJVMArgument(String value)

Add a new JVM argument value. (-Dname=value, -Xmx=.., -server)

Parameters:

value - the value of the property to be added.

Throws:

IllegalArgumentException - if value is null.

getAdditionalClasspath

public List<String> getAdditionalClasspath()

Return a copy of the additional classpath, empty list if no arguments.

Returns:

a copy of the additional classpath, empty list if no arguments.

addAdditionalClasspath

public void addAdditionalClasspath(String... values)

Add one or more classpath entries to the forked JVM classpath

Parameters:

values - one or more classpath entries

addAdditionalClasspath

public void addAdditionalClasspath(String value)

Add a new additional Classpath value.

Parameters:

value - the additional Classpath to add.

Throws:

IllegalArgumentException - if value is null.

getPreJavaCommand

public List<String> getPreJavaCommand()

Returns the list of (command + argument) which will be prepended to the java command e.g. ["docker", "run", "--rm"]

Returns:

a list containing the command + arguments

setPreJavaCommand

public void setPreJavaCommand(List<String> preJavaCommand)

Sets the list of (command + argument) which will be prepended to the java command

Parameters:

preJavaCommand - a list containing the command + arguments, e.g. ["docker", "run", "--rm"]

addPreJavaCommand

public void addPreJavaCommand(String commandOrParameter)

Add an item to the list of (command + argument) which will be prepended to the java command

Parameters:

commandOrParameter - the command (e.g. "docker") or an argument (e.g. "run")

getEnvScript

public Script<?> getEnvScript()

Get the environment script.

Returns:

the environment script.

setEnvScript

public void setEnvScript(Script<?> script)

Set the environment script value to the given script value.

This script allows the user to programmatically set system variables, JVM arguments, additional classpath, etc. Use the binding variable name forkEnvironment to fill this object in this given script.

Parameters:

script - the script to set

isDockerWindowsToLinux

public boolean isDockerWindowsToLinux()

Returns true if the current fork environment aims at running a linux docker container on a windows host

Returns:

isDockerWindowsToLinux

setDockerWindowsToLinux

public void setDockerWindowsToLinux(boolean dockerWindowsToLinux)

Set true if the current fork environment aims at running a linux docker container on a windows host

Parameters:

dockerWindowsToLinux -

convertToLinuxPath

public static String convertToLinuxPath(String windowsPath)

convertToLinuxPathInJVMArgument

public static String convertToLinuxPathInJVMArgument(String jvmArgument)

convertToLinuxClassPath

public static String convertToLinuxClassPath(String windowsClassPath)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object