Package eu.europa.esig.dss.model

Class ReferenceValidation

java.lang.Object

eu.europa.esig.dss.model.ReferenceValidation

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

JAdESReferenceValidation, XAdESReferenceValidation

public class ReferenceValidation
extends Object
implements Serializable

This class is used to store individual reference validations. For XAdES, that means reference tag(s) validation For CAdES, that means message-digest validation

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	transforms	List of used transforms to compute digest of the reference

Constructor Summary

Constructors

Constructor	Description
ReferenceValidation()	Default constructor instantiating object with null values

Method Summary

Modifier and Type	Method	Description
List<ReferenceValidation>	getDependentValidations()	Returns a list of dependent validations from this Note: used to contain manifest entries
Digest	getDigest()	Gets the incorporated Digest
String	getDocumentName()	Gets matching document name
String	getId()	Gets the unique identifier of a reference.
String	getName()	Deprecated. since DSS 6.1.
List<String>	getTransformationNames()	Returns a list of transformations contained in the reference
DigestMatcherType	getType()	Returns type of the validated reference
String	getUri()	Gets the reference to the original document.
boolean	isDuplicated()	Returns if the referenced data is ambiguous
boolean	isFound()	Gets if the references data has been found
boolean	isIntact()	Gets if the digest of a referenced document matches to one defined in the reference
void	setDigest(Digest digest)	Sets the reference's Digest
void	setDocumentName(String documentName)	Sets the matching document name
void	setDuplicated(boolean isDuplicated)	Sets if the referenced data is ambiguous
void	setFound(boolean found)	Sets if the references data has been found
void	setId(String id)	Sets the unique identifier of a reference.
void	setIntact(boolean intact)	Sets if the digest value of a referenced document matches
void	setName(String name)	Deprecated. since DSS 6.1.
void	setTransformationNames(List<String> transforms)	Sets a list of transforms for the reference
void	setType(DigestMatcherType type)	Sets type of the reference
void	setUri(String uri)	Sets the reference to the original document.

Methods inherited from class java.lang.Object

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

Field Details

transforms

protected List<String> transforms

List of used transforms to compute digest of the reference

Constructor Details

ReferenceValidation

public ReferenceValidation()

Default constructor instantiating object with null values

Method Details

getType

public DigestMatcherType getType()

Returns type of the validated reference

Returns:

DigestMatcherType

setType

public void setType(DigestMatcherType type)

Sets type of the reference

Parameters:

type - DigestMatcherType

isFound

public boolean isFound()

Gets if the references data has been found

Returns:

TRUE if the data was found, FALSE otherwise

setFound

public void setFound(boolean found)

Sets if the references data has been found

Parameters:

found - if the references data has been found

isIntact

public boolean isIntact()

Gets if the digest of a referenced document matches to one defined in the reference

Returns:

TRUE if the digest value of a referenced document matches, FALSE otherwise

setIntact

public void setIntact(boolean intact)

Sets if the digest value of a referenced document matches

Parameters:

intact - if the digest value of a referenced document matches

getDigest

public Digest getDigest()

Gets the incorporated Digest

Returns:

Digest

setDigest

public void setDigest(Digest digest)

Sets the reference's Digest

Parameters:

digest - Digest

getName

@Deprecated
public String getName()

Deprecated.

since DSS 6.1. Please see #getId and #getUri methods

Gets name of the reference

Returns:

String

setName

@Deprecated
public void setName(String name)

Deprecated.

since DSS 6.1. Please see #setId and #setUri methods

Sets name of the reference

Parameters:

name - String

getId

public String getId()

Gets the unique identifier of a reference. (E.g. for XAdES : reference Id attribute value)

Returns:

String

setId

public void setId(String id)

Sets the unique identifier of a reference. (E.g. for XAdES : reference Id attribute value)

Parameters:

id - String

getUri

public String getUri()

Gets the reference to the original document. (E.g. for XAdES : reference URI attribute value).

Returns:

String

setUri

public void setUri(String uri)

Sets the reference to the original document. (E.g. for XAdES : reference URI attribute value).

Parameters:

uri - String

getDocumentName

public String getDocumentName()

Gets matching document name

Returns:

String

setDocumentName

public void setDocumentName(String documentName)

Sets the matching document name

Parameters:

documentName - String

getTransformationNames

public List<String> getTransformationNames()

Returns a list of transformations contained in the reference

Returns:

list of String transfor names

setTransformationNames

public void setTransformationNames(List<String> transforms)

Sets a list of transforms for the reference

Parameters:

transforms - list of String transform names

isDuplicated

public boolean isDuplicated()

Returns if the referenced data is ambiguous

Returns:

TRUE if the referenced data is ambiguous, FALSE otherwise

setDuplicated

public void setDuplicated(boolean isDuplicated)

Sets if the referenced data is ambiguous

Parameters:

isDuplicated - if the referenced data is ambiguous

getDependentValidations

public List<ReferenceValidation> getDependentValidations()

Returns a list of dependent validations from this Note: used to contain manifest entries

Returns:

list of ReferenceValidations