TaskEnvironment

java.lang.Object
- agi.parallel.infrastructure.TaskEnvironment

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

DefaultTaskEnvironment
```
public abstract class TaskEnvironment
extends java.lang.Object
implements java.io.Serializable
```
Represents the task environment in the system. The task environment provides common methods to run before and after Task is run.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

TaskEnvironment()
Initializes a new instance of the TaskEnvironment class.

Constructors
Constructor and Description
`TaskEnvironment()` Initializes a new instance of the `TaskEnvironment` class.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAdditionalId()` Gets the optional additional id of the environment.
`CpuArchitecture`	`getHostArchitecture()` Gets the desired CPU Architecture of the host that executes the task.
`java.util.UUID`	`getId()` Gets the id of the environment.
`java.lang.String`	`getName()` Gets the display name of the task environment.
`java.util.Hashtable`	`getProperties()` Gets task environment properties.
`java.lang.Object`	`getProperty(java.lang.String propertyName)` Returns property value by name.
`HostRecycleSettings`	`getRecycleSettings()` Gets the recycling settings that determine when to shutdown the host process on which tasks run.
`LicenseParameters`	`getRequiredLicense()` Gets the required license associated with this environment.
`int`	`getTasksPerHost()` Deprecated. TasksPerHost is obsolete; use RecycleSettings.FixedNumberOfTasks instead
`int`	`getTeardownTimeout()` Gets the amount of time teardown can run for before it is timed-out in milliseconds.
`java.lang.String`	`getWorkingDirectory()` Gets the custom working directory of the task environment.
`void`	`setAdditionalId(java.lang.String value)` Sets the optional additional id of the environment.
`void`	`setHostArchitecture(CpuArchitecture value)` Sets the desired CPU Architecture of the host that executes the task.
`void`	`setId(java.util.UUID value)` Sets the id of the environment.
`void`	`setName(java.lang.String value)` Sets the display name of the task environment.
`void`	`setProperty(java.lang.String propertyName, java.lang.Object value)` Sets property value.
`void`	`setRecycleSettings(HostRecycleSettings value)` Sets the recycling settings used for the policy which determines when to shutdown the host process the task runs on.
`void`	`setRequiredLicense(LicenseParameters value)` Sets the required license associated with this environment.
`void`	`setTasksPerHost(int value)` Deprecated. TasksPerHost is obsolete; use RecycleSettings.FixedNumberOfTasks instead
`void`	`setTeardownTimeout(int value)` Sets the amount of time teardown can run for before it is timed-out in milliseconds.
`abstract void`	`setup()` Called by Host before Task is executed.
`void`	`setWorkingDirectory(java.lang.String value)` Sets the custom working directory of the task environment.
`abstract void`	`teardown()` Called by Host after Task is executed.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TaskEnvironment
```
public TaskEnvironment()
```
    Initializes a new instance of the TaskEnvironment class.
- Method Detail
  - getHostArchitecture
```
public final CpuArchitecture getHostArchitecture()
```
    Gets the desired CPU Architecture of the host that executes the task. By specificy this property, the Task can be assured it is executed in a Host that supports this type of CPU architecture.
  - setHostArchitecture
```
public final void setHostArchitecture(CpuArchitecture value)
```
    Sets the desired CPU Architecture of the host that executes the task. By specificy this property, the Task can be assured it is executed in a Host that supports this type of CPU architecture.
  - getId
```
public final java.util.UUID getId()
```
    Gets the id of the environment. Environment can be reused if the environment IDs are identical.
  - setId
```
public final void setId(java.util.UUID value)
```
    Sets the id of the environment. Environment can be reused if the environment IDs are identical.
  - getAdditionalId
```
public final java.lang.String getAdditionalId()
```
    Gets the optional additional id of the environment. Environment can be reused if Environment IDs are identical.
  - setAdditionalId
```
public final void setAdditionalId(java.lang.String value)
```
    Sets the optional additional id of the environment. Environment can be reused if Environment IDs are identical.
  - getTasksPerHost
```
@Deprecated
public final int getTasksPerHost()
```
    Deprecated. TasksPerHost is obsolete; use RecycleSettings.FixedNumberOfTasks instead
    
    Gets the number of tasks this environment will execute before shutting down.
  - setTasksPerHost
```
@Deprecated
public final void setTasksPerHost(int value)
```
    Deprecated. TasksPerHost is obsolete; use RecycleSettings.FixedNumberOfTasks instead
    
    Sets the number of tasks this environment will execute before shutting down.
  - getRecycleSettings
```
public final HostRecycleSettings getRecycleSettings()
```
    Gets the recycling settings that determine when to shutdown the host process on which tasks run.
  - setRecycleSettings
```
public final void setRecycleSettings(HostRecycleSettings value)
```
    Sets the recycling settings used for the policy which determines when to shutdown the host process the task runs on.
  - getTeardownTimeout
```
public final int getTeardownTimeout()
```
    Gets the amount of time teardown can run for before it is timed-out in milliseconds.
  - setTeardownTimeout
```
public final void setTeardownTimeout(int value)
```
    Sets the amount of time teardown can run for before it is timed-out in milliseconds.
  - getRequiredLicense
```
public final LicenseParameters getRequiredLicense()
```
    Gets the required license associated with this environment. The required license.
  - setRequiredLicense
```
public final void setRequiredLicense(LicenseParameters value)
```
    Sets the required license associated with this environment. The required license.
  - getWorkingDirectory
```
public final java.lang.String getWorkingDirectory()
```
    Gets the custom working directory of the task environment.
  - setWorkingDirectory
```
public final void setWorkingDirectory(java.lang.String value)
```
    Sets the custom working directory of the task environment.
  - getProperties
```
public final java.util.Hashtable getProperties()
```
    Gets task environment properties.
  - getName
```
public final java.lang.String getName()
```
    Gets the display name of the task environment.
  - setName
```
public final void setName(java.lang.String value)
```
    Sets the display name of the task environment.
  - setup
```
public abstract void setup()
```
    Called by Host before Task is executed.
  - teardown
```
public abstract void teardown()
```
    Called by Host after Task is executed.
  - setProperty
```
public final void setProperty(java.lang.String propertyName,
                              java.lang.Object value)
```
    Sets property value.
    
    Parameters:
    
    propertyName - Property Name.
    
    value - Property Value.
  - getProperty
```
public final java.lang.Object getProperty(java.lang.String propertyName)
```
    Returns property value by name.
    
    Parameters:
    
    propertyName - Name of Property.
    
    Returns:
    
    The value associated with the specified property.

Class TaskEnvironment

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TaskEnvironment

Method Detail

getHostArchitecture

setHostArchitecture

getId

setId

getAdditionalId

setAdditionalId

getTasksPerHost

setTasksPerHost

getRecycleSettings

setRecycleSettings

getTeardownTimeout

setTeardownTimeout

getRequiredLicense

setRequiredLicense

getWorkingDirectory

setWorkingDirectory

getProperties

getName

setName

setup

teardown

setProperty

getProperty