From 539e814e2d7e7e3438cadab07899b0b585c6ae2e Mon Sep 17 00:00:00 2001 From: shamalka Date: Thu, 7 May 2020 22:13:52 +0530 Subject: [PATCH 1/4] Change getEnrollmentQRCode method return type --- .../mgt/common/QREnrollmentPayload.java | 39 +++++++++++++++++++ .../common/spi/DeviceTypeCommonService.java | 3 +- 2 files changed, 41 insertions(+), 1 deletion(-) create mode 100644 components/device-mgt/org.wso2.carbon.device.mgt.common/src/main/java/org/wso2/carbon/device/mgt/common/QREnrollmentPayload.java diff --git a/components/device-mgt/org.wso2.carbon.device.mgt.common/src/main/java/org/wso2/carbon/device/mgt/common/QREnrollmentPayload.java b/components/device-mgt/org.wso2.carbon.device.mgt.common/src/main/java/org/wso2/carbon/device/mgt/common/QREnrollmentPayload.java new file mode 100644 index 00000000000..ce6b725920a --- /dev/null +++ b/components/device-mgt/org.wso2.carbon.device.mgt.common/src/main/java/org/wso2/carbon/device/mgt/common/QREnrollmentPayload.java @@ -0,0 +1,39 @@ +package org.wso2.carbon.device.mgt.common; + +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; + +import java.io.Serializable; +import java.util.List; +import java.util.Map; + +/** + * This class represents the information of QR enrollment payload. + */ +@ApiModel(value = "QREnrollmentPayload", + description = "Details related to QR enrollment to generate QR code.") +public class QREnrollmentPayload implements Serializable { + + @ApiModelProperty(name = "payload", value = "Platform configuration payload to generate QR code.", required = true) + private Map payload; + + @ApiModelProperty(name = "invalidPlatformConfigs", value = "Invalid platform configs to show when an " + + "invalidation occurs.", required = true) + private List invalidPlatformConfigs; + + public Map getPayload() { + return payload; + } + + public void setPayload(Map payload) { + this.payload = payload; + } + + public List getInvalidPlatformConfigs() { + return invalidPlatformConfigs; + } + + public void setInvalidPlatformConfigs(List invalidPlatformConfigs) { + this.invalidPlatformConfigs = invalidPlatformConfigs; + } +} diff --git a/components/device-mgt/org.wso2.carbon.device.mgt.common/src/main/java/org/wso2/carbon/device/mgt/common/spi/DeviceTypeCommonService.java b/components/device-mgt/org.wso2.carbon.device.mgt.common/src/main/java/org/wso2/carbon/device/mgt/common/spi/DeviceTypeCommonService.java index 7b324a565f8..5ab616ffcd6 100644 --- a/components/device-mgt/org.wso2.carbon.device.mgt.common/src/main/java/org/wso2/carbon/device/mgt/common/spi/DeviceTypeCommonService.java +++ b/components/device-mgt/org.wso2.carbon.device.mgt.common/src/main/java/org/wso2/carbon/device/mgt/common/spi/DeviceTypeCommonService.java @@ -17,6 +17,7 @@ package org.wso2.carbon.device.mgt.common.spi; +import org.wso2.carbon.device.mgt.common.QREnrollmentPayload; import org.wso2.carbon.device.mgt.common.exceptions.DeviceManagementException; import java.util.Map; @@ -32,5 +33,5 @@ public interface DeviceTypeCommonService { * @return QR code Map which contains key value pairs to have for the QR String. * @throws DeviceManagementException if error occurred while generating the QR String for Ownership */ - Map getEnrollmentQRCode(String ownershipType) throws DeviceManagementException; + QREnrollmentPayload getEnrollmentQRCode(String ownershipType) throws DeviceManagementException; } From dcb1602752d11ef9e73680db15ff7a63d95c8e9b Mon Sep 17 00:00:00 2001 From: shamalka Date: Thu, 7 May 2020 22:21:38 +0530 Subject: [PATCH 2/4] Add license --- .../device/mgt/common/QREnrollmentPayload.java | 18 ++++++++++++++++++ .../common/spi/DeviceTypeCommonService.java | 2 -- 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/components/device-mgt/org.wso2.carbon.device.mgt.common/src/main/java/org/wso2/carbon/device/mgt/common/QREnrollmentPayload.java b/components/device-mgt/org.wso2.carbon.device.mgt.common/src/main/java/org/wso2/carbon/device/mgt/common/QREnrollmentPayload.java index ce6b725920a..831e4ad836d 100644 --- a/components/device-mgt/org.wso2.carbon.device.mgt.common/src/main/java/org/wso2/carbon/device/mgt/common/QREnrollmentPayload.java +++ b/components/device-mgt/org.wso2.carbon.device.mgt.common/src/main/java/org/wso2/carbon/device/mgt/common/QREnrollmentPayload.java @@ -1,3 +1,21 @@ +/* + * Copyright (c) 2020, Entgra (Pvt) Ltd. (http://www.entgra.io) All Rights Reserved. + * + * Entgra (Pvt) Ltd. licenses this file to you under the Apache License, + * Version 2.0 (the "License"); you may not use this file except + * in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + package org.wso2.carbon.device.mgt.common; import io.swagger.annotations.ApiModel; diff --git a/components/device-mgt/org.wso2.carbon.device.mgt.common/src/main/java/org/wso2/carbon/device/mgt/common/spi/DeviceTypeCommonService.java b/components/device-mgt/org.wso2.carbon.device.mgt.common/src/main/java/org/wso2/carbon/device/mgt/common/spi/DeviceTypeCommonService.java index 5ab616ffcd6..377c9b91e7f 100644 --- a/components/device-mgt/org.wso2.carbon.device.mgt.common/src/main/java/org/wso2/carbon/device/mgt/common/spi/DeviceTypeCommonService.java +++ b/components/device-mgt/org.wso2.carbon.device.mgt.common/src/main/java/org/wso2/carbon/device/mgt/common/spi/DeviceTypeCommonService.java @@ -20,8 +20,6 @@ package org.wso2.carbon.device.mgt.common.spi; import org.wso2.carbon.device.mgt.common.QREnrollmentPayload; import org.wso2.carbon.device.mgt.common.exceptions.DeviceManagementException; -import java.util.Map; - /** * This implementation populates device type plugin management service. */ From 756d73d2cf06426ee0268a28ca4909a6eba3f613 Mon Sep 17 00:00:00 2001 From: shamalka Date: Mon, 11 May 2020 13:35:39 +0530 Subject: [PATCH 3/4] Add optional platform configs --- .../device/mgt/common/QREnrollmentPayload.java | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/components/device-mgt/org.wso2.carbon.device.mgt.common/src/main/java/org/wso2/carbon/device/mgt/common/QREnrollmentPayload.java b/components/device-mgt/org.wso2.carbon.device.mgt.common/src/main/java/org/wso2/carbon/device/mgt/common/QREnrollmentPayload.java index 831e4ad836d..600493ba8de 100644 --- a/components/device-mgt/org.wso2.carbon.device.mgt.common/src/main/java/org/wso2/carbon/device/mgt/common/QREnrollmentPayload.java +++ b/components/device-mgt/org.wso2.carbon.device.mgt.common/src/main/java/org/wso2/carbon/device/mgt/common/QREnrollmentPayload.java @@ -39,6 +39,10 @@ public class QREnrollmentPayload implements Serializable { "invalidation occurs.", required = true) private List invalidPlatformConfigs; + @ApiModelProperty(name = "optionalPlatformConfigs", value = "Optional platform configs to show when an " + + "values are not set.") + private List optionalPlatformConfigs; + public Map getPayload() { return payload; } @@ -54,4 +58,12 @@ public class QREnrollmentPayload implements Serializable { public void setInvalidPlatformConfigs(List invalidPlatformConfigs) { this.invalidPlatformConfigs = invalidPlatformConfigs; } + + public List getOptionalPlatformConfigs() { + return optionalPlatformConfigs; + } + + public void setOptionalPlatformConfigs(List optionalPlatformConfigs) { + this.optionalPlatformConfigs = optionalPlatformConfigs; + } } From 240f157565366c2687a1d7283bb0261769a40790 Mon Sep 17 00:00:00 2001 From: shamalka Date: Mon, 11 May 2020 13:48:13 +0530 Subject: [PATCH 4/4] Improve comments --- .../carbon/device/mgt/common/spi/DeviceTypeCommonService.java | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/components/device-mgt/org.wso2.carbon.device.mgt.common/src/main/java/org/wso2/carbon/device/mgt/common/spi/DeviceTypeCommonService.java b/components/device-mgt/org.wso2.carbon.device.mgt.common/src/main/java/org/wso2/carbon/device/mgt/common/spi/DeviceTypeCommonService.java index 377c9b91e7f..798d4ee58da 100644 --- a/components/device-mgt/org.wso2.carbon.device.mgt.common/src/main/java/org/wso2/carbon/device/mgt/common/spi/DeviceTypeCommonService.java +++ b/components/device-mgt/org.wso2.carbon.device.mgt.common/src/main/java/org/wso2/carbon/device/mgt/common/spi/DeviceTypeCommonService.java @@ -28,7 +28,8 @@ public interface DeviceTypeCommonService { /** * To get Enrollment QR code against Ownership type * - * @return QR code Map which contains key value pairs to have for the QR String. + * @return {@link QREnrollmentPayload} object with payload to generate QR, invalidPlatformConfigs + * and optionalPlatformConfigs. * @throws DeviceManagementException if error occurred while generating the QR String for Ownership */ QREnrollmentPayload getEnrollmentQRCode(String ownershipType) throws DeviceManagementException;