com.guardtime.ksi.blocksigner

Class KsiBlockSignerBuilder

java.lang.Object

com.guardtime.ksi.blocksigner.KsiBlockSignerBuilder

public class KsiBlockSignerBuilder
extends Object

Provides functionality to obtain KsiBlockSigner object(s), offering multiple methods to configure KsiBlockSigner object.

The following sample shows how to use KsiBlockSigner class:

 

 KSISigningClient signingClient = getSigningClient();
 TreeBuilder treeBuilder = new HashTreeBuilder();
 KsiBlockSigner signer = new KsiBlockSignerBuilder()
                 .setKsiSigningClient(signingClient)
                 .setTreeBuilder(treeBuilder)
                 .build();
 

Constructor Summary

Constructors

Constructor and Description
KsiBlockSignerBuilder()

Method Summary

Modifier and Type	Method and Description
KsiBlockSigner	build()
KsiBlockSignerBuilder	setDefaultHashAlgorithm(HashAlgorithm algorithm) Deprecated. Use setTreeBuilder(TreeBuilder) instead.
KsiBlockSignerBuilder	setKsiSigningClient(KSISigningClient signingClient) Sets the KSISigningClient.
KsiBlockSignerBuilder	setKsiSigningService(KSISigningService signingService) Sets the KSISigningService.
KsiBlockSignerBuilder	setMaxTreeHeight(Integer maxTreeHeight) Sets the maximum height of the aggregation tree.
KsiBlockSignerBuilder	setPduIdentifierProvider(PduIdentifierProvider pduIdentifierProvider) Deprecated.
KsiBlockSignerBuilder	setPduVersion(PduVersion pduVersion) Deprecated.
KsiBlockSignerBuilder	setSignatureFactory(KSISignatureFactory signatureFactory) Sets the KSISignatureFactory.
KsiBlockSignerBuilder	setTreeBuilder(TreeBuilder treeBuilder) Allows to configure a custom TreeBuilder for the local aggregation.

Methods inherited from class java.lang.Object

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

Constructor Detail

KsiBlockSignerBuilder

public KsiBlockSignerBuilder()

Method Detail

setKsiSigningClient

public KsiBlockSignerBuilder setKsiSigningClient(KSISigningClient signingClient)

Sets the KSISigningClient. Either this method or setKsiSigningService(com.guardtime.ksi.service.KSISigningService) method should be called.

setKsiSigningService

public KsiBlockSignerBuilder setKsiSigningService(KSISigningService signingService)

Sets the KSISigningService. Either this method or setKsiSigningClient(com.guardtime.ksi.service.client.KSISigningClient) method should be called.

setDefaultHashAlgorithm

@Deprecated
public KsiBlockSignerBuilder setDefaultHashAlgorithm(HashAlgorithm algorithm)

Deprecated. Use setTreeBuilder(TreeBuilder) instead.

Sets the hash algorithm used by HashTreeBuilder.

setSignatureFactory

public KsiBlockSignerBuilder setSignatureFactory(KSISignatureFactory signatureFactory)

Sets the KSISignatureFactory. Default value is InMemoryKsiSignatureFactory.

setMaxTreeHeight

public KsiBlockSignerBuilder setMaxTreeHeight(Integer maxTreeHeight)

Sets the maximum height of the aggregation tree. Default value is Util.MAXIMUM_LEVEL.

setTreeBuilder

public KsiBlockSignerBuilder setTreeBuilder(TreeBuilder treeBuilder)

Allows to configure a custom TreeBuilder for the local aggregation. If used then the algorithm set by setMaxTreeHeight(Integer) method will be ignored. If this method is not called then HashTreeBuilder will be used for aggregation.

setPduVersion

@Deprecated
public KsiBlockSignerBuilder setPduVersion(PduVersion pduVersion)

Deprecated.

setPduIdentifierProvider

@Deprecated
public KsiBlockSignerBuilder setPduIdentifierProvider(PduIdentifierProvider pduIdentifierProvider)

Deprecated.

build

public KsiBlockSigner build()