com.guardtime.ksi

Class SignerBuilder

java.lang.Object

com.guardtime.ksi.SignerBuilder

public final class SignerBuilder
extends Object

Obtaining and configuring the Signer object(s). This class offers multiple methods to configure Signer object. It is mandatory to set the signing service client.

Constructor Summary

Constructors

Constructor and Description
SignerBuilder()

Method Summary

Modifier and Type	Method and Description
Signer	build() Builds and returns the Signer instance.
SignerBuilder	setDefaultSigningHashAlgorithm(HashAlgorithm defaultHashAlgorithm) Sets the default signing hash algorithm to be used to create new KSI signatures.
SignerBuilder	setDefaultVerificationPolicy(ContextAwarePolicy policy) Sets the default verification policy.
SignerBuilder	setSigningService(KSISigningService signingService) Sets the signing service to be used in signing process.

Methods inherited from class java.lang.Object

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

Constructor Detail

SignerBuilder

public SignerBuilder()

Method Detail

setDefaultSigningHashAlgorithm

public SignerBuilder setDefaultSigningHashAlgorithm(HashAlgorithm defaultHashAlgorithm)

Sets the default signing hash algorithm to be used to create new KSI signatures. When using Signer.sign(DataHash) or Signer.asyncSign(DataHash) method, this algorithm is ignored. By default HashAlgorithm.SHA2_256 algorithm is used.

setSigningService

public SignerBuilder setSigningService(KSISigningService signingService)

Sets the signing service to be used in signing process.

setDefaultVerificationPolicy

public SignerBuilder setDefaultVerificationPolicy(ContextAwarePolicy policy)

Sets the default verification policy. Verification will be ran before signature is returned to the user. If signature verification fails, InvalidSignatureContentException exception is thrown. If needed, user can access the invalid signature and verification result using the methods InvalidSignatureContentException.getSignature() and InvalidSignatureContentException.getVerificationResult().

By default the policy returned by method ContextAwarePolicyAdapter.createInternalPolicy() is used.

build

public Signer build()

Builds and returns the Signer instance. If signing client isn't configured, NullPointerException is thrown.