com.lacunasoftware.restpkicore.CertificateFullModel Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of restpkicore-client Show documentation
Show all versions of restpkicore-client Show documentation
Classes to consume Lacuna Software REST PKI Core
/*
* Rest PKI Core API
* Para Português, clique aqui Rest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
Parameters
You will need the following parameters:
- Endpoint: address of the Rest PKI Core instance that will be used
- API Key: authorization key for using the API
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
Authentication
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
HTTP Codes
The APIs will return the following HTTP codes:
Code Description 200 (OK) Request processed successfully. The response is different for each API, please refer to the operation's documentation 400 (Bad Request) Syntax error. For instance, when a required field was not provided 401 (Unauthorized) API key not provided or invalid 403 (Forbidden) API key is valid, but the application has insufficient permissions to complete the requested operation 422 (Unprocessable Entity) API error. The response body is an ErrorModelV2 500 (Internal Server Error) An unexpected error occurred. The exceptionCode contained on the response body may be of help for our support team during diagnostic.
Error Codes
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
Code Description DocumentNotFound A referenced document was not found (check the document ID) SecurityContextNotFound A referenced security context was not found (check the security context ID) SignatureSessionNotFound A referenced signature session was not found (check the signature session ID) BadSignatureSessionOperation The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error BackgroundProcessing The operation cannot be completed at this time because the resource is being processed in background SignatureSessionTokenRequired The signature session token was not passed on the X-Signature-Session-Token request header BadSignatureSessionToken An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) ExpiredSignatureSessionToken An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours.
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
Culture / Internationalization (i18n)
The Accept-Language request header is observed by this API. The following cultures are supported:
- en-US (or simply en)
- pt-BR (or simply pt)
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
*
* OpenAPI spec version: 1.10.0 RC 1
*
*
* NOTE: This class is auto generated by the swagger code generator program.
* https://github.com/swagger-api/swagger-codegen.git
* Do not edit the class manually.
*/
package com.lacunasoftware.restpkicore;
import java.util.Objects;
import java.util.Arrays;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;
import com.lacunasoftware.restpkicore.CertificateModel;
import com.lacunasoftware.restpkicore.NameModel;
import com.lacunasoftware.restpkicore.PkiBrazilCertificateModel;
import com.lacunasoftware.restpkicore.PkiItalyCertificateModel;
import io.swagger.v3.oas.annotations.media.Schema;
import java.util.Date;
/**
* CertificateFullModel
*/
@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true)
public class CertificateFullModel {
@JsonProperty("encoded")
private byte[] encoded = null;
@JsonProperty("pemEncoded")
private String pemEncoded = null;
@JsonProperty("downloadUrl")
private String downloadUrl = null;
@JsonProperty("subjectName")
private NameModel subjectName = null;
@JsonProperty("issuerName")
private NameModel issuerName = null;
@JsonProperty("issuerDisplayName")
private String issuerDisplayName = null;
@JsonProperty("serialNumber")
private String serialNumber = null;
@JsonProperty("validityStart")
private Date validityStart = null;
@JsonProperty("validityEnd")
private Date validityEnd = null;
@JsonProperty("issuer")
private CertificateModel issuer = null;
@JsonProperty("pkiBrazil")
private PkiBrazilCertificateModel pkiBrazil = null;
@JsonProperty("pkiItaly")
private PkiItalyCertificateModel pkiItaly = null;
@JsonProperty("binaryThumbprintSHA256")
private byte[] binaryThumbprintSHA256 = null;
@JsonProperty("thumbprint")
private String thumbprint = null;
@JsonProperty("thumbprintSHA256")
private String thumbprintSHA256 = null;
@JsonProperty("subjectCommonName")
private String subjectCommonName = null;
@JsonProperty("subjectDisplayName")
private String subjectDisplayName = null;
@JsonProperty("subjectIdentifier")
private String subjectIdentifier = null;
@JsonProperty("emailAddress")
private String emailAddress = null;
@JsonProperty("organization")
private String organization = null;
@JsonProperty("organizationIdentifier")
private String organizationIdentifier = null;
public CertificateFullModel encoded(byte[] encoded) {
this.encoded = encoded;
return this;
}
/**
* Get encoded
* @return encoded
**/
@Schema(description = "")
public byte[] getEncoded() {
return encoded;
}
public void setEncoded(byte[] encoded) {
this.encoded = encoded;
}
public CertificateFullModel pemEncoded(String pemEncoded) {
this.pemEncoded = pemEncoded;
return this;
}
/**
* Get pemEncoded
* @return pemEncoded
**/
@Schema(description = "")
public String getPemEncoded() {
return pemEncoded;
}
public void setPemEncoded(String pemEncoded) {
this.pemEncoded = pemEncoded;
}
public CertificateFullModel downloadUrl(String downloadUrl) {
this.downloadUrl = downloadUrl;
return this;
}
/**
* Get downloadUrl
* @return downloadUrl
**/
@Schema(description = "")
public String getDownloadUrl() {
return downloadUrl;
}
public void setDownloadUrl(String downloadUrl) {
this.downloadUrl = downloadUrl;
}
public CertificateFullModel subjectName(NameModel subjectName) {
this.subjectName = subjectName;
return this;
}
/**
* Get subjectName
* @return subjectName
**/
@Schema(description = "")
public NameModel getSubjectName() {
return subjectName;
}
public void setSubjectName(NameModel subjectName) {
this.subjectName = subjectName;
}
public CertificateFullModel issuerName(NameModel issuerName) {
this.issuerName = issuerName;
return this;
}
/**
* Get issuerName
* @return issuerName
**/
@Schema(description = "")
public NameModel getIssuerName() {
return issuerName;
}
public void setIssuerName(NameModel issuerName) {
this.issuerName = issuerName;
}
public CertificateFullModel issuerDisplayName(String issuerDisplayName) {
this.issuerDisplayName = issuerDisplayName;
return this;
}
/**
* Get issuerDisplayName
* @return issuerDisplayName
**/
@Schema(description = "")
public String getIssuerDisplayName() {
return issuerDisplayName;
}
public void setIssuerDisplayName(String issuerDisplayName) {
this.issuerDisplayName = issuerDisplayName;
}
public CertificateFullModel serialNumber(String serialNumber) {
this.serialNumber = serialNumber;
return this;
}
/**
* Get serialNumber
* @return serialNumber
**/
@Schema(description = "")
public String getSerialNumber() {
return serialNumber;
}
public void setSerialNumber(String serialNumber) {
this.serialNumber = serialNumber;
}
public CertificateFullModel validityStart(Date validityStart) {
this.validityStart = validityStart;
return this;
}
/**
* Get validityStart
* @return validityStart
**/
@Schema(description = "")
public Date getValidityStart() {
return validityStart;
}
public void setValidityStart(Date validityStart) {
this.validityStart = validityStart;
}
public CertificateFullModel validityEnd(Date validityEnd) {
this.validityEnd = validityEnd;
return this;
}
/**
* Get validityEnd
* @return validityEnd
**/
@Schema(description = "")
public Date getValidityEnd() {
return validityEnd;
}
public void setValidityEnd(Date validityEnd) {
this.validityEnd = validityEnd;
}
public CertificateFullModel issuer(CertificateModel issuer) {
this.issuer = issuer;
return this;
}
/**
* Get issuer
* @return issuer
**/
@Schema(description = "")
public CertificateModel getIssuer() {
return issuer;
}
public void setIssuer(CertificateModel issuer) {
this.issuer = issuer;
}
public CertificateFullModel pkiBrazil(PkiBrazilCertificateModel pkiBrazil) {
this.pkiBrazil = pkiBrazil;
return this;
}
/**
* Get pkiBrazil
* @return pkiBrazil
**/
@Schema(description = "")
public PkiBrazilCertificateModel getPkiBrazil() {
return pkiBrazil;
}
public void setPkiBrazil(PkiBrazilCertificateModel pkiBrazil) {
this.pkiBrazil = pkiBrazil;
}
public CertificateFullModel pkiItaly(PkiItalyCertificateModel pkiItaly) {
this.pkiItaly = pkiItaly;
return this;
}
/**
* Get pkiItaly
* @return pkiItaly
**/
@Schema(description = "")
public PkiItalyCertificateModel getPkiItaly() {
return pkiItaly;
}
public void setPkiItaly(PkiItalyCertificateModel pkiItaly) {
this.pkiItaly = pkiItaly;
}
public CertificateFullModel binaryThumbprintSHA256(byte[] binaryThumbprintSHA256) {
this.binaryThumbprintSHA256 = binaryThumbprintSHA256;
return this;
}
/**
* Get binaryThumbprintSHA256
* @return binaryThumbprintSHA256
**/
@Schema(description = "")
public byte[] getBinaryThumbprintSHA256() {
return binaryThumbprintSHA256;
}
public void setBinaryThumbprintSHA256(byte[] binaryThumbprintSHA256) {
this.binaryThumbprintSHA256 = binaryThumbprintSHA256;
}
public CertificateFullModel thumbprint(String thumbprint) {
this.thumbprint = thumbprint;
return this;
}
/**
* Get thumbprint
* @return thumbprint
**/
@Schema(description = "")
public String getThumbprint() {
return thumbprint;
}
public void setThumbprint(String thumbprint) {
this.thumbprint = thumbprint;
}
public CertificateFullModel thumbprintSHA256(String thumbprintSHA256) {
this.thumbprintSHA256 = thumbprintSHA256;
return this;
}
/**
* Get thumbprintSHA256
* @return thumbprintSHA256
**/
@Schema(description = "")
public String getThumbprintSHA256() {
return thumbprintSHA256;
}
public void setThumbprintSHA256(String thumbprintSHA256) {
this.thumbprintSHA256 = thumbprintSHA256;
}
public CertificateFullModel subjectCommonName(String subjectCommonName) {
this.subjectCommonName = subjectCommonName;
return this;
}
/**
* Get subjectCommonName
* @return subjectCommonName
**/
@Schema(description = "")
public String getSubjectCommonName() {
return subjectCommonName;
}
public void setSubjectCommonName(String subjectCommonName) {
this.subjectCommonName = subjectCommonName;
}
public CertificateFullModel subjectDisplayName(String subjectDisplayName) {
this.subjectDisplayName = subjectDisplayName;
return this;
}
/**
* Get subjectDisplayName
* @return subjectDisplayName
**/
@Schema(description = "")
public String getSubjectDisplayName() {
return subjectDisplayName;
}
public void setSubjectDisplayName(String subjectDisplayName) {
this.subjectDisplayName = subjectDisplayName;
}
public CertificateFullModel subjectIdentifier(String subjectIdentifier) {
this.subjectIdentifier = subjectIdentifier;
return this;
}
/**
* Get subjectIdentifier
* @return subjectIdentifier
**/
@Schema(description = "")
public String getSubjectIdentifier() {
return subjectIdentifier;
}
public void setSubjectIdentifier(String subjectIdentifier) {
this.subjectIdentifier = subjectIdentifier;
}
public CertificateFullModel emailAddress(String emailAddress) {
this.emailAddress = emailAddress;
return this;
}
/**
* Get emailAddress
* @return emailAddress
**/
@Schema(description = "")
public String getEmailAddress() {
return emailAddress;
}
public void setEmailAddress(String emailAddress) {
this.emailAddress = emailAddress;
}
public CertificateFullModel organization(String organization) {
this.organization = organization;
return this;
}
/**
* Get organization
* @return organization
**/
@Schema(description = "")
public String getOrganization() {
return organization;
}
public void setOrganization(String organization) {
this.organization = organization;
}
public CertificateFullModel organizationIdentifier(String organizationIdentifier) {
this.organizationIdentifier = organizationIdentifier;
return this;
}
/**
* Get organizationIdentifier
* @return organizationIdentifier
**/
@Schema(description = "")
public String getOrganizationIdentifier() {
return organizationIdentifier;
}
public void setOrganizationIdentifier(String organizationIdentifier) {
this.organizationIdentifier = organizationIdentifier;
}
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
CertificateFullModel certificateFullModel = (CertificateFullModel) o;
return Arrays.equals(this.encoded, certificateFullModel.encoded) &&
Objects.equals(this.pemEncoded, certificateFullModel.pemEncoded) &&
Objects.equals(this.downloadUrl, certificateFullModel.downloadUrl) &&
Objects.equals(this.subjectName, certificateFullModel.subjectName) &&
Objects.equals(this.issuerName, certificateFullModel.issuerName) &&
Objects.equals(this.issuerDisplayName, certificateFullModel.issuerDisplayName) &&
Objects.equals(this.serialNumber, certificateFullModel.serialNumber) &&
Objects.equals(this.validityStart, certificateFullModel.validityStart) &&
Objects.equals(this.validityEnd, certificateFullModel.validityEnd) &&
Objects.equals(this.issuer, certificateFullModel.issuer) &&
Objects.equals(this.pkiBrazil, certificateFullModel.pkiBrazil) &&
Objects.equals(this.pkiItaly, certificateFullModel.pkiItaly) &&
Arrays.equals(this.binaryThumbprintSHA256, certificateFullModel.binaryThumbprintSHA256) &&
Objects.equals(this.thumbprint, certificateFullModel.thumbprint) &&
Objects.equals(this.thumbprintSHA256, certificateFullModel.thumbprintSHA256) &&
Objects.equals(this.subjectCommonName, certificateFullModel.subjectCommonName) &&
Objects.equals(this.subjectDisplayName, certificateFullModel.subjectDisplayName) &&
Objects.equals(this.subjectIdentifier, certificateFullModel.subjectIdentifier) &&
Objects.equals(this.emailAddress, certificateFullModel.emailAddress) &&
Objects.equals(this.organization, certificateFullModel.organization) &&
Objects.equals(this.organizationIdentifier, certificateFullModel.organizationIdentifier);
}
@Override
public int hashCode() {
return Objects.hash(Arrays.hashCode(encoded), pemEncoded, downloadUrl, subjectName, issuerName, issuerDisplayName, serialNumber, validityStart, validityEnd, issuer, pkiBrazil, pkiItaly, Arrays.hashCode(binaryThumbprintSHA256), thumbprint, thumbprintSHA256, subjectCommonName, subjectDisplayName, subjectIdentifier, emailAddress, organization, organizationIdentifier);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class CertificateFullModel {\n");
sb.append(" encoded: ").append(toIndentedString(encoded)).append("\n");
sb.append(" pemEncoded: ").append(toIndentedString(pemEncoded)).append("\n");
sb.append(" downloadUrl: ").append(toIndentedString(downloadUrl)).append("\n");
sb.append(" subjectName: ").append(toIndentedString(subjectName)).append("\n");
sb.append(" issuerName: ").append(toIndentedString(issuerName)).append("\n");
sb.append(" issuerDisplayName: ").append(toIndentedString(issuerDisplayName)).append("\n");
sb.append(" serialNumber: ").append(toIndentedString(serialNumber)).append("\n");
sb.append(" validityStart: ").append(toIndentedString(validityStart)).append("\n");
sb.append(" validityEnd: ").append(toIndentedString(validityEnd)).append("\n");
sb.append(" issuer: ").append(toIndentedString(issuer)).append("\n");
sb.append(" pkiBrazil: ").append(toIndentedString(pkiBrazil)).append("\n");
sb.append(" pkiItaly: ").append(toIndentedString(pkiItaly)).append("\n");
sb.append(" binaryThumbprintSHA256: ").append(toIndentedString(binaryThumbprintSHA256)).append("\n");
sb.append(" thumbprint: ").append(toIndentedString(thumbprint)).append("\n");
sb.append(" thumbprintSHA256: ").append(toIndentedString(thumbprintSHA256)).append("\n");
sb.append(" subjectCommonName: ").append(toIndentedString(subjectCommonName)).append("\n");
sb.append(" subjectDisplayName: ").append(toIndentedString(subjectDisplayName)).append("\n");
sb.append(" subjectIdentifier: ").append(toIndentedString(subjectIdentifier)).append("\n");
sb.append(" emailAddress: ").append(toIndentedString(emailAddress)).append("\n");
sb.append(" organization: ").append(toIndentedString(organization)).append("\n");
sb.append(" organizationIdentifier: ").append(toIndentedString(organizationIdentifier)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(java.lang.Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
}