Merge remote-tracking branch 'remotes/upstream/develop' into develop

cnf/checkstyle.xml

@@ -18,9 +18,9 @@
     </module>
     <module name="OuterTypeFilename"/>
     <module name="IllegalTokenText">
-      <property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
       <property name="format" value="\\u00(09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
       <property name="message" value="Consider using special escape sequence instead of octal value or Unicode escaped value."/>
+      <property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
     </module>
     <module name="AvoidEscapedUnicodeCharacters">
       <property name="allowEscapesForControlCharacters" value="true"/>
@@ -140,9 +140,9 @@
     </module>
     <module name="Indentation">
       <property name="severity" value="ignore"/>
-      <property name="arrayInitIndent" value="2"/>
       <property name="basicOffset" value="2"/>
       <property name="caseIndent" value="2"/>
+      <property name="arrayInitIndent" value="2"/>
       <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
     </module>
     <module name="AbbreviationAsWordInName">
@@ -167,8 +167,8 @@
     </module>
     <module name="AnnotationLocation">
       <property name="id" value="AnnotationLocationVariables"/>
-      <property name="tokens" value="VARIABLE_DEF"/>
       <property name="allowSamelineMultipleAnnotations" value="true"/>
+      <property name="tokens" value="VARIABLE_DEF"/>
     </module>
     <module name="NonEmptyAtclauseDescription"/>
     <module name="JavadocTagContinuationIndentation"/>
@@ -201,6 +201,7 @@
     </module>
     <module name="MissingJavadocMethod">
       <property name="allowedAnnotations" value="Before,Test,After,Override"/>
+      <property name="allowMissingPropertyJavadoc" value="true"/>
       <property name="ignoreMethodNamesRegex" value="doc|set.+"/>
       <property name="tokens" value="METHOD_DEF,ANNOTATION_FIELD_DEF"/>
     </module>

io.openems.backend.common/src/io/openems/backend/common/jsonrpc/request/AddEdgeToUserRequest.java

@@ -0,0 +1,63 @@
+package io.openems.backend.common.jsonrpc.request;
+
+import com.google.gson.JsonObject;
+
+import io.openems.common.exceptions.OpenemsError.OpenemsNamedException;
+import io.openems.common.jsonrpc.base.JsonrpcRequest;
+import io.openems.common.utils.JsonUtils;
+
+/**
+ * Adds a Edge to a User.
+ * 
+ * <pre>
+ * {
+ *   "jsonrpc": "2.0",
+ *   "id": UUID,
+ *   "method": "addEdgeToUser",
+ *   "params": {
+ *      "setupPassword": string
+ *   }
+ * }
+ * </pre>
+ */
+public class AddEdgeToUserRequest extends JsonrpcRequest {
+
+	public static final String METHOD = "addEdgeToUser";
+
+	/**
+	 * Create {@link AddEdgeToUserRequest} from a template {@link JsonrpcRequest}.
+	 * 
+	 * @param r the template {@link JsonrpcRequest}
+	 * @return the {@link AddEdgeToUserRequest}
+	 * @throws OpenemsNamedException on parse error
+	 */
+	public static AddEdgeToUserRequest from(JsonrpcRequest r) throws OpenemsNamedException {
+		JsonObject p = r.getParams();
+		String setupPassword = JsonUtils.getAsString(p, "setupPassword");
+		return new AddEdgeToUserRequest(r, setupPassword);
+	}
+
+	private final String setupPassword;
+
+	public AddEdgeToUserRequest(String setupPassword) {
+		super(METHOD);
+		this.setupPassword = setupPassword;
+	}
+
+	private AddEdgeToUserRequest(JsonrpcRequest request, String setupPassword) {
+		super(request, METHOD);
+		this.setupPassword = setupPassword;
+	}
+
+	@Override
+	public JsonObject getParams() {
+		return JsonUtils.buildJsonObject() //
+				.addProperty("setupPassword", this.setupPassword) //
+				.build();
+	}
+
+	public String getSetupPassword() {
+		return this.setupPassword;
+	}
+
+}

io.openems.backend.common/src/io/openems/backend/common/jsonrpc/request/GetSetupProtocolRequest.java

@@ -0,0 +1,49 @@
+package io.openems.backend.common.jsonrpc.request;
+
+import com.google.gson.JsonObject;
+
+import io.openems.common.exceptions.OpenemsError.OpenemsNamedException;
+import io.openems.common.jsonrpc.base.JsonrpcRequest;
+import io.openems.common.utils.JsonUtils;
+
+public class GetSetupProtocolRequest extends JsonrpcRequest {
+
+	public static final String METHOD = "getSetupProtocol";
+
+	/**
+	 * Create {@link GetSetupProtocolRequest} from a template
+	 * {@link JsonrpcRequest}.
+	 * 
+	 * @param request the template {@link JsonrpcRequest}
+	 * @return Created {@link GetSetupProtocolRequest}
+	 */
+	public static GetSetupProtocolRequest from(JsonrpcRequest request) throws OpenemsNamedException {
+		JsonObject params = request.getParams();
+
+		return new GetSetupProtocolRequest(request, JsonUtils.getAsInt(params, "setupProtocolId"));
+	}
+
+	private final int setupProtocolId;
+
+	private GetSetupProtocolRequest(JsonrpcRequest request, int setupProtocolId) {
+		super(request, METHOD);
+		this.setupProtocolId = setupProtocolId;
+	}
+
+	@Override
+	public JsonObject getParams() {
+		return JsonUtils.buildJsonObject() //
+				.addProperty("setupProtocolId", this.setupProtocolId) //
+				.build();
+	}
+
+	/**
+	 * Gets the Setup Protocol ID.
+	 * 
+	 * @return the Setup Protocol ID
+	 */
+	public int getSetupProtocolId() {
+		return this.setupProtocolId;
+	}
+
+}

