Package io.openems.common.jsonrpc.response

Class AppCenterIsKeyApplicableResponse

java.lang.Object

io.openems.common.jsonrpc.base.JsonrpcMessage

io.openems.common.jsonrpc.base.JsonrpcResponse

io.openems.common.jsonrpc.base.JsonrpcResponseSuccess

io.openems.common.jsonrpc.response.AppCenterIsKeyApplicableResponse

public class AppCenterIsKeyApplicableResponse
extends JsonrpcResponseSuccess

Represents a JSON-RPC Response to validate if a key can be used.

 success:
 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "result": {
     "isKeyApplicable": boolean
     "additionalInfo": {
          "keyId": String,
          "bundles": AppCenterGetPossibleAppsResponse.Bundle[],
          "registrations": AppCenterIsKeyApplicableResponse.Registration[],
          "usages": AppCenterIsKeyApplicableResponse.Usage[]
     }
   }
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AppCenterIsKeyApplicableResponse.AdditionalInfo
static final class	AppCenterIsKeyApplicableResponse.Registration
static final class	AppCenterIsKeyApplicableResponse.Usage

Field Summary

Fields

Modifier and Type	Field	Description
final AppCenterIsKeyApplicableResponse.AdditionalInfo	additionalInfo
final boolean	isKeyApplicable

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

JSONRPC_VERSION

Constructor Summary

Constructors

Constructor	Description
AppCenterIsKeyApplicableResponse(UUID id, boolean isKeyApplicable, AppCenterIsKeyApplicableResponse.AdditionalInfo additionalInfo)

Method Summary

Modifier and Type	Method	Description
static final AppCenterIsKeyApplicableResponse	from(JsonrpcResponseSuccess r)	Creates a AppCenterIsKeyApplicableResponse from a JsonrpcResponseSuccess.
static final AppCenterIsKeyApplicableResponse	from(UUID id, com.google.gson.JsonObject result)	Creates a AppCenterIsKeyApplicableResponse from a JsonObject.
com.google.gson.JsonObject	getResult()	Gets the result of this JsonrpcResponseSuccess.

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

from, toJsonObject

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

from, getId

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

toString

Methods inherited from class java.lang.Object

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

Field Details

isKeyApplicable

public final boolean isKeyApplicable

additionalInfo

public final AppCenterIsKeyApplicableResponse.AdditionalInfo additionalInfo

Constructor Details

AppCenterIsKeyApplicableResponse

public AppCenterIsKeyApplicableResponse(UUID id,
 boolean isKeyApplicable,
 AppCenterIsKeyApplicableResponse.AdditionalInfo additionalInfo)

Method Details

from

public static final AppCenterIsKeyApplicableResponse from(JsonrpcResponseSuccess r)
                                                   throws OpenemsError.OpenemsNamedException

Creates a AppCenterIsKeyApplicableResponse from a JsonrpcResponseSuccess.

Parameters:

r - the JsonrpcResponseSuccess

Returns:

a AppCenterIsKeyApplicableResponse

Throws:

OpenemsError.OpenemsNamedException - on error

from

public static final AppCenterIsKeyApplicableResponse from(UUID id,
 com.google.gson.JsonObject result)
                                                   throws OpenemsError.OpenemsNamedException

Creates a AppCenterIsKeyApplicableResponse from a JsonObject.

Parameters:

id - the id of the request

result - the JsonObject

Returns:

a AppCenterIsKeyApplicableResponse

Throws:

OpenemsError.OpenemsNamedException - on error

getResult

public com.google.gson.JsonObject getResult()

Description copied from class: JsonrpcResponseSuccess

Gets the result of this JsonrpcResponseSuccess.

Specified by:

getResult in class JsonrpcResponseSuccess

Returns:

a JsonObject with the 'result' property of the response