Package io.openems.common.jsonrpc.request

Class AuthenticateWithTokenRequest

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.AuthenticateWithTokenRequest

public class AuthenticateWithTokenRequest
extends JsonrpcRequest

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

This is used by UI to login with a Token at Edge or Backend.

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "method": "authenticateWithToken",
   "params": {
     "token": string
   }
 }
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	METHOD

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
AuthenticateWithTokenRequest(String token)

Method Summary

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

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

Constructor Details

AuthenticateWithTokenRequest

public AuthenticateWithTokenRequest(String token)

Method Details

from

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

Create AuthenticateWithTokenRequest from a template JsonrpcRequest.

Parameters:

r - the template JsonrpcRequest

Returns:

the AuthenticateWithTokenRequest

Throws:

OpenemsError.OpenemsNamedException - on parse error

getToken

public String getToken()

Gets the Token.

Returns:

Token

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