Package io.openems.edge.core.host.jsonrpc

Class ExecuteSystemCommandRequest

java.lang.Object

io.openems.common.jsonrpc.base.JsonrpcMessage

io.openems.common.jsonrpc.base.AbstractJsonrpcRequest

io.openems.common.jsonrpc.base.JsonrpcRequest

io.openems.edge.core.host.jsonrpc.ExecuteSystemCommandRequest

public class ExecuteSystemCommandRequest
extends JsonrpcRequest

Represents a JSON-RPC Request to execute a system command on OpenEMS Edge.

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "method": "executeSystemCommand",
   "params": {
        "command": string,
        "runInBackground"?: boolean = false, // run the command in background (true) or in foreground (false)
        "timeoutSeconds"?: number = 5, // interrupt the command after ... seconds
        "username"?: string,
        "password"?: string,
   }
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ExecuteSystemCommandRequest.SystemCommand	Holds common parameters for a ExecuteSystemCommandRequest.SystemCommand.

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_RUN_IN_BACKGROUND
static final int	DEFAULT_TIMEOUT_SECONDS
static final String	METHOD
final ExecuteSystemCommandRequest.SystemCommand	systemCommand

Fields inherited from class io.openems.common.jsonrpc.base.JsonrpcRequest

id, NO_TIMEOUT, timeoutOpt

Fields inherited from class io.openems.common.jsonrpc.base.JsonrpcMessage

JSONRPC_VERSION

Constructor Summary

Constructors

Constructor	Description
ExecuteSystemCommandRequest(String command, boolean runInBackground, int timeoutSeconds, Optional<String> username, Optional<String> password)
ExecuteSystemCommandRequest(UUID id, ExecuteSystemCommandRequest.SystemCommand systemCommand)

Method Summary

Modifier and Type	Method	Description
static ExecuteSystemCommandRequest	from(JsonrpcRequest r)	Parses a generic JsonrpcRequest to a ExecuteSystemCommandRequest.
com.google.gson.JsonObject	getParams()	Gets the params JsonObject of the JsonrpcRequest.
static ExecuteSystemCommandRequest	runInBackgroundWithoutAuthentication(String command)	Factory without Username + Password; run in background without timeout.
static ExecuteSystemCommandRequest	withoutAuthentication(String command, boolean runInBackground, int timeoutSeconds)	Factory without Username + Password.

Methods inherited from class io.openems.common.jsonrpc.base.JsonrpcRequest

getId, getTimeout, toJsonObject

Methods inherited from class io.openems.common.jsonrpc.base.AbstractJsonrpcRequest

getFullyQualifiedMethod, getMethod

Methods inherited from class io.openems.common.jsonrpc.base.JsonrpcMessage

from, from, toString

Methods inherited from class java.lang.Object

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

Field Details

METHOD

public static final String METHOD

See Also:

• Constant Field Values

DEFAULT_RUN_IN_BACKGROUND

public static final boolean DEFAULT_RUN_IN_BACKGROUND

See Also:

• Constant Field Values

DEFAULT_TIMEOUT_SECONDS

public static final int DEFAULT_TIMEOUT_SECONDS

See Also:

• Constant Field Values

systemCommand

public final ExecuteSystemCommandRequest.SystemCommand systemCommand

Constructor Details

ExecuteSystemCommandRequest

public ExecuteSystemCommandRequest(String command,
 boolean runInBackground,
 int timeoutSeconds,
 Optional<String> username,
 Optional<String> password)

ExecuteSystemCommandRequest

public ExecuteSystemCommandRequest(UUID id,
 ExecuteSystemCommandRequest.SystemCommand systemCommand)

Method Details

from

public static ExecuteSystemCommandRequest from(JsonrpcRequest r)
                                        throws OpenemsError.OpenemsNamedException

Parses a generic JsonrpcRequest to a ExecuteSystemCommandRequest.

Parameters:

r - the JsonrpcRequest

Returns:

the ExecuteSystemCommandRequest

Throws:

OpenemsError.OpenemsNamedException - on error

runInBackgroundWithoutAuthentication

public static ExecuteSystemCommandRequest runInBackgroundWithoutAuthentication(String command)

Factory without Username + Password; run in background without timeout.

Parameters:

command - the command

Returns:

the ExecuteSystemCommandRequest

withoutAuthentication

public static ExecuteSystemCommandRequest withoutAuthentication(String command,
 boolean runInBackground,
 int timeoutSeconds)

Factory without Username + Password.

Parameters:

command - the command

runInBackground - run the command in background (true) or in foreground (false)

timeoutSeconds - interrupt the command after ... seconds

Returns:

the ExecuteSystemCommandRequest

getParams

public com.google.gson.JsonObject getParams()

Description copied from class: AbstractJsonrpcRequest

Gets the params JsonObject of the JsonrpcRequest.

Specified by:

getParams in class AbstractJsonrpcRequest

Returns:

the params as JsonObject