Package eu.europa.esig.dss.model.scope

Class SignatureScope

java.lang.Object

eu.europa.esig.dss.model.scope.SignatureScope

All Implemented Interfaces:

IdentifierBasedObject, Serializable

Direct Known Subclasses:

ContainerSignatureScope, CounterSignatureScope, DigestSignatureScope, FullSignatureScope, HTTPHeaderSignatureScope, PdfByteRangeSignatureScope, SignatureScopeWithTransformations, SignatureSignatureScope

public abstract class SignatureScope
extends Object
implements IdentifierBasedObject, Serializable

This class describes the scope of the signature

See Also:

• Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SignatureScope(DSSDocument document)	Default constructor
protected	SignatureScope(String name, DSSDocument document)	Default constructor with name provided

Method Summary

Modifier and Type	Method	Description
void	addChildSignatureScope(SignatureScope signatureScope)	Adds a new child SignatureScope
boolean	equals(Object obj)
List<SignatureScope>	getChildren()	Returns a list of dependent signature scopes (e.g.
abstract String	getDescription(TokenIdentifierProvider tokenIdentifierProvider)	Gets the signature scope description
Digest	getDigest(DigestAlgorithm digestAlgorithm)	Gets digests of the document
String	getDocumentName()	Gets name of the document
DataIdentifier	getDSSId()	Returns the unique DSS Identifier
String	getDSSIdAsString()	Returns a String representation of the DSS Identifier
String	getName(TokenIdentifierProvider tokenIdentifierProvider)	Returns a signature scope name
List<String>	getTransformations()	Returns a list of transformations on the original document when applicable
abstract SignatureScopeType	getType()	Returns type of the signature scope
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SignatureScope

protected SignatureScope(DSSDocument document)

Default constructor

Parameters:

document - DSSDocument

SignatureScope

protected SignatureScope(String name,
 DSSDocument document)

Default constructor with name provided

Parameters:

name - String document name

document - DSSDocument

Method Details

getDocumentName

public String getDocumentName()

Gets name of the document

Returns:

String

getName

public String getName(TokenIdentifierProvider tokenIdentifierProvider)

Returns a signature scope name

Parameters:

tokenIdentifierProvider - TokenIdentifierProvider to extract a token identifier, when required

Returns:

String

getDigest

public Digest getDigest(DigestAlgorithm digestAlgorithm)

Gets digests of the document

Parameters:

digestAlgorithm - DigestAlgorithm

Returns:

Digest

getDescription

public abstract String getDescription(TokenIdentifierProvider tokenIdentifierProvider)

Gets the signature scope description

Parameters:

tokenIdentifierProvider - TokenIdentifierProvider to extract a token identifier, when required

Returns:

String

getTransformations

public List<String> getTransformations()

Returns a list of transformations on the original document when applicable

Returns:

a list of Strings

getType

public abstract SignatureScopeType getType()

Returns type of the signature scope

Returns:

SignatureScopeType

getChildren

public List<SignatureScope> getChildren()

Returns a list of dependent signature scopes (e.g. Manifest entries)

Returns:

a list of SignatureScopes

addChildSignatureScope

public void addChildSignatureScope(SignatureScope signatureScope)

Adds a new child SignatureScope

Parameters:

signatureScope - SignatureScope to add

getDSSId

public DataIdentifier getDSSId()

Returns the unique DSS Identifier

Specified by:

getDSSId in interface IdentifierBasedObject

Returns:

DataIdentifier

getDSSIdAsString

public String getDSSIdAsString()

Returns a String representation of the DSS Identifier

Returns:

String

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object