mirror of
https://repository.entgra.net/community/device-mgt-core.git
synced 2025-10-06 02:01:45 +00:00
Merge branch 'master' of https://github.com/wso2/carbon-device-mgt
This commit is contained in:
geethkokila
commit
3bec779e0b
@ -18,12 +18,28 @@
|
||||
|
||||
package org.wso2.carbon.device.mgt.jaxrs.beans;
|
||||
|
||||
import io.swagger.annotations.ApiModel;
|
||||
import io.swagger.annotations.ApiModelProperty;
|
||||
import org.wso2.carbon.user.mgt.common.UIPermissionNode;
|
||||
|
||||
@ApiModel(value = "RoleWrapper", description = "Role details including permission and the users in the roles are " +
|
||||
"wrapped here.")
|
||||
public class RoleWrapper {
|
||||
|
||||
@ApiModelProperty(name = "roleName", value = "The name of the role.", required = true)
|
||||
private String roleName;
|
||||
@ApiModelProperty(name = "permissions", value = "Lists out all the permissions associated with roles.",
|
||||
required = true)
|
||||
private String[] permissions;
|
||||
@ApiModelProperty(name = "users", value = "The list of users assigned to the selected role.",
|
||||
required = true)
|
||||
private String[] users;
|
||||
@ApiModelProperty(name = "permissionList", value = "This contain the following, " +
|
||||
"\n resourcePath\tThe path related to the API.\n " +
|
||||
"displayName\tThe name of the permission that is shown " +
|
||||
"in the UI.\n" +
|
||||
"nodeList\tLists out the nested permissions.",
|
||||
required = true)
|
||||
private UIPermissionNode permissionList;
|
||||
|
||||
public String getRoleName() {
|
||||
|
||||
@ -17,19 +17,38 @@
|
||||
*/
|
||||
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;
|
||||
|
||||
@ApiModel(value = "Device", description = "This class carries all information related to a managed device.")
|
||||
public class Device implements Serializable{
|
||||
|
||||
private static final long serialVersionUID = 1998101711L;
|
||||
|
||||
@ApiModelProperty(name = "id", value = "ID of the device in the WSO2 EMM device information database.",
|
||||
required = true)
|
||||
private int id;
|
||||
@ApiModelProperty(name = "name", value = "The device name that can be set on the device by the device user.",
|
||||
required = true)
|
||||
private String name;
|
||||
@ApiModelProperty(name = "type", value = "The OS type of the device.", required = true)
|
||||
private String type;
|
||||
@ApiModelProperty(name = "description", value = "Additional information on the device.", required = true)
|
||||
private String description;
|
||||
@ApiModelProperty(name = "deviceIdentifier", value = "This is a 64-bit number (as a hex string) that is randomly" +
|
||||
" generated when the user first sets up the device and should" +
|
||||
" remain constant for the lifetime of the user's device." +
|
||||
" The value may change if a factory reset is performed on " +
|
||||
"the device.",
|
||||
required = true)
|
||||
private String deviceIdentifier;
|
||||
@ApiModelProperty(name = "enrolmentInfo", value = "This defines the device registration related information. " +
|
||||
"It is mandatory to define this information.", required = true)
|
||||
private EnrolmentInfo enrolmentInfo;
|
||||
@ApiModelProperty(name = "features", value = "List of features.", required = true)
|
||||
private List<Feature> features;
|
||||
private List<Device.Property> properties;
|
||||
|
||||
|
||||
@ -17,11 +17,19 @@
|
||||
*/
|
||||
package org.wso2.carbon.device.mgt.common;
|
||||
|
||||
import io.swagger.annotations.ApiModel;
|
||||
import io.swagger.annotations.ApiModelProperty;
|
||||
|
||||
import java.io.Serializable;
|
||||
|
||||
|
||||
@ApiModel(value = "DeviceIdentifier", description = "This contains device details that is used to identify a device " +
|
||||
"uniquely.")
|
||||
public class DeviceIdentifier implements Serializable{
|
||||
|
||||
@ApiModelProperty(name = "id", value = "Identity of the device.", required = true)
|
||||
private String id;
|
||||
@ApiModelProperty(name = "type", value = "Type of the device.", required = true)
|
||||
private String type;
|
||||
|
||||
public DeviceIdentifier() {}
|
||||
|
||||
@ -18,8 +18,13 @@
|
||||
*/
|
||||
package org.wso2.carbon.device.mgt.common;
|
||||
|
||||
import io.swagger.annotations.ApiModel;
|
||||
import io.swagger.annotations.ApiModelProperty;
|
||||
|
||||
import java.io.Serializable;
|
||||
|
||||
@ApiModel(value = "EnrolmentInfo", description = "This class carries all information related to a devices enrollment" +
|
||||
" status.")
|
||||
public class EnrolmentInfo implements Serializable {
|
||||
|
||||
private static final long serialVersionUID = 1998101712L;
|
||||
@ -32,12 +37,24 @@ public class EnrolmentInfo implements Serializable {
|
||||
BYOD, COPE
|
||||
}
|
||||
|
||||
@ApiModelProperty(name = "id", value = "ID of the device in the WSO2 EMM device information database.",
|
||||
required = true)
|
||||
private int id;
|
||||
@ApiModelProperty(name = "device", value = "Enrolled device.", required = true)
|
||||
private Device device;
|
||||
@ApiModelProperty(name = "dateOfEnrolment", value = "Date of the device enrollment.", required = true )
|
||||
private Long dateOfEnrolment;
|
||||
@ApiModelProperty(name = "dateOfLastUpdate", value = "Date of the device's last update.", required = true )
|
||||
private Long dateOfLastUpdate;
|
||||
@ApiModelProperty(name = "ownership", value = "Defines the ownership details. The ownership type can be any of the" +
|
||||
" following values.\n" +
|
||||
"BYOD - Bring your own device (BYOD).\n" +
|
||||
"COPE - Corporate owned personally enabled (COPE).", required = true )
|
||||
private OwnerShip ownership;
|
||||
@ApiModelProperty(name = "status", value = "Current status of the device, such as whether the device " +
|
||||
"is active, removed etc.", required = true )
|
||||
private Status status;
|
||||
@ApiModelProperty(name = "owner", value = "The device owner's name.", required = true )
|
||||
private String owner;
|
||||
|
||||
public EnrolmentInfo() {
|
||||
|
||||
@ -22,15 +22,26 @@ import java.io.Serializable;
|
||||
import java.util.List;
|
||||
import io.swagger.annotations.*;
|
||||
|
||||
@ApiModel(value = "Feature", description = "This class carries all information related to a devices enrollment" +
|
||||
" status.")
|
||||
public class Feature implements Serializable {
|
||||
|
||||
@ApiModelProperty(name = "id", value = "Feature Id.", required = true )
|
||||
private int id;
|
||||
@ApiModelProperty(name = "code", value = "The code of the feature. For example the code to lock a device" +
|
||||
" is DEVICE_LOCK.", required = true )
|
||||
private String code;
|
||||
@ApiModelProperty(name = "name", value = "A name that describes a feature.", required = true )
|
||||
private String name;
|
||||
@ApiModelProperty(name = "description", value = "Provides a description of the features..", required = true )
|
||||
private String description;
|
||||
@ApiModelProperty(name = "deviceType", value = "Provide the device type for the respective feature. " +
|
||||
"Features allow you to perform operations on any device type, " +
|
||||
"such as android, iOS or windows..", required = true )
|
||||
private String deviceType;
|
||||
private String method;
|
||||
private String type;
|
||||
@ApiModelProperty(name = "metadataEntries", value = "Properties related to features.", required = true )
|
||||
private List<MetadataEntry> metadataEntries;
|
||||
|
||||
@XmlElement
|
||||
|
||||
@ -19,6 +19,8 @@
|
||||
|
||||
package org.wso2.carbon.device.mgt.common.device.details;
|
||||
|
||||
import io.swagger.annotations.ApiModel;
|
||||
import io.swagger.annotations.ApiModelProperty;
|
||||
import org.wso2.carbon.device.mgt.common.DeviceIdentifier;
|
||||
|
||||
import java.io.Serializable;
|
||||
@ -26,34 +28,60 @@ import java.util.Date;
|
||||
import java.util.HashMap;
|
||||
import java.util.Map;
|
||||
|
||||
@ApiModel(value = "DeviceInfo", description = "This class carries all information related to the device information " +
|
||||
"provided by a device.")
|
||||
public class DeviceInfo implements Serializable {
|
||||
|
||||
private static final long serialVersionUID = 1998101733L;
|
||||
|
||||
@ApiModelProperty(name = "deviceId", value = "Device Id.", required = true)
|
||||
private int deviceId;
|
||||
@ApiModelProperty(name = "deviceType", value = "Type of the device.", required = true)
|
||||
private String deviceType;
|
||||
@ApiModelProperty(name = "deviceId", value = "Device identifier.", required = true)
|
||||
private DeviceIdentifier deviceIdentifier;
|
||||
|
||||
@ApiModelProperty(name = "IMEI", value = "IMEI number of the device.", required = true)
|
||||
private String IMEI;
|
||||
@ApiModelProperty(name = "IMSI", value = "IMSI number of the device.", required = true)
|
||||
private String IMSI;
|
||||
@ApiModelProperty(name = "deviceModel", value = "Model of the device.", required = true)
|
||||
private String deviceModel;
|
||||
@ApiModelProperty(name = "vendor", value = "Vendor of the device.", required = true)
|
||||
private String vendor;
|
||||
@ApiModelProperty(name = "osVersion", value = "Operating system version.", required = true)
|
||||
private String osVersion;
|
||||
@ApiModelProperty(name = "batteryLevel", value = "Battery level of the device.", required = true)
|
||||
private Double batteryLevel;
|
||||
@ApiModelProperty(name = "internalTotalMemory", value = "Total internal memory of the device.", required = true)
|
||||
private Double internalTotalMemory;
|
||||
@ApiModelProperty(name = "internalAvailableMemory", value = "Total available memory of the device.",
|
||||
required = true)
|
||||
private Double internalAvailableMemory;
|
||||
@ApiModelProperty(name = "externalTotalMemory", value = "Total external memory of the device.", required = true)
|
||||
private Double externalTotalMemory;
|
||||
@ApiModelProperty(name = "externalAvailableMemory", value = "Total external memory avilable of the device.",
|
||||
required = true)
|
||||
private Double externalAvailableMemory;
|
||||
@ApiModelProperty(name = "operator", value = "Mobile operator of the device.", required = true)
|
||||
private String operator;
|
||||
@ApiModelProperty(name = "connectionType", value = "How the device is connected to the network.", required = true)
|
||||
private String connectionType;
|
||||
@ApiModelProperty(name = "mobileSignalStrength", value = "Current mobile signal strength.", required = true)
|
||||
private Double mobileSignalStrength;
|
||||
@ApiModelProperty(name = "ssid", value = "ssid of the connected WiFi.", required = true)
|
||||
private String ssid;
|
||||
@ApiModelProperty(name = "cpuUsage", value = "Current total cpu usage.", required = true)
|
||||
private Double cpuUsage;
|
||||
@ApiModelProperty(name = "totalRAMMemory", value = "Total Ram memory size.", required = true)
|
||||
private Double totalRAMMemory;
|
||||
@ApiModelProperty(name = "availableRAMMemory", value = "Available total memory of RAM.", required = true)
|
||||
private Double availableRAMMemory;
|
||||
@ApiModelProperty(name = "pluggedIn", value = "Whether the device is plugged into power or not.",
|
||||
required = true)
|
||||
private boolean pluggedIn;
|
||||
@ApiModelProperty(name = "updatedTime", value = "Device updated time.", required = true)
|
||||
private Date updatedTime;
|
||||
|
||||
@ApiModelProperty(name = "deviceDetailsMap", value = ".", required = true)
|
||||
private Map<String, String> deviceDetailsMap = new HashMap<>();
|
||||
|
||||
public int getDeviceId() {
|
||||
|
||||
@ -19,27 +19,41 @@
|
||||
|
||||
package org.wso2.carbon.device.mgt.common.device.details;
|
||||
|
||||
import io.swagger.annotations.ApiModel;
|
||||
import io.swagger.annotations.ApiModelProperty;
|
||||
import org.wso2.carbon.device.mgt.common.DeviceIdentifier;
|
||||
|
||||
import java.io.Serializable;
|
||||
import java.util.Date;
|
||||
|
||||
@ApiModel(value = "DeviceLocation", description = "This class carries all information related to the device location " +
|
||||
"details provided by a device.")
|
||||
public class DeviceLocation implements Serializable {
|
||||
|
||||
private static final long serialVersionUID = 1998101722L;
|
||||
|
||||
@ApiModelProperty(name = "deviceId", value = "Device id", required = true)
|
||||
private int deviceId;
|
||||
@ApiModelProperty(name = "deviceIdentifier", value = "Device identifier used to identify a device uniquely.",
|
||||
required = true)
|
||||
private DeviceIdentifier deviceIdentifier;
|
||||
@ApiModelProperty(name = "latitude", value = "Device GPS latitude.", required = true)
|
||||
private Double latitude;
|
||||
@ApiModelProperty(name = "longitude", value = "Device GPS longitude.", required = true)
|
||||
private Double longitude;
|
||||
|
||||
@ApiModelProperty(name = "street1", value = "First line of the address.", required = true)
|
||||
private String street1;
|
||||
@ApiModelProperty(name = "street2", value = "Second part of the address.", required = true)
|
||||
private String street2;
|
||||
|
||||
@ApiModelProperty(name = "city", value = "City of the device location.", required = true)
|
||||
private String city;
|
||||
@ApiModelProperty(name = "state", value = "State of the device address.", required = true)
|
||||
private String state;
|
||||
@ApiModelProperty(name = "zip", value = "Zip code of the device address.", required = true)
|
||||
private String zip;
|
||||
@ApiModelProperty(name = "country", value = "Country of the device address.", required = true)
|
||||
private String country;
|
||||
@ApiModelProperty(name = "updatedTime", value = "Update time of the device.", required = true)
|
||||
private Date updatedTime;
|
||||
|
||||
public int getDeviceId() {
|
||||
|
||||
@ -19,14 +19,23 @@
|
||||
|
||||
package org.wso2.carbon.device.mgt.common.device.details;
|
||||
|
||||
import io.swagger.annotations.ApiModel;
|
||||
import io.swagger.annotations.ApiModelProperty;
|
||||
import org.wso2.carbon.device.mgt.common.Device;
|
||||
import org.wso2.carbon.device.mgt.common.DeviceIdentifier;
|
||||
|
||||
@ApiModel(value = "DeviceWrapper", description = "This contains device details including, " +
|
||||
"location and device meta information.")
|
||||
public class DeviceWrapper {
|
||||
|
||||
@ApiModelProperty(name = "device", value = "Device's basic information", required = true)
|
||||
private Device device;
|
||||
@ApiModelProperty(name = "deviceIdentifier", value = "Device identifier used to identify a device.",
|
||||
required = true)
|
||||
private DeviceIdentifier deviceIdentifier;
|
||||
@ApiModelProperty(name = "deviceInfo", value = "Device's runtime information", required = true)
|
||||
private DeviceInfo deviceInfo;
|
||||
@ApiModelProperty(name = "deviceLocation", value = "Device's current location", required = true)
|
||||
private DeviceLocation deviceLocation;
|
||||
|
||||
public Device getDevice() {
|
||||
|
||||
@ -18,6 +18,9 @@
|
||||
|
||||
package org.wso2.carbon.device.mgt.common.operation.mgt;
|
||||
|
||||
import io.swagger.annotations.ApiModel;
|
||||
import io.swagger.annotations.ApiModelProperty;
|
||||
|
||||
import javax.xml.bind.annotation.XmlElement;
|
||||
import javax.xml.bind.annotation.XmlRootElement;
|
||||
import java.io.Serializable;
|
||||
@ -25,6 +28,8 @@ import java.util.List;
|
||||
import java.util.Properties;
|
||||
|
||||
@XmlRootElement
|
||||
@ApiModel(value = "Operation", description = "This class carries all information related to a operations that can be " +
|
||||
"applied on a device.")
|
||||
public class Operation implements Serializable {
|
||||
|
||||
public enum Type {
|
||||
@ -39,17 +44,51 @@ public class Operation implements Serializable {
|
||||
REPEAT, NO_REPEAT, PAUSE_SEQUENCE, STOP_SEQUENCE
|
||||
}
|
||||
|
||||
@ApiModelProperty(name = "code", value = "The code of the operation that you carried out. For example the code of" +
|
||||
" the operation carried out to device info operation is DEVICE_INFO.",
|
||||
required = true)
|
||||
private String code;
|
||||
@ApiModelProperty(name = "properties", value = "Properties of an operation containing meta information.",
|
||||
required = true)
|
||||
private Properties properties;
|
||||
@ApiModelProperty(name = "type", value = "The operation type that was carried out on the device. " +
|
||||
"The operations types can be one of the following: COMMAND, PROFILE",
|
||||
required = true)
|
||||
private Type type;
|
||||
@ApiModelProperty(name = "id", value = "The operations carried out on a device is recorded in a database table. " +
|
||||
"The ID of the operation in the database table is given as the ID " +
|
||||
"in the output.",
|
||||
required = true)
|
||||
private int id;
|
||||
@ApiModelProperty(name = "status", value = "The status of the operation that has been carried out on a device. The" +
|
||||
" operation status can be any one of the following:\n" +
|
||||
"IN-PROGRESS - The operation is processing on the EMM server" +
|
||||
" side and has not yet been delivered to the device.\n" +
|
||||
"PENDING - The operation is delivered to the device but the response " +
|
||||
"from the device is pending.\n" +
|
||||
"COMPLETED - The operation is delivered to the device and the server has " +
|
||||
"received a response back from the device.\n" +
|
||||
"ERROR - An error has occurred while carrying out the operation.",
|
||||
required = true)
|
||||
private Status status;
|
||||
@ApiModelProperty(name = "control", value = "How the operation should be executed.", required = true)
|
||||
private Control control;
|
||||
@ApiModelProperty(name = "receivedTimeStamp", value = "The time WSO2 EMM received the response from the device.",
|
||||
required = true)
|
||||
private String receivedTimeStamp;
|
||||
@ApiModelProperty(name = "createdTimeStamp", value = "The time when the operation was requested to be carried out.",
|
||||
required = true)
|
||||
private String createdTimeStamp;
|
||||
@ApiModelProperty(name = "isEnabled", value = "If the assigned value is true it indicates that a policy is " +
|
||||
"enforced on the device. If the assigned value is false it indicates" +
|
||||
" that a policy is not enforced on a device.", required = true)
|
||||
private boolean isEnabled;
|
||||
@ApiModelProperty(name = "payLoad", value = "Payload of the operation to be sent to the device", required = true)
|
||||
private Object payLoad;
|
||||
@ApiModelProperty(name = "operationResponse", value = "Response received from the device", required = true)
|
||||
private String operationResponse;
|
||||
@ApiModelProperty(name = "activityId", value = "The identifier used to identify the operation uniquely.",
|
||||
required = true)
|
||||
private String activityId;
|
||||
private List<OperationResponse> responses;
|
||||
|
||||
|
||||
@ -19,12 +19,74 @@
|
||||
|
||||
package org.wso2.carbon.device.mgt.common.search;
|
||||
|
||||
import io.swagger.annotations.ApiModel;
|
||||
import io.swagger.annotations.ApiModelProperty;
|
||||
|
||||
@ApiModel(value = "Condition", description = "Contains the advance search parameters.")
|
||||
public class Condition {
|
||||
|
||||
@ApiModelProperty(name = "conditions", value = "Provide the operation code. You can assign the following operation " +
|
||||
"codes:\n" +
|
||||
"DEVICE_MODEL : The model of the device.\n" +
|
||||
"VENDOR : The name of the device vendor.\n" +
|
||||
"OS_VERSION : The version of the device operating system.\n" +
|
||||
"BATTERY_LEVEL : The current level of the device battery.\n" +
|
||||
"INTERNAL_TOTAL_MEMORY : The total capacity of the internal memory" +
|
||||
" available in the device.\n" +
|
||||
"INTERNAL_AVAILABLE_MEMORY : The internal memory in the device " +
|
||||
"that is available.\n" +
|
||||
"EXTERNAL_TOTAL_MEMORY : The total capacity of the external memory " +
|
||||
"available in the device.\n" +
|
||||
"EXTERNAL_AVAILABLE_MEMORY : The external memory in the device" +
|
||||
" that is available.\n" +
|
||||
"CONNECTION_TYPE : Define if the device is connected to the GPRS " +
|
||||
"or Wi-Fi settings.\n" +
|
||||
"SSID : The name of the Wifi network that the device is " +
|
||||
"connected to.\n" +
|
||||
"CPU_USAGE : The current CPU usage of the mobile device.\n" +
|
||||
"TOTAL_RAM_MEMORY : The total capacity of the random access " +
|
||||
"memory available in the device.\n" +
|
||||
"AVAILABLE_RAM_MEMORY : The random access memory capacity " +
|
||||
"in the device that is available.\n" +
|
||||
"PLUGGED_IN : Define true if the device is plugged in for charging " +
|
||||
"or define false if the device is not plugged in for charging.",
|
||||
required = true)
|
||||
private String key;
|
||||
@ApiModelProperty(name = "value", value = "Define the value for the key you provide.\n" +
|
||||
"Example: If you provide the key as VERSION, you can provide the " +
|
||||
"value as 5.1, which indicates the version of the mobile device you" +
|
||||
" are searching.",
|
||||
required = true)
|
||||
private String value;
|
||||
@ApiModelProperty(name = "operator", value = "Define the search condition between the key and the value you " +
|
||||
"provide. The following values can be used to define the search " +
|
||||
"condition:\n" +
|
||||
"= : Searches for devices where the key is equal to the value " +
|
||||
"provided.\n" +
|
||||
"=! : Searches for devices where the key is not equal to the " +
|
||||
"value provided.\n" +
|
||||
"<= : Searches for devices where the key is greater than or equal" +
|
||||
" to the value provide.\n" +
|
||||
">= : Searches for devices where the key is less than or equal to" +
|
||||
" the value provided.\n" +
|
||||
"> : Searches for devices where the key is greater than the value" +
|
||||
" provided.\n" +
|
||||
"< : Searches for devices where the key is less than the value " +
|
||||
"provided.\n" +
|
||||
"Example: If you wish to get the devises that have the version " +
|
||||
"as 5.1, you need to use the = operator..",
|
||||
required = true)
|
||||
public String operator;
|
||||
|
||||
@ApiModelProperty(name = "conditions", value = "There can be many search options as shown in the sample JSON " +
|
||||
"definition. The field that connects the independent search " +
|
||||
"options, is known as state.\n" +
|
||||
"The following values can be assigned to state.\n" +
|
||||
"AND : Defines if you want the search result to match all the " +
|
||||
"search conditions provided.\n" +
|
||||
"OR : Defines if you want the search result to match either of" +
|
||||
" the search conditions provided.",
|
||||
required = true)
|
||||
private State state;
|
||||
|
||||
public enum State {
|
||||
|
||||
@ -19,10 +19,17 @@
|
||||
|
||||
package org.wso2.carbon.device.mgt.common.search;
|
||||
|
||||
import io.swagger.annotations.ApiModel;
|
||||
import io.swagger.annotations.ApiModelProperty;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
|
||||
@ApiModel(value = "SearchContext", description = "Search details when carrying out a search contain in this class.")
|
||||
public class SearchContext {
|
||||
|
||||
@ApiModelProperty(name = "conditions", value = "Contains the advance search parameters.",
|
||||
required = true)
|
||||
private List<Condition> conditions;
|
||||
// private int start;
|
||||
// private int end;
|
||||
|
||||
Loading…
Reference in New Issue
Block a user