io.openems.backend.common/src/io/openems/backend/common/jsonrpc/request/GetUserInformationRequest.java

@@ -0,0 +1,43 @@
+package io.openems.backend.common.jsonrpc.request;
+
+import com.google.gson.JsonObject;
+
+import io.openems.common.jsonrpc.base.JsonrpcRequest;
+
+/**
+ * Gets the User Information.
+ * 
+ * <pre>
+ * {
+ *   "jsonrpc": "2.0",
+ *   "id": UUID,
+ *   "method": "getUserInformation",
+ *   "params": {}
+ * }
+ * </pre>
+ */
+public class GetUserInformationRequest extends JsonrpcRequest {
+
+	public static final String METHOD = "getUserInformation";
+
+	/**
+	 * Create {@link GetUserInformationRequest} from a template
+	 * {@link JsonrpcRequest}.
+	 * 
+	 * @param request the template {@link JsonrpcRequest}
+	 * @return Created {@link GetUserInformationRequest}
+	 */
+	public static GetUserInformationRequest from(JsonrpcRequest request) {
+		return new GetUserInformationRequest(request);
+	}
+
+	private GetUserInformationRequest(JsonrpcRequest request) {
+		super(request, METHOD);
+	}
+
+	@Override
+	public JsonObject getParams() {
+		return new JsonObject();
+	}
+
+}

io.openems.backend.common/src/io/openems/backend/common/jsonrpc/request/RegisterUserRequest.java

@@ -0,0 +1,46 @@
+package io.openems.backend.common.jsonrpc.request;
+
+import com.google.gson.JsonObject;
+
+import io.openems.common.exceptions.OpenemsError.OpenemsNamedException;
+import io.openems.common.jsonrpc.base.JsonrpcRequest;
+import io.openems.common.utils.JsonUtils;
+
+public class RegisterUserRequest extends JsonrpcRequest {
+
+	public static final String METHOD = "registerUser";
+
+	/**
+	 * Create {@link RegisterUserRequest} from a template {@link JsonrpcRequest}.
+	 * 
+	 * @param request the template {@link JsonrpcRequest}
+	 * @return Created {@link RegisterUserRequest}
+	 */
+	public static RegisterUserRequest from(JsonrpcRequest request) throws OpenemsNamedException {
+		JsonObject params = request.getParams();
+
+		return new RegisterUserRequest(request, JsonUtils.getAsJsonObject(params, "user"));
+	}
+
+	private final JsonObject jsonObject;
+
+	private RegisterUserRequest(JsonrpcRequest request, JsonObject jsonObject) {
+		super(request, METHOD);
+		this.jsonObject = jsonObject;
+	}
+
+	@Override
+	public JsonObject getParams() {
+		return this.jsonObject;
+	}
+
+	/**
+	 * Gets the User Registration information as {@link JsonObject}.
+	 * 
+	 * @return the {@link JsonObject}
+	 */
+	public JsonObject getJsonObject() {
+		return this.jsonObject;
+	}
+
+}

io.openems.backend.common/src/io/openems/backend/common/jsonrpc/request/SetUserInformationRequest.java

@@ -0,0 +1,76 @@
+package io.openems.backend.common.jsonrpc.request;
+
+import com.google.gson.JsonObject;
+
+import io.openems.common.exceptions.OpenemsError.OpenemsNamedException;
+import io.openems.common.jsonrpc.base.JsonrpcRequest;
+import io.openems.common.utils.JsonUtils;
+
+/**
+ * Sets the User Information.
+ * 
+ * <pre>
+ * {
+ *   "jsonrpc": "2.0",
+ *   "id": UUID,
+ *   "method": "setUserInformation",
+ *   "params": {
+ *     "user": {
+ *       "firstname": string,
+ *       "lastname": string,
+ *       "email": string,
+ *       "phone": string,
+ *       "address": {
+ *         "street": string,
+ *         "city": string,
+ *         "zip": string,
+ *         "country": string
+ *       },
+ *       "company": {
+ *         "name": string
+ *       }
+ *     }
+ *   }
+ * }
+ * </pre>
+ */
+public class SetUserInformationRequest extends JsonrpcRequest {
+
+	public static final String METHOD = "setUserInformation";
+
+	/**
+	 * Create {@link SetUserInformationRequest} from a template
+	 * {@link JsonrpcRequest}.
+	 * 
+	 * @param request the template {@link JsonrpcRequest}
+	 * @return Created {@link SetUserInformationRequest}
+	 * @throws OpenemsNamedException on parse error
+	 */
+	public static SetUserInformationRequest from(JsonrpcRequest request) throws OpenemsNamedException {
+		JsonObject params = request.getParams();
+
+		return new SetUserInformationRequest(request, JsonUtils.getAsJsonObject(params, "user"));
+	}
+
+	private final JsonObject jsonObject;
+
+	private SetUserInformationRequest(JsonrpcRequest request, JsonObject jsonObject) {
+		super(request, METHOD);
+		this.jsonObject = jsonObject;
+	}
+
+	@Override
+	public JsonObject getParams() {
+		return this.jsonObject;
+	}
+
+	/**
+	 * Gets the User Information as {@link JsonObject}.
+	 * 
+	 * @return the {@link JsonObject}
+	 */
+	public JsonObject getJsonObject() {
+		return this.jsonObject;
+	}
+
+}