Package com.itextpdf.signatures.validation.report

Class ValidationReport

java.lang.Object

com.itextpdf.signatures.validation.report.ValidationReport

All Implemented Interfaces:

IJsonSerializable

       public class ValidationReport extends Object implements IJsonSerializable
      

Validation report, which contains detailed validation results.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ValidationReport.ValidationResult	Enum representing possible validation results.

Constructor Summary

Constructors

Constructor	Description
ValidationReport()	Create new instance of ValidationReport.
ValidationReport(ValidationReport report)	Create a copy of another validation report.

Method Summary

Modifier and Type	Method	Description
void	addReportItem(ReportItem item)	Add new report item to the overall validation result.
static ValidationReport	fromJson(JsonValue jsonValue)	Deserializes JsonValue into ValidationReport.
List<CertificateReportItem>	getCertificateFailures()	Get list of failures, which are related to certificate validation.
List<CertificateReportItem>	getCertificateLogs()	Get list of log messages, which are related to certificate validation.
List<ReportItem>	getFailures()	Get all failures recognized during a validation process.
List<ReportItem>	getLogs()	Get all log messages reported during a validation process.
ValidationReport.ValidationResult	getValidationResult()	Get the result of a validation process.
ValidationReport	merge(ValidationReport subReport)	Merge all ReportItem objects from sub report into this one.
ValidationReport	mergeWithDifferentStatus(ValidationReport subReport, ReportItem.ReportItemStatus newStatus)	Merge all ReportItem objects from sub report into this one with different status.
JsonValue	toJson()	Serializes object to JSON AST.
String	toString()	.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ValidationReport

             public ValidationReport()
            

Create new instance of ValidationReport.

ValidationReport

             public ValidationReport
             (ValidationReport report)
            

Create a copy of another validation report.

Parameters:

report - to be copied

Method Details

getValidationResult

             public ValidationReport.ValidationResult getValidationResult()
            

Get the result of a validation process.

Returns:

ValidationReport.ValidationResult, which represents the result of a validation

getFailures

             public List<ReportItem> getFailures()
            

Get all failures recognized during a validation process.

Returns:

report items List, which contains all recognized failures

getCertificateFailures

             public List<CertificateReportItem> getCertificateFailures()
            

Get list of failures, which are related to certificate validation.

Returns:

report items List, which contains only CertificateReportItem failures

getLogs

             public List<ReportItem> getLogs()
            

Get all log messages reported during a validation process.

Returns:

report items List, which contains all reported log messages, related to validation

getCertificateLogs

             public List<CertificateReportItem> getCertificateLogs()
            

Get list of log messages, which are related to certificate validation.

Returns:

report items List, which contains only CertificateReportItem log messages

addReportItem

             public void addReportItem
             (ReportItem item)
            

Add new report item to the overall validation result.

Parameters:

item - ReportItem to be added

toString

             public String toString()
            

.

Overrides:

toString in class Object

merge

             public ValidationReport merge
             (ValidationReport subReport)
            

Merge all ReportItem objects from sub report into this one.

Parameters:

subReport - report from which items will be merged

Returns:

ValidationReport the same updated validation report instance.

toJson

             public JsonValue toJson()
            

Serializes object to JSON AST..

Specified by:

toJson in interface IJsonSerializable

Returns:

JsonValue serialized object

fromJson

             public static ValidationReport fromJson
             (JsonValue jsonValue)
            

Deserializes JsonValue into ValidationReport.

Parameters:

jsonValue - JsonValue to deserialize

Returns:

deserialized ValidationReport

mergeWithDifferentStatus

             public ValidationReport mergeWithDifferentStatus
             (ValidationReport subReport, ReportItem.ReportItemStatus newStatus)
            

Merge all ReportItem objects from sub report into this one with different status.

Parameters:

subReport - report from which items will be merged

newStatus - ReportItem.ReportItemStatus which will be used instead of provided ones

Returns:

ValidationReport the same updated validation report instance.