Package io.openems.common.jsonrpc.request

Class AuthenticateWithPasswordRequest

java.lang.Object

io.openems.common.jsonrpc.base.JsonrpcMessage

io.openems.common.jsonrpc.base.AbstractJsonrpcRequest

io.openems.common.jsonrpc.base.JsonrpcRequest

io.openems.common.jsonrpc.request.AuthenticateWithPasswordRequest

public class AuthenticateWithPasswordRequest
extends JsonrpcRequest

Represents a JSON-RPC Request to authenticate with a Password.

This is used by UI to login with username + password at Edge or Backend.

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "method": "authenticateWithPassword",
   "params": {
     "username"?: string,
     "password": string
   }
 }
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	METHOD
final String	password	The Password.
final Optional<String>	usernameOpt	The Username if given.

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

DEFAULT_TIMEOUT_SECONDS, id, NO_TIMEOUT, timeoutOpt

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

JSONRPC_VERSION

Constructor Summary

Constructors

Constructor	Description
AuthenticateWithPasswordRequest(Optional<String> usernameOpt, String password)

Method Summary

Modifier and Type	Method	Description
static AuthenticateWithPasswordRequest	from(JsonrpcRequest r)	Create AuthenticateWithPasswordRequest from a template JsonrpcRequest.
com.google.gson.JsonObject	getParams()	Gets the params JsonObject of the JsonrpcRequest.

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

usernameOpt

public final Optional<String> usernameOpt

The Username if given.

password

public final String password

The Password.

Constructor Details

AuthenticateWithPasswordRequest

public AuthenticateWithPasswordRequest(Optional<String> usernameOpt,
 String password)

Method Details

from

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

Create AuthenticateWithPasswordRequest from a template JsonrpcRequest.

Parameters:

r - the template JsonrpcRequest

Returns:

the AuthenticateWithPasswordRequest

Throws:

OpenemsError.OpenemsNamedException - on parse error

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