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..600493ba8de --- /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,69 @@ +/* + * 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; +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; + + @ApiModelProperty(name = "optionalPlatformConfigs", value = "Optional platform configs to show when an " + + "values are not set.") + private List optionalPlatformConfigs; + + 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; + } + + public List getOptionalPlatformConfigs() { + return optionalPlatformConfigs; + } + + public void setOptionalPlatformConfigs(List optionalPlatformConfigs) { + this.optionalPlatformConfigs = optionalPlatformConfigs; + } +} 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..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 @@ -17,10 +17,9 @@ 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. */ @@ -29,8 +28,9 @@ 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 */ - Map getEnrollmentQRCode(String ownershipType) throws DeviceManagementException; + QREnrollmentPayload getEnrollmentQRCode(String ownershipType) throws DeviceManagementException; }