SignatureStatus (Digital Signature Services 5.12.1 API)

java.lang.Object

eu.europa.esig.dss.alert.status.MessageStatus

eu.europa.esig.dss.alert.status.ObjectStatus

eu.europa.esig.dss.validation.status.SignatureStatus

All Implemented Interfaces:: Status

public class SignatureStatus extends ObjectStatus

Contains signatures concerned by an occurred event and corresponding information about them

Constructor Summary

Constructors

Constructor

Description

SignatureStatus()

Default constructor initializing an empty map
Method Summary

Modifier and Type

Method

Description

void

addRelatedTokenAndErrorMessage(AdvancedSignature signature, String errorMessage)

Adds concerned signature and information about the occurred event

String

getMessageForSignature(AdvancedSignature signature)

Returns error message for the given signature

Collection<AdvancedSignature>

getRelatedSignatures()

Returns a collection of signatures concerned by failure of the processed check

boolean

isEmpty()

Returns whether the object is not filled (all values are null)

Methods inherited from class eu.europa.esig.dss.alert.status.ObjectStatus
addRelatedObjectIdentifierAndErrorMessage, getErrorString, getMessageForObjectWithId, getRelatedObjectIds, objectMapToString

Methods inherited from class eu.europa.esig.dss.alert.status.MessageStatus
getMessage, setMessage, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- SignatureStatus
  
  public SignatureStatus()
  
  Default constructor initializing an empty map
Method Details
- addRelatedTokenAndErrorMessage
  
  public void addRelatedTokenAndErrorMessage(AdvancedSignature signature, String errorMessage)
  
  Adds concerned signature and information about the occurred event
  
  Parameters:
  
  signature - AdvancedSignature
  
  errorMessage - String message
- getRelatedSignatures
  
  public Collection<AdvancedSignature> getRelatedSignatures()
  
  Returns a collection of signatures concerned by failure of the processed check
  
  Returns:
  
  a collection of AdvancedSignatures
- getMessageForSignature
  
  public String getMessageForSignature(AdvancedSignature signature)
  
  Returns error message for the given signature
  
  Parameters:
  
  signature - AdvancedSignature to get caused error message for
  
  Returns:
  
  String error message
- isEmpty
  
  public boolean isEmpty()
  
  Description copied from interface: Status
  
  Returns whether the object is not filled (all values are null)
  
  Specified by:
  
  isEmpty in interface Status
  
  Overrides:
  
  isEmpty in class ObjectStatus
  
  Returns:
  
  TRUE if the Status is empty (underlying even did not occur), FALSE otherwise (event occurred)