com.rsa.certj.xml.dsig

Class VerificationInfo

java.lang.Object
  |
  +--com.rsa.certj.xml.dsig.VerificationInfo

All Implemented Interfaces:

Cloneable, Serializable

public class VerificationInfo

extends Object

implements Cloneable, Serializable

This class defines the detailed validation information of an XML signature. It includes the status of the core signature validation, the reference validations, and detailed error information during verification.

Copyright © RSA Security Inc., 2001-2002. All rights reserved.

See Also

Serialized Form

Field Summary

static int	CORE_VERIFY_FAILURE Specifies that both signature and reference validations failed.
static int	CORE_VERIFY_SUCCESS Specifies that the verification, including signature and reference validations, succeeded.
static int	OTHER_FAILURE Specifies that some other errors occurred during validation: for example, unable to locate the resource identified by the URI, or unsupported digest and signing algorithm in the signature.
static int	REFERENCE_VALIDATION_FAILURE Specifies that the reference validation failed, but the signature over the signedInfo element validation succeeded.
static int	SIGNATURE_VERIFICATION_FAILURE Specifies that signature validation failed, but reference validations succeeded.

Constructor Summary

VerificationInfo()

Default constructor.

Method Summary

Object	clone() Overrides the default clone method to get a deeper clone.
String	getDescription(int failedReferenceIndex) Returns the detailed description of errors for a specific failed reference.
String[]	getDescriptions() Returns a list of error descriptions of all failed references.
int[]	getFailedReferenceIndexes() Returns all the indexes of references that failed on validation.
int	getStatus() Returns the validation status of the signature.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CORE_VERIFY_SUCCESS

public static final int CORE_VERIFY_SUCCESS

Specifies that the verification, including signature and reference validations, succeeded.

SIGNATURE_VERIFICATION_FAILURE

public static final int SIGNATURE_VERIFICATION_FAILURE

Specifies that signature validation failed, but reference validations succeeded.

REFERENCE_VALIDATION_FAILURE

public static final int REFERENCE_VALIDATION_FAILURE

Specifies that the reference validation failed, but the signature over the signedInfo element validation succeeded. In general, when a single reference fails, the signature will fail. But some applications may wish to reserve reference validation decision logic themselves. For example, the application may wish to treat the signature over the valid reference elements as valid or take different actions, depending on which fails.

CORE_VERIFY_FAILURE

public static final int CORE_VERIFY_FAILURE

Specifies that both signature and reference validations failed.

OTHER_FAILURE

public static final int OTHER_FAILURE

Specifies that some other errors occurred during validation: for example, unable to locate the resource identified by the URI, or unsupported digest and signing algorithm in the signature.

Constructor Detail

VerificationInfo

public VerificationInfo()

Default constructor. Creates an empty VerificationInfo object.

Method Detail

getStatus

public int getStatus()

Returns the validation status of the signature.

Returns

The integer value of the signature validation status.

getFailedReferenceIndexes

public int[] getFailedReferenceIndexes()

Returns all the indexes of references that failed on validation.

Returns

The indexes of all the references that failed on validation.

getDescription

public String getDescription(int failedReferenceIndex)

Returns the detailed description of errors for a specific failed reference.

Parameters

failedReferenceIndex

The index of the failed reference.

Returns

A detailed description of errors for the failed reference located at failedReferenceIndex.

getDescriptions

public String[] getDescriptions()

Returns a list of error descriptions of all failed references.

Returns

Detailed descriptions of the errors.

clone

public Object clone()
             throws CloneNotSupportedException

Overrides the default clone method to get a deeper clone.

Returns

A new VerificationInfo object, a copy of this object.

Throws

CloneNotSupportedException - If the cloning operation is not successful.