com.arm.mbed.cloud.sdk.security.model.CertificateIssuer Maven / Gradle / Ivy
// This file was generated by the Pelion SDK foundation code generator.
// This is an autogenerated class. Do not modify its content as modifications will be lost at next code generation.
package com.arm.mbed.cloud.sdk.security.model;
import com.arm.mbed.cloud.sdk.annotations.Internal;
import com.arm.mbed.cloud.sdk.annotations.Preamble;
import com.arm.mbed.cloud.sdk.annotations.Required;
import com.arm.mbed.cloud.sdk.common.SdkModel;
import java.util.Date;
import java.util.Map;
/**
* Model for a certificate issuer.
*/
@Preamble(description = "Model for a certificate issuer.")
@SuppressWarnings("PMD.AvoidDuplicateLiterals")
public class CertificateIssuer implements SdkModel {
/**
* Serialisation Id.
*/
private static final long serialVersionUID = -102825851435182L;
/**
* Creation UTC time RFC3339.
*/
private final Date createdAt;
/**
* General description for the certificate issuer.
*/
private String description;
/**
* The ID of the certificate issuer.
*/
private String id;
/**
* General attributes for connecting the certificate issuer. When the issuer_type is GLOBAL_SIGN, the value shall be
* empty. When the issuer_type is CFSSL_AUTH, see definition of CfsslAttributes.
*
*/
private Map issuerAttributes;
/**
* The type of the certificate issuer. - GLOBAL_SIGN: Certificates are issued by GlobalSign service. The users must
* provide their own GlobalSign account credentials. - CFSSL_AUTH: Certificates are issued by CFSSL authenticated
* signing service. The users must provide their own CFSSL host_url and credentials.
*
*/
@Required
private CertificateIssuerType issuerType;
/**
* Certificate issuer name, unique per account.
*/
@Required
private String name;
/**
* Internal constructor.
*
*
* Constructor based on all fields.
*
* Note: Should not be used. Use {@link #CertificateIssuer()} instead.
*
* @param createdAt
* Creation UTC time RFC3339.
* @param description
* General description for the certificate issuer.
* @param id
* The ID of the certificate issuer.
* @param issuerAttributes
* General attributes for connecting the certificate issuer. When the issuer_type is GLOBAL_SIGN, the
* value shall be empty. When the issuer_type is CFSSL_AUTH, see definition of CfsslAttributes.
*
* @param issuerType
* The type of the certificate issuer. - GLOBAL_SIGN: Certificates are issued by GlobalSign service. The
* users must provide their own GlobalSign account credentials. - CFSSL_AUTH: Certificates are issued by
* CFSSL authenticated signing service. The users must provide their own CFSSL host_url and credentials.
*
* @param name
* Certificate issuer name, unique per account.
*/
@Internal
public CertificateIssuer(Date createdAt, String description, String id, Map issuerAttributes,
CertificateIssuerType issuerType, String name) {
super();
this.createdAt = createdAt;
setDescription(description);
setId(id);
setIssuerAttributes(issuerAttributes);
setIssuerType(issuerType);
setName(name);
}
/**
* Internal constructor.
*
*
* Constructor based on a similar object.
*
* Note: Should not be used. Use {@link #CertificateIssuer()} instead.
*
* @param certificateIssuer
* a certificate issuer.
*/
@Internal
public CertificateIssuer(CertificateIssuer certificateIssuer) {
this(certificateIssuer == null ? new Date() : certificateIssuer.createdAt,
certificateIssuer == null ? (String) null : certificateIssuer.description,
certificateIssuer == null ? (String) null : certificateIssuer.id,
certificateIssuer == null ? (Map) null : certificateIssuer.issuerAttributes,
certificateIssuer == null ? CertificateIssuerType.getDefault() : certificateIssuer.issuerType,
certificateIssuer == null ? (String) null : certificateIssuer.name);
}
/**
* Constructor.
*/
public CertificateIssuer() {
this(new Date(), (String) null, (String) null, (Map) null, CertificateIssuerType.getDefault(),
(String) null);
}
/**
* Constructor.
*
*
* Constructor based on object identifier.
*
*
* @param id
* The ID of the certificate issuer.
*/
public CertificateIssuer(String id) {
this();
setId(id);
}
/**
* Internal constructor.
*
*
* Constructor based on read-only fields.
*
* Note: Should not be used. Use {@link #CertificateIssuer()} instead.
*
* @param createdAt
* Creation UTC time RFC3339.
*/
@Internal
public CertificateIssuer(Date createdAt) {
this(createdAt, (String) null, (String) null, (Map) null, CertificateIssuerType.getDefault(),
(String) null);
}
/**
* Constructor.
*
*
* Constructor based on required fields.
*
*
* @param issuerType
* The type of the certificate issuer. - GLOBAL_SIGN: Certificates are issued by GlobalSign service. The
* users must provide their own GlobalSign account credentials. - CFSSL_AUTH: Certificates are issued by
* CFSSL authenticated signing service. The users must provide their own CFSSL host_url and credentials.
*
* @param name
* Certificate issuer name, unique per account.
*/
public CertificateIssuer(CertificateIssuerType issuerType, String name) {
this(new Date(), (String) null, (String) null, (Map) null, issuerType, name);
}
/**
* Gets creation utc time rfc3339.
*
* @return createdAt
*/
public Date getCreatedAt() {
return createdAt;
}
/**
* Gets general description for the certificate issuer.
*
* @return description
*/
public String getDescription() {
return description;
}
/**
* Sets general description for the certificate issuer.
*
*
* Note: the length of the string has to be less than or equal to {@code 100} to be valid
*
* @param description
* General description for the certificate issuer.
*/
public void setDescription(String description) {
this.description = description;
}
/**
* Checks whether description value is valid.
*
* @return true if the value is valid; false otherwise.
*/
@SuppressWarnings("PMD.UselessParentheses")
public boolean isDescriptionValid() {
return (description == null || description.length() <= 100);
}
/**
* Gets the id of the certificate issuer.
*
* @return id
*/
@Override
public String getId() {
return id;
}
/**
* Sets the id of the certificate issuer.
*
* @param id
* The ID of the certificate issuer.
*/
@Override
public void setId(String id) {
this.id = id;
}
/**
* Sets the id of the certificate issuer.
*
*
* Similar to {@link #setId(String)}
*
* @param certificateIssuerId
* The ID of the certificate issuer.
*/
@Internal
public void setCertificateIssuerId(String certificateIssuerId) {
setId(certificateIssuerId);
}
/**
* Gets general attributes for connecting the certificate issuer. when the issuer_type is global_sign, the value
* shall be empty. when the issuer_type is cfssl_auth, see definition of cfsslattributes.
*
* @return issuerAttributes
*/
public Map getIssuerAttributes() {
return issuerAttributes;
}
/**
* Sets general attributes for connecting the certificate issuer. when the issuer_type is global_sign, the value
* shall be empty. when the issuer_type is cfssl_auth, see definition of cfsslattributes.
*
* @param issuerAttributes
* General attributes for connecting the certificate issuer. When the issuer_type is GLOBAL_SIGN, the
* value shall be empty. When the issuer_type is CFSSL_AUTH, see definition of CfsslAttributes.
*
*/
public void setIssuerAttributes(Map issuerAttributes) {
this.issuerAttributes = issuerAttributes;
}
/**
* Gets the type of the certificate issuer. - global_sign: certificates are issued by globalsign service. the users
* must provide their own globalsign account credentials. - cfssl_auth: certificates are issued by cfssl
* authenticated signing service. the users must provide their own cfssl host_url and credentials.
*
* @return issuerType
*/
public CertificateIssuerType getIssuerType() {
return issuerType;
}
/**
* Sets the type of the certificate issuer. - global_sign: certificates are issued by globalsign service. the users
* must provide their own globalsign account credentials. - cfssl_auth: certificates are issued by cfssl
* authenticated signing service. the users must provide their own cfssl host_url and credentials.
*
* @param issuerType
* The type of the certificate issuer. - GLOBAL_SIGN: Certificates are issued by GlobalSign service. The
* users must provide their own GlobalSign account credentials. - CFSSL_AUTH: Certificates are issued by
* CFSSL authenticated signing service. The users must provide their own CFSSL host_url and credentials.
*
*/
@Required
public void setIssuerType(CertificateIssuerType issuerType) {
this.issuerType = issuerType;
}
/**
* Sets the type of the certificate issuer. - global_sign: certificates are issued by globalsign service. the users
* must provide their own globalsign account credentials. - cfssl_auth: certificates are issued by cfssl
* authenticated signing service. the users must provide their own cfssl host_url and credentials.
*
*
* Similar to {@link #setIssuerType(com.arm.mbed.cloud.sdk.security.model.CertificateIssuerType)}
*
* @param issuerType
* The type of the certificate issuer. - GLOBAL_SIGN: Certificates are issued by GlobalSign service. The
* users must provide their own GlobalSign account credentials. - CFSSL_AUTH: Certificates are issued by
* CFSSL authenticated signing service. The users must provide their own CFSSL host_url and credentials.
*
*/
@Internal
@Required
public void setIssuerType(String issuerType) {
this.issuerType = CertificateIssuerType.getValue(issuerType);
}
/**
* Checks whether issuerType value is valid.
*
* @return true if the value is valid; false otherwise.
*/
@SuppressWarnings("PMD.UselessParentheses")
public boolean isIssuerTypeValid() {
return issuerType != null;
}
/**
* Gets certificate issuer name, unique per account.
*
* @return name
*/
public String getName() {
return name;
}
/**
* Sets certificate issuer name, unique per account.
*
*
* Note: the length of the string has to be less than or equal to {@code 50} to be valid
*
* @param name
* Certificate issuer name, unique per account.
*/
@Required
public void setName(String name) {
this.name = name;
}
/**
* Checks whether name value is valid.
*
* @return true if the value is valid; false otherwise.
*/
@SuppressWarnings("PMD.UselessParentheses")
public boolean isNameValid() {
return name != null && (name.length() <= 50);
}
/**
* Returns a string representation of the object.
*
*
*
* @see java.lang.Object#toString()
* @return the string representation
*/
@Override
public String toString() {
return "CertificateIssuer [createdAt=" + createdAt + ", description=" + description + ", id=" + id
+ ", issuerAttributes=" + issuerAttributes + ", issuerType=" + issuerType + ", name=" + name + "]";
}
/**
* Calculates the hash code of this instance based on field values.
*
*
*
* @see java.lang.Object#hashCode()
* @return hash code
*/
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((createdAt == null) ? 0 : createdAt.hashCode());
result = prime * result + ((description == null) ? 0 : description.hashCode());
result = prime * result + ((id == null) ? 0 : id.hashCode());
result = prime * result + ((issuerAttributes == null) ? 0 : issuerAttributes.hashCode());
result = prime * result + ((issuerType == null) ? 0 : issuerType.hashCode());
result = prime * result + ((name == null) ? 0 : name.hashCode());
return result;
}
/**
* Method to ensure {@link #equals(Object)} is correct.
*
*
* Note: see this article: canEqual()
*
* @param other
* another object.
* @return true if the other object is an instance of the class in which canEqual is (re)defined, false otherwise.
*/
protected boolean canEqual(Object other) {
return other instanceof CertificateIssuer;
}
/**
* Indicates whether some other object is "equal to" this one.
*
*
*
* @see java.lang.Object#equals(java.lang.Object)
* @param obj
* an object to compare with this instance.
* @return true if this object is the same as the obj argument; false otherwise.
*/
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CertificateIssuer)) {
return false;
}
final CertificateIssuer other = (CertificateIssuer) obj;
if (!other.canEqual(this)) {
return false;
}
if (createdAt == null) {
if (other.createdAt != null) {
return false;
}
} else if (!createdAt.equals(other.createdAt)) {
return false;
}
if (description == null) {
if (other.description != null) {
return false;
}
} else if (!description.equals(other.description)) {
return false;
}
if (id == null) {
if (other.id != null) {
return false;
}
} else if (!id.equals(other.id)) {
return false;
}
if (issuerAttributes == null) {
if (other.issuerAttributes != null) {
return false;
}
} else if (!issuerAttributes.equals(other.issuerAttributes)) {
return false;
}
if (issuerType != other.issuerType) {
return false;
}
if (name == null) {
if (other.name != null) {
return false;
}
} else if (!name.equals(other.name)) {
return false;
}
return true;
}
/**
* Checks whether the model is valid or not.
*
*
*
* @see SdkModel#isValid()
* @return true if the model is valid; false otherwise.
*/
@Override
public boolean isValid() {
return isDescriptionValid() && isIssuerTypeValid() && isNameValid();
}
/**
* Clones this instance.
*
*
*
* @see java.lang.Object#clone()
* @return a cloned instance
*/
@Override
public CertificateIssuer clone() {
return new CertificateIssuer(this);
}
}