com.arm.mbed.cloud.sdk.devicedirectory.model.Device Maven / Gradle / Ivy
Show all versions of foundation-models Show documentation
package com.arm.mbed.cloud.sdk.devicedirectory.model;
import java.net.URL;
import java.util.Date;
import java.util.Map;
import com.arm.mbed.cloud.sdk.annotations.DefaultValue;
import com.arm.mbed.cloud.sdk.annotations.Internal;
import com.arm.mbed.cloud.sdk.annotations.NonNull;
import com.arm.mbed.cloud.sdk.annotations.Preamble;
import com.arm.mbed.cloud.sdk.common.SdkModel;
@Preamble(description = "Device model")
public class Device implements SdkModel {
private static final String NOW = "now()";
private static final String NULL = "null";
/**
* serialisation id.
*/
private static final long serialVersionUID = -8965559644581108099L;
/**
* The ID of the device.
*/
private String id;
/**
* The owning IAM account ID.
*/
private final String accountId;
/**
* The time the device was created.
*/
@DefaultValue(value = NOW)
private final Date createdAt;
/**
* The time the device was updated.
*/
@DefaultValue(value = NOW)
private final Date updatedAt;
/**
* The time the device was claimed.
*/
@DefaultValue(value = NOW)
private final Date claimedAt;
/**
* The timestamp of the current manifest version.
*/
@DefaultValue(value = NOW)
private final Date manifestTimestamp;
/**
* ID of the issuer of the certificate.
*
* This is the value of the CN field (in the Subject) of the Issuer of the certificate.
*/
private String certificateIssuerId;
/**
* Fingerprint of the device certificate.
*
* This is not part of the certificate but rather the SH-256 hash of the certificate.
*/
private String certificateFingerprint;
/**
* The name of the device.
*/
private String name;
/**
* The alias of the device.
*/
private String alias;
/**
* The description of the device.
*/
private String description;
/**
* The type of the device - e.g. if the device is a gateway.
*/
private String deviceType;
/**
* The device name of the host gateway, if appropriate.
*/
private String hostGateway;
/**
* Up to 5 custom attributes.
*/
Map customAttributes;
/**
* The current state of the device.
*/
private DeviceState state;
/**
* The device class.
*/
private String deviceClass;
/**
* The device class.
*/
@DefaultValue(value = NULL)
private Integer deviceExecutionMode;
/**
* The serial number of the device.
*/
private String serialNumber;
/**
* The device vendor ID.
*/
private String vendorId;
/**
* Expiration date of the certificate used to connect to connector server.
*/
@DefaultValue(value = NULL)
private Date connectorCertificateExpiration;
/**
* Expiration date of the certificate used to connect to bootstrap server.
*/
@DefaultValue(value = NULL)
private Date bootstrapCertificateExpiration;
/**
* The time the device was bootstrapped.
*/
@DefaultValue(value = NULL)
private Date bootstrappedTimestamp;
/**
* The ID of the channel used to communicate with the device.
*/
private MechanismType mechanism;
/**
* The address of the connector to use.
*/
private URL mechanismUrl;
/**
* The SHA256 checksum of the current firmware image.
*/
private String firmwareChecksum;
/**
* Internal constructor.
*
* Note: Should not be used. Use {@link #Device()} instead.
*
* @param id
* id
* @param accountId
* accountId
* @param createdAt
* createdAt
* @param updatedAt
* updatedAt
* @param claimedAt
* claimedAt
* @param manifestTimestamp
* manifest timestamp
*/
@Internal
public Device(String id, String accountId, Date createdAt, Date updatedAt, Date claimedAt, Date manifestTimestamp) {
this(id, accountId, createdAt, updatedAt, claimedAt, manifestTimestamp, null, null, null, null, null, null,
null, null, null, null, null, null, null, null, null, null, null, null, null);
}
/**
* Internal constructor.
*
* Note: Should not be used. Use {@link #Device()} instead.
*
* @param device
* a device to clone
*/
@Internal
protected Device(@NonNull Device device) {
this(device.id, device.accountId, device.createdAt, device.updatedAt, device.claimedAt,
device.manifestTimestamp, device.certificateIssuerId, device.certificateFingerprint, device.name,
device.alias, device.description, device.deviceType, device.hostGateway, device.customAttributes,
device.state, device.deviceClass, device.deviceExecutionMode, device.serialNumber, device.vendorId,
device.connectorCertificateExpiration, device.bootstrapCertificateExpiration, device.bootstrappedTimestamp,
device.mechanism, device.mechanismUrl, device.firmwareChecksum);
}
/**
* Internal constructor.
*
* Note: Should not be used. Use {@link #Device()} instead.
*
* @param id
* id
* @param accountId
* account id
* @param createdAt
* creation date
* @param updatedAt
* last update date
* @param claimedAt
* last claim date
* @param manifestTimestamp
* manifest timestamp
* @param certificateIssuerId
* certificate issuer id
* @param certificateFingerprint
* certificate fingerprint
* @param name
* name
* @param alias
* alias
* @param description
* description
* @param deviceType
* device type
* @param hostGateway
* host gateway
* @param customAttributes
* custom attributes
* @param state
* state
* @param deviceClass
* device class
* @param deviceExecutionMode
* device execution mode
* @param serialNumber
* serial number
* @param vendorId
* vendor id
* @param connectorCertificateExpiration
* connector certificate expiry date
* @param bootstrapCertificateExpiration
* bootstrap certificate expiry date
* @param bootstrappedTimestamp
* bootstrapped timestamp
* @param mechanism
* mechanism
* @param mechanismUrl
* mechanism URL
* @param firmwareChecksum
* firmware checksum
*/
@Internal
public Device(String id, String accountId, Date createdAt, Date updatedAt, Date claimedAt, Date manifestTimestamp,
String certificateIssuerId, String certificateFingerprint, String name, String alias,
String description, String deviceType, String hostGateway, Map customAttributes,
DeviceState state, String deviceClass, Integer deviceExecutionMode, String serialNumber,
String vendorId, Date connectorCertificateExpiration, Date bootstrapCertificateExpiration,
Date bootstrappedTimestamp, MechanismType mechanism, URL mechanismUrl, String firmwareChecksum) {
super();
this.id = id;
this.accountId = accountId;
this.createdAt = createdAt;
this.updatedAt = updatedAt;
this.claimedAt = claimedAt;
this.manifestTimestamp = manifestTimestamp;
setCertificateIssuerId(certificateIssuerId);
setCertificateFingerprint(certificateFingerprint);
setName(name);
setAlias(alias);
setDescription(description);
setDeviceType(deviceType);
setHostGateway(hostGateway);
setCustomAttributes(customAttributes);
setState(state);
setDeviceClass(deviceClass);
setDeviceExecutionMode(deviceExecutionMode);
setSerialNumber(serialNumber);
setVendorId(vendorId);
setConnectorCertificateExpiration(connectorCertificateExpiration);
setBootstrapCertificateExpiration(bootstrapCertificateExpiration);
setBootstrappedTimestamp(bootstrappedTimestamp);
setMechanismUrl(mechanismUrl);
setFirmwareChecksum(firmwareChecksum);
setMechanism(mechanism);
}
/**
* Constructor.
*/
public Device() {
this(null, null, new Date(), new Date(), new Date(), new Date());
}
/**
* Constructor.
*
* @param certificateIssuerId
* ID of the issuer of the certificate
* @param certificateFingerprint
* Fingerprint of the device certificate
*/
public Device(String certificateIssuerId, String certificateFingerprint) {
this();
setCertificateFingerprint(certificateFingerprint);
setCertificateIssuerId(certificateIssuerId);
}
/**
* Gets id.
*
* @return the id
*/
@Override
public String getId() {
return id;
}
/**
* Sets id.
*
* @param id
* the id to set
*/
@Override
public void setId(String id) {
this.id = id;
}
/**
* Sets id.
*
* Similar to {@link #setId(String)}
*
* @param id
* the id to set
*/
@Internal
public void setDeviceId(String id) {
setId(id);
}
/**
* Gets certificate issuer id.
*
* This is the value of the CN field (in the Subject) of the Issuer of the certificate.
*
* @return the certificateIssuerId
*/
public String getCertificateIssuerId() {
return certificateIssuerId;
}
/**
* Sets certificate issuer id.
*
* This is the value of the CN field (in the Subject) of the Issuer of the certificate.
*
* @param certificateIssuerId
* the certificateIssuerId to set
*/
public void setCertificateIssuerId(String certificateIssuerId) {
this.certificateIssuerId = certificateIssuerId;
}
/**
* Gets certificate fingerprint.
*
* This is not part of the certificate but rather the SH-256 hash of the certificate.
*
* @return the certificateFingerprint
*/
public String getCertificateFingerprint() {
return certificateFingerprint;
}
/**
* Sets certificate fingerprint.
*
* This is not part of the certificate but rather the SH-256 hash of the certificate.
*
* @param certificateFingerprint
* the certificateFingerprint to set
*/
public void setCertificateFingerprint(String certificateFingerprint) {
this.certificateFingerprint = certificateFingerprint;
}
/**
* Gets the name.
*
* @return the name
*/
public String getName() {
return name;
}
/**
* Sets the name.
*
* @param name
* the name to set
*/
public void setName(String name) {
this.name = name;
}
/**
* Gets alias.
*
* @return the alias
*/
public String getAlias() {
return alias;
}
/**
* Sets alias.
*
* @param alias
* the alias to set
*/
public void setAlias(String alias) {
this.alias = alias;
}
/**
* Gets description.
*
* @return the description
*/
public String getDescription() {
return description;
}
/**
* Sets description.
*
* @param description
* the description to set
*/
public void setDescription(String description) {
this.description = description;
}
/**
* Gets device type.
*
* @return the deviceType
*/
public String getDeviceType() {
return deviceType;
}
/**
* Sets device type.
*
* @param deviceType
* the deviceType to set
*/
public void setDeviceType(String deviceType) {
this.deviceType = deviceType;
}
/**
* Gets host gateway.
*
* @return the hostGateway
*/
public String getHostGateway() {
return hostGateway;
}
/**
* Sets host gateway.
*
* @param hostGateway
* the hostGateway to set
*/
public void setHostGateway(String hostGateway) {
this.hostGateway = hostGateway;
}
/**
* Gets custom attributes.
*
* @return the customAttributes
*/
public Map getCustomAttributes() {
return customAttributes;
}
/**
* Sets custom attributes.
*
* @param customAttributes
* the customAttributes to set
*/
public void setCustomAttributes(Map customAttributes) {
this.customAttributes = customAttributes;
}
/**
* Gets state.
*
* @return the state
*/
public DeviceState getState() {
return state;
}
/**
* States whether the device is connected or not.
*
* @return True if the device is connected. False otherwise.
*/
public boolean isConnected() {
return (state == null) ? false : state.isConnected();
}
/**
* Sets state.
*
* @param state
* the state to set
*/
public void setState(DeviceState state) {
this.state = state;
}
/**
* Gets device class.
*
* @return the deviceClass
*/
public String getDeviceClass() {
return deviceClass;
}
/**
* Sets device class.
*
* @param deviceClass
* the deviceClass to set
*/
public void setDeviceClass(String deviceClass) {
this.deviceClass = deviceClass;
}
/**
* Gets device execution mode.
*
* @return the deviceExecutionMode
*/
public Integer getDeviceExecutionMode() {
return deviceExecutionMode;
}
/**
* Set device execution mode.
*
* @param deviceExecutionMode
* the deviceExecutionMode to set
*/
public void setDeviceExecutionMode(Integer deviceExecutionMode) {
this.deviceExecutionMode = deviceExecutionMode;
}
/**
* Gets serial number.
*
* @return the serialNumber
*/
public String getSerialNumber() {
return serialNumber;
}
/**
* Sets serial number.
*
* @param serialNumber
* the serialNumber to set
*/
public void setSerialNumber(String serialNumber) {
this.serialNumber = serialNumber;
}
/**
* Gets vendor id.
*
* @return the vendorId
*/
public String getVendorId() {
return vendorId;
}
/**
* Sets vendor id.
*
* @param vendorId
* the vendorId to set
*/
public void setVendorId(String vendorId) {
this.vendorId = vendorId;
}
/**
* Gets connector certificate expiry date.
*
* @return the connectorCertificateExpiration
*/
public Date getConnectorCertificateExpiration() {
return connectorCertificateExpiration;
}
/**
* Set connector certificate expiry date.
*
* @param connectorCertificateExpiration
* the connectorCertificateExpiration to set
*/
public void setConnectorCertificateExpiration(Date connectorCertificateExpiration) {
this.connectorCertificateExpiration = connectorCertificateExpiration;
}
/**
* Gets bootstrap certificate expiry date.
*
* @return the bootstrapCertificateExpiration
*/
public Date getBootstrapCertificateExpiration() {
return bootstrapCertificateExpiration;
}
/**
* Sets bootstrap certificate expiry date.
*
* @param bootstrapCertificateExpiration
* the bootstrapCertificateExpiration to set
*/
public void setBootstrapCertificateExpiration(Date bootstrapCertificateExpiration) {
this.bootstrapCertificateExpiration = bootstrapCertificateExpiration;
}
/**
* Gets bootstrapped timestamp.
*
* @return the bootstrappedTimestamp
*/
public Date getBootstrappedTimestamp() {
return bootstrappedTimestamp;
}
/**
* Sets bootstrapped timestamp.
*
* @param bootstrappedTimestamp
* the bootstrappedTimestamp to set
*/
public void setBootstrappedTimestamp(Date bootstrappedTimestamp) {
this.bootstrappedTimestamp = bootstrappedTimestamp;
}
/**
* Gets mechanism URL.
*
* @return the mechanismUrl
*/
public URL getMechanismUrl() {
return mechanismUrl;
}
/**
* Sets mechanism URL.
*
* @param mechanismUrl
* the mechanismUrl to set
*/
public void setMechanismUrl(URL mechanismUrl) {
this.mechanismUrl = mechanismUrl;
}
/**
* Gets firmware checksum.
*
* @return the firmwareChecksum
*/
public String getFirmwareChecksum() {
return firmwareChecksum;
}
/**
* Set firmware checksum.
*
* @param firmwareChecksum
* the firmwareChecksum to set
*/
public void setFirmwareChecksum(String firmwareChecksum) {
this.firmwareChecksum = firmwareChecksum;
}
/**
* Gets account id.
*
* @return the accountId
*/
public String getAccountId() {
return accountId;
}
/**
* Gets creation date.
*
* @return the createdAt
*/
public Date getCreatedAt() {
return createdAt;
}
/**
* Gets last update date.
*
* @return the updatedAt
*/
public Date getUpdatedAt() {
return updatedAt;
}
/**
* Gets last claim date.
*
* @return the claimedAt
*/
public Date getClaimedAt() {
return claimedAt;
}
/**
* Sets manifest timestamp.
*
* @return the manifestTimestamp
*/
public Date getManifestTimestamp() {
return manifestTimestamp;
}
/**
* Gets mechanism.
*
* @return the mechanism
*/
public MechanismType getMechanism() {
return mechanism;
}
/**
* Sets mechanism.
*
* @param mechanism
* the mechanism to set
*/
public void setMechanism(MechanismType mechanism) {
this.mechanism = mechanism;
}
/**
* Gets clone.
*
* @return clone
*
* @see java.lang.Object#clone()
*/
@Override
public Device clone() {
return new Device(this);
}
/**
* Determines whether all required fields have been set and therefore if the model instance is valid.
*
* @return true if instance is valid. False otherwise.
*/
@Override
public boolean isValid() {
return true;
}
/*
* (non-Javadoc)
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
return "Device [id=" + id + ", accountId=" + accountId + ", createdAt=" + createdAt + ", updatedAt=" + updatedAt
+ ", claimedAt=" + claimedAt + ", manifestTimestamp=" + manifestTimestamp + ", certificateIssuerId="
+ certificateIssuerId + ", certificateFingerprint=" + certificateFingerprint + ", name=" + name
+ ", alias=" + alias + ", description=" + description + ", deviceType=" + deviceType + ", hostGateway="
+ hostGateway + ", customAttributes=" + customAttributes + ", state=" + state + ", deviceClass="
+ deviceClass + ", deviceExecutionMode=" + deviceExecutionMode + ", serialNumber=" + serialNumber
+ ", vendorId=" + vendorId + ", connectorCertificateExpiration=" + connectorCertificateExpiration
+ ", bootstrapCertificateExpiration=" + bootstrapCertificateExpiration + ", bootstrappedTimestamp="
+ bootstrappedTimestamp + ", mechanism=" + mechanism + ", mechanismUrl=" + mechanismUrl
+ ", firmwareChecksum=" + firmwareChecksum + "]";
}
}