Package io.openems.common.jsonrpc.request

Class AuthenticatedRpcRequest<USER extends AbstractUser>

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.AuthenticatedRpcRequest<USER>

public class AuthenticatedRpcRequest<USER extends AbstractUser>
extends JsonrpcRequest

Wraps a JSON-RPC Request from an authenticated User.

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "method": "authenticatedRpc",
   "params": {
     "user": {
       "id": string,
       "name: string,
       "role": string
     },
     "payload": JsonrpcRequest
   }
 }
 

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
AuthenticatedRpcRequest(String edgeId, USER user, JsonrpcRequest payload)

Method Summary

Modifier and Type	Method	Description
static <USER extends AbstractUser> AuthenticatedRpcRequest<USER>	from(JsonrpcRequest r, ThrowingFunction<com.google.gson.JsonObject,USER,OpenemsError.OpenemsNamedException> userFactory)	Create AuthenticatedRpcRequest from a template JsonrpcRequest.
com.google.gson.JsonObject	getParams()	This method is called in OpenEMS Backend and formats the AuthenticatedRpcRequest, especially the `user` property so, that it contains only the required information for OpenEMS Edge and can be parsed via from(JsonrpcRequest, ThrowingFunction).
JsonrpcRequest	getPayload()	Gets the Payload JsonrpcRequest.
USER	getUser()	Gets the AbstractUser.

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

AuthenticatedRpcRequest

public AuthenticatedRpcRequest(String edgeId,
 USER user,
 JsonrpcRequest payload)

Method Details

from

public static <USER extends AbstractUser>
AuthenticatedRpcRequest<USER> from(JsonrpcRequest r,
 ThrowingFunction<com.google.gson.JsonObject,USER,OpenemsError.OpenemsNamedException> userFactory)
                            throws OpenemsError.OpenemsNamedException

Create AuthenticatedRpcRequest from a template JsonrpcRequest.

This method is called by OpenEMS Edge after it receives a message from OpenEMS Backend. As such the `edgeId` is empty here.

Type Parameters:

USER - the type of User

Parameters:

r - the template JsonrpcRequest

userFactory - a ThrowingFunction that parses the following JsonObject structure to a AbstractUser

     {
       "id": string,
       "name": string,
       "role": Role
     }
                    

Returns:

the AuthenticatedRpcRequest

Throws:

OpenemsError.OpenemsNamedException - on parse error

getUser

public USER getUser()

Gets the AbstractUser.

Returns:

User

getPayload

public JsonrpcRequest getPayload()

Gets the Payload JsonrpcRequest.

Returns:

Payload

getParams

public com.google.gson.JsonObject getParams()

This method is called in OpenEMS Backend and formats the AuthenticatedRpcRequest, especially the `user` property so, that it contains only the required information for OpenEMS Edge and can be parsed via from(JsonrpcRequest, ThrowingFunction).

Specified by:

getParams in class AbstractJsonrpcRequest

Returns:

the params as JsonObject