com.lacunasoftware.restpkicore.InspectSignatureResponse 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.DocumentSummary;
import com.lacunasoftware.restpkicore.InspectSignatureFailures;
import com.lacunasoftware.restpkicore.SignerModel;
import io.swagger.v3.oas.annotations.media.Schema;
import java.util.ArrayList;
import java.util.List;
/**
* InspectSignatureResponse
*/
@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true)
public class InspectSignatureResponse {
@JsonProperty("success")
private Boolean success = null;
@JsonProperty("failure")
private InspectSignatureFailures failure = null;
@JsonProperty("signers")
private List signers = null;
@JsonProperty("document")
private DocumentSummary document = null;
public InspectSignatureResponse success(Boolean success) {
this.success = success;
return this;
}
/**
* Get success
* @return success
**/
@Schema(description = "")
public Boolean isSuccess() {
return success;
}
public void setSuccess(Boolean success) {
this.success = success;
}
public InspectSignatureResponse failure(InspectSignatureFailures failure) {
this.failure = failure;
return this;
}
/**
* Get failure
* @return failure
**/
@Schema(description = "")
public InspectSignatureFailures getFailure() {
return failure;
}
public void setFailure(InspectSignatureFailures failure) {
this.failure = failure;
}
public InspectSignatureResponse signers(List signers) {
this.signers = signers;
return this;
}
public InspectSignatureResponse addSignersItem(SignerModel signersItem) {
if (this.signers == null) {
this.signers = new ArrayList<>();
}
this.signers.add(signersItem);
return this;
}
/**
* Get signers
* @return signers
**/
@Schema(description = "")
public List getSigners() {
return signers;
}
public void setSigners(List signers) {
this.signers = signers;
}
public InspectSignatureResponse document(DocumentSummary document) {
this.document = document;
return this;
}
/**
* Get document
* @return document
**/
@Schema(description = "")
public DocumentSummary getDocument() {
return document;
}
public void setDocument(DocumentSummary document) {
this.document = document;
}
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
InspectSignatureResponse inspectSignatureResponse = (InspectSignatureResponse) o;
return Objects.equals(this.success, inspectSignatureResponse.success) &&
Objects.equals(this.failure, inspectSignatureResponse.failure) &&
Objects.equals(this.signers, inspectSignatureResponse.signers) &&
Objects.equals(this.document, inspectSignatureResponse.document);
}
@Override
public int hashCode() {
return Objects.hash(success, failure, signers, document);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class InspectSignatureResponse {\n");
sb.append(" success: ").append(toIndentedString(success)).append("\n");
sb.append(" failure: ").append(toIndentedString(failure)).append("\n");
sb.append(" signers: ").append(toIndentedString(signers)).append("\n");
sb.append(" document: ").append(toIndentedString(document)).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 ");
}
}