Package com.powsybl.computation.local
Class LocalComputationManager
- java.lang.Object
-
- com.powsybl.computation.local.LocalComputationManager
-
- All Implemented Interfaces:
ComputationManager
,AutoCloseable
- Direct Known Subclasses:
DockerLocalComputationManager
public class LocalComputationManager extends Object implements ComputationManager
- Author:
- Geoffroy Jamgotchian
-
-
Constructor Summary
Constructors Constructor Description LocalComputationManager()
LocalComputationManager(PlatformConfig platformConfig)
LocalComputationManager(LocalComputationConfig config)
LocalComputationManager(LocalComputationConfig config, LocalCommandExecutor localCommandExecutor, Executor executor)
LocalComputationManager(LocalComputationConfig config, Executor executor)
LocalComputationManager(Path localDir)
LocalComputationManager(Executor executor)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
<R> CompletableFuture<R>
execute(ExecutionEnvironment environment, ExecutionHandler<R> handler)
Submits for execution commands defined by the specifiedExecutionHandler
, using the specifiedExecutionEnvironment
.<R> CompletableFuture<R>
execute(ExecutionEnvironment environment, ExecutionHandler<R> handler, ComputationParameters parameters)
Submits for execution commands defined by the specifiedExecutionHandler
, using the specifiedExecutionEnvironment
.static ComputationManager
getDefault()
Executor
getExecutor()
An executor which may be used to perform expensive processing inside this JVM.Path
getLocalDir()
ComputationResourcesStatus
getResourcesStatus()
String
getVersion()
OutputStream
newCommonFile(String fileName)
-
-
-
Constructor Detail
-
LocalComputationManager
public LocalComputationManager() throws IOException
- Throws:
IOException
-
LocalComputationManager
public LocalComputationManager(Executor executor) throws IOException
- Throws:
IOException
-
LocalComputationManager
public LocalComputationManager(PlatformConfig platformConfig) throws IOException
- Throws:
IOException
-
LocalComputationManager
public LocalComputationManager(Path localDir) throws IOException
- Throws:
IOException
-
LocalComputationManager
public LocalComputationManager(LocalComputationConfig config) throws IOException
- Throws:
IOException
-
LocalComputationManager
public LocalComputationManager(LocalComputationConfig config, Executor executor) throws IOException
- Throws:
IOException
-
LocalComputationManager
public LocalComputationManager(LocalComputationConfig config, LocalCommandExecutor localCommandExecutor, Executor executor) throws IOException
- Throws:
IOException
-
-
Method Detail
-
getDefault
public static ComputationManager getDefault()
-
getVersion
public String getVersion()
- Specified by:
getVersion
in interfaceComputationManager
-
getLocalDir
public Path getLocalDir()
- Specified by:
getLocalDir
in interfaceComputationManager
-
newCommonFile
public OutputStream newCommonFile(String fileName) throws IOException
- Specified by:
newCommonFile
in interfaceComputationManager
- Throws:
IOException
-
execute
public <R> CompletableFuture<R> execute(ExecutionEnvironment environment, ExecutionHandler<R> handler)
Description copied from interface:ComputationManager
Submits for execution commands defined by the specifiedExecutionHandler
, using the specifiedExecutionEnvironment
.The result of type
ComputationManager
will be provided asynchronously through the returnedCompletableFuture
.- Specified by:
execute
in interfaceComputationManager
- Type Parameters:
R
- the type of the result expected from the commands execution.- Parameters:
environment
- specifies environment details such as the working directory prefix and environment variables.handler
- defines the commands to be executed together with preprocessing and postprocessing.- Returns:
- the result of the commands execution, as provided by the execution handler.
-
execute
public <R> CompletableFuture<R> execute(ExecutionEnvironment environment, ExecutionHandler<R> handler, ComputationParameters parameters)
Description copied from interface:ComputationManager
Submits for execution commands defined by the specifiedExecutionHandler
, using the specifiedExecutionEnvironment
.The result of type
ComputationManager
will be provided asynchronously through the returnedCompletableFuture
.Additional technical parameters may be provided through the
ComputationParameters
.- Specified by:
execute
in interfaceComputationManager
- Type Parameters:
R
- the type of the result expected from the commands execution.- Parameters:
environment
- specifies environment details such as the working directory prefix and environment variables.handler
- defines the commands to be executed together with preprocessing and postprocessing.parameters
- defines additional technical parameters- Returns:
- the result of the commands execution, as provided by the execution handler.
-
getResourcesStatus
public ComputationResourcesStatus getResourcesStatus()
- Specified by:
getResourcesStatus
in interfaceComputationManager
-
getExecutor
public Executor getExecutor()
Description copied from interface:ComputationManager
An executor which may be used to perform expensive processing inside this JVM.- Specified by:
getExecutor
in interfaceComputationManager
- Returns:
- an executor which may be used to perform expensive processing inside this JVM.
-
close
public void close()
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceComputationManager
-
-