org.eclipse.kura.executor

Interface CommandExecutorService

All Known Subinterfaces:

PrivilegedExecutorService, UnprivilegedExecutorService

@ProviderType
public interface CommandExecutorService

This interface provides methods for running system processes or executing system commands.

Since:

2.2

Method Summary

Modifier and Type	Method and Description
CommandStatus	execute(Command command) Synchronously executes a system command.
void	execute(Command command, java.util.function.Consumer<CommandStatus> callback) Asynchronously executes a system command.
java.util.Map<java.lang.String,Pid>	getPids(java.lang.String[] commandLine) This method searches for running processes containing all the tokens in the command line.
boolean	isRunning(Pid pid) Returns true if the process identified by the given Pid is running.
boolean	isRunning(java.lang.String[] commandLine) Returns true if at least one process containing all the tokens in the given command line is found.
boolean	kill(java.lang.String[] commandLine, Signal signal) Kills the system commands containing all the tokens in the given command line.
boolean	stop(Pid pid, Signal signal) Stops the system process identified by the given Pid.

Method Detail

execute

CommandStatus execute(Command command)

Synchronously executes a system command.

Parameters:

command - the Command to be executed

Returns:

a CommandStatus object

execute

void execute(Command command,
             java.util.function.Consumer<CommandStatus> callback)

Asynchronously executes a system command.

Parameters:

command - the Command to be executed

callback - the consumer called when the command returns

stop

boolean stop(Pid pid,
             Signal signal)

Stops the system process identified by the given Pid.

Parameters:

pid - the Pid of the process to be stopped

signal - the Signal sent to the process to stop it. If null, a default signal will be sent. The type of the default signal is implementation specific

Returns:

a boolean value that is true if the stop operation succeeded

kill

boolean kill(java.lang.String[] commandLine,
             Signal signal)

Kills the system commands containing all the tokens in the given command line. If more processes are found, all of them will be killed.

Parameters:

commandLine - the command to be killed

signal - the Signal sent to the command to kill it. If null, a default signal will be sent. The type of the default signal is implementation specific

Returns:

a boolean value that is true if the kill operation succeeded

isRunning

boolean isRunning(Pid pid)

Returns true if the process identified by the given Pid is running.

Parameters:

pid - the Pid object of the process

Returns:

a boolean value that is true if the process is running

isRunning

boolean isRunning(java.lang.String[] commandLine)

Returns true if at least one process containing all the tokens in the given command line is found. It is equivalent to !getPids(commandLine).isEmpty().

Parameters:

commandLine - the command to be checked

Returns:

a boolean value that is true if the command is running

getPids

java.util.Map<java.lang.String,Pid> getPids(java.lang.String[] commandLine)

This method searches for running processes containing all the tokens in the command line. It returns a map whose keys are the commands found and the values are the associated Pids.

Parameters:

commandLine - the command line

Returns:

a map of commands and associated Pid