com.helger.xmldsig

Class XMLDSigValidationResult

java.lang.Object

com.helger.xmldsig.XMLDSigValidationResult

All Implemented Interfaces:

com.helger.commons.state.IValidityIndicator, Serializable

public class XMLDSigValidationResult
extends Object
implements com.helger.commons.state.IValidityIndicator, Serializable

This class encapsulates the results of XML DSig validation.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
XMLDSigValidationResult(List<Integer> aInvalidReferences)

Method Summary

Modifier and Type	Method and Description
static XMLDSigValidationResult	createReferenceErrors(List<Integer> aInvalidReferences) An invalid reference or references.
static XMLDSigValidationResult	createSignatureError() An invalid signature.
static XMLDSigValidationResult	createSuccess() Successful validation
com.helger.commons.collection.impl.ICommonsList<Integer>	getInvalidReferenceIndices()
boolean	isSignatureValid()
boolean	isValid()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.state.IValidityIndicator

and, and, isInvalid, or, or

Constructor Detail

XMLDSigValidationResult

public XMLDSigValidationResult(@Nonnull @Nonempty
                               List<Integer> aInvalidReferences)

Method Detail

isValid

public boolean isValid()

Specified by:

isValid in interface com.helger.commons.state.IValidityIndicator

isSignatureValid

public boolean isSignatureValid()

Returns:

May only be false , if the overall validity is false

getInvalidReferenceIndices

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<Integer> getInvalidReferenceIndices()

Returns:

A list with all invalid reference indices. Never null but may be empty in case of success.

toString

public String toString()

Overrides:

toString in class Object

createSuccess

@Nonnull
public static XMLDSigValidationResult createSuccess()

Successful validation

Returns:

Result object

createSignatureError

@Nonnull
public static XMLDSigValidationResult createSignatureError()

An invalid signature. The cryptographic verification of the signature failed. This can be caused by an incorrect validation key or a change to the SignedInfo contents since the signature was generated.

Returns:

Result object

createReferenceErrors

@Nonnull
public static XMLDSigValidationResult createReferenceErrors(@Nonnull @Nonempty
                                                                      List<Integer> aInvalidReferences)

An invalid reference or references. The verification of the digest of a reference failed. This can be caused by a change to the referenced data since the signature was generated.

Parameters:

aInvalidReferences - The indices to the invalid references.

Returns:

Result object