com.guardtime.ksi.unisignature.verifier

Class VerificationContextBuilder

java.lang.Object

com.guardtime.ksi.unisignature.verifier.VerificationContextBuilder

public class VerificationContextBuilder
extends Object

This class is used to createSignature VerificationContext instances.

Constructor Summary

Constructors

Constructor and Description
VerificationContextBuilder()

Method Summary

Modifier and Type	Method and Description
VerificationContext	build()
VerificationContext	createVerificationContext() Deprecated.
VerificationContextBuilder	setDocumentHash(DataHash documentHash) Used to set the hash of the original document.
VerificationContextBuilder	setDocumentHash(DataHash documentHash, Long level) Used to set the hash and local aggregation tree height.
VerificationContextBuilder	setExtenderClient(KSIExtenderClient extenderClient) Used to set the KSIExtenderClient to be used to extend signature.
VerificationContextBuilder	setExtendingAllowed(boolean extendingAllowed) If true then extending is allowed when verifying signature.
VerificationContextBuilder	setExtendingService(KSIExtendingService extendingService) Used to set the KSIExtendingService to be used to extend signature.
VerificationContextBuilder	setPublicationsFile(PublicationsFile publicationsFile) Used to set the publications file that is used by verification process
VerificationContextBuilder	setSignature(KSISignature signature) Used to set the KSI signature that is verified.
VerificationContextBuilder	setUserPublication(PublicationData userPublication) Used to set the user publication (e.g from newspaper).

Methods inherited from class java.lang.Object

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

Constructor Detail

VerificationContextBuilder

public VerificationContextBuilder()

Method Detail

setSignature

public VerificationContextBuilder setSignature(KSISignature signature)

Used to set the KSI signature that is verified.

Parameters:

signature - signature to verify.

Returns:

instance of VerificationContextBuilder

setPublicationsFile

public VerificationContextBuilder setPublicationsFile(PublicationsFile publicationsFile)

Used to set the publications file that is used by verification process

Parameters:

publicationsFile - instance of publications file. may be null.

Returns:

instance of VerificationContextBuilder

setUserPublication

public VerificationContextBuilder setUserPublication(PublicationData userPublication)

Used to set the user publication (e.g from newspaper). Used by UserProvidedPublicationBasedVerificationPolicy.

Parameters:

userPublication - instance of publication data. may be null.

Returns:

instance of VerificationContextBuilder

setExtendingAllowed

public VerificationContextBuilder setExtendingAllowed(boolean extendingAllowed)

If true then extending is allowed when verifying signature. Does not affect CalendarBasedVerificationPolicy policy.

Parameters:

extendingAllowed - true if extending is allowed, false otherwise

Returns:

instance of VerificationContextBuilder

setExtenderClient

public VerificationContextBuilder setExtenderClient(KSIExtenderClient extenderClient)

Used to set the KSIExtenderClient to be used to extend signature.

Parameters:

extenderClient - instance of extender client

Returns:

instance of VerificationContextBuilder

setExtendingService

public VerificationContextBuilder setExtendingService(KSIExtendingService extendingService)

Used to set the KSIExtendingService to be used to extend signature.

Parameters:

extendingService - instance of extending service

Returns:

instance of VerificationContextBuilder

setDocumentHash

public VerificationContextBuilder setDocumentHash(DataHash documentHash,
                                                  Long level)

Used to set the hash and local aggregation tree height. If present then this hash must equal to signature input hash.

Parameters:

documentHash - document hash

Returns:

instance of VerificationContextBuilder

setDocumentHash

public VerificationContextBuilder setDocumentHash(DataHash documentHash)

Used to set the hash of the original document. If present then this hash must equal to signature input hash.

Parameters:

documentHash - document hash

Returns:

instance of VerificationContextBuilder

build

public VerificationContext build()

createVerificationContext

@Deprecated
public final VerificationContext createVerificationContext()
                                                                throws KSIException

Deprecated.

Builds the verification context.

Returns:

instance of verification context

Throws:

KSIException - when error occurs (e.g mandatory parameters aren't present)