com.guardtime.ksi

Interface Signer

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

KSI

public interface Signer
extends Closeable

Signing data or data hash, synchronously or asynchronously. An instance of this class can be obtained using SignerBuilder class.

Method Summary

Modifier and Type	Method and Description
Future<KSISignature>	asyncSign(byte[] bytes) Signs the byte array asynchronously.
Future<KSISignature>	asyncSign(DataHash dataHash) Signs the data hash asynchronously.
Future<KSISignature>	asyncSign(DataHash dataHash, long level) This method is used to sign data hash asynchronously with user provided aggregation tree height.
Future<KSISignature>	asyncSign(File file) Signs the file asynchronously.
AggregatorConfiguration	getAggregatorConfiguration() Deprecated. Deprecated since 4.10. Use KSISigningService.getAggregationConfiguration() in pair with KSISigningService.registerAggregatorConfigurationListener(ConfigurationListener) instead. To acquire instance of KSISigningService which a KSI instance uses, call getSigningService().
KSISigningService	getSigningService() Gets the signing service that the SDK was initialized with.
KSISignature	sign(byte[] bytes) Signs the byte array.
KSISignature	sign(DataHash dataHash) Signs the data hash.
KSISignature	sign(DataHash dataHash, long level) Signs the data hash with user provided aggregation tree height.
KSISignature	sign(File file) Signs the file.

Methods inherited from interface java.io.Closeable

close

Method Detail

sign

KSISignature sign(DataHash dataHash)
           throws KSIException

Signs the data hash.

Parameters:

dataHash - instance of DataHash to sign, not null.

Returns:

KSI signature (KSISignature).

Throws:

KSIException - when error occurs (e.g. when communication with KSI service fails).

sign

KSISignature sign(DataHash dataHash,
                  long level)
           throws KSIException

Signs the data hash with user provided aggregation tree height.

Parameters:

dataHash - instance of DataHash to sign. not null.

level - aggregation tree height.

Returns:

instance of KSISignature

Throws:

KSIException - when error occurs (e.g when communication with KSI service fails)

sign

KSISignature sign(File file)
           throws KSIException

Signs the file. Uses hash algorithm defined by method KSIBuilder.setDefaultSigningHashAlgorithm(HashAlgorithm).

Parameters:

file - file to sign, not null.

Returns:

KSI signature (KSISignature).

Throws:

KSIException - when error occurs (e.g. when communication with KSI service fails).

sign

KSISignature sign(byte[] bytes)
           throws KSIException

Signs the byte array. Uses hash algorithm defined by method KSIBuilder.setDefaultSigningHashAlgorithm(HashAlgorithm).

Parameters:

bytes - bytes to sign, not null.

Returns:

KSI signature (KSISignature).

Throws:

KSIException - when error occurs (e.g. when communication with KSI service fails).

asyncSign

Future<KSISignature> asyncSign(DataHash dataHash)
                        throws KSIException

Signs the data hash asynchronously. Use method Future.getResult() to get the KSI signature.

Parameters:

dataHash - instance of DataHash to sign, not null.

Returns:

Instance of Future.

Throws:

KSIException - when error occurs (e.g. when communication with KSI service fails).

asyncSign

Future<KSISignature> asyncSign(DataHash dataHash,
                               long level)
                        throws KSIException

This method is used to sign data hash asynchronously with user provided aggregation tree height. Use method Future.getResult() to get KSI signature.

Parameters:

dataHash - instance of DataHash to sign. not null.

level - aggregation tree height.

Returns:

instance of Future

Throws:

KSIException - when error occurs (e.g when communication with KSI service fails)

asyncSign

Future<KSISignature> asyncSign(File file)
                        throws KSIException

Signs the file asynchronously. Uses hash algorithm defined by method KSIBuilder.setDefaultSigningHashAlgorithm(HashAlgorithm). Use method Future.getResult() to get the KSI signature.

Parameters:

file - file to sign, not null.

Returns:

Instance of Future.

Throws:

KSIException - when error occurs (e.g. when communication with KSI service fails).

asyncSign

Future<KSISignature> asyncSign(byte[] bytes)
                        throws KSIException

Signs the byte array asynchronously. Uses hash algorithm defined by method KSIBuilder.setDefaultSigningHashAlgorithm(HashAlgorithm). Use method Future.getResult() to get the KSI signature.

Parameters:

bytes - file to sign, not null.

Returns:

Instance of Future

Throws:

KSIException - when error occurs (e.g. when communication with KSI service fails).

getSigningService

KSISigningService getSigningService()

Gets the signing service that the SDK was initialized with. E.g. to get access to signing service's configuration.

getAggregatorConfiguration

@Deprecated
AggregatorConfiguration getAggregatorConfiguration()
                                                        throws KSIException

Deprecated. Deprecated since 4.10. Use KSISigningService.getAggregationConfiguration() in pair with KSISigningService.registerAggregatorConfigurationListener(ConfigurationListener) instead. To acquire instance of KSISigningService which a KSI instance uses, call getSigningService().

Asks aggregation configuration from KSI gateway/aggregator. Only supported if PduVersion.V2 is used.

Throws:

UnsupportedOperationException - if KSI is initialized with a service not a client.

KSIException