com.guardtime.ksi

Interface Extender

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

KSI

public interface Extender
extends Closeable

Extending a KSI signature. An instance of this class can be obtained using ExtenderBuilder class.

Method Summary

Modifier and Type	Method and Description
Future<KSISignature>	asyncExtend(KSISignature signature) Extends the signature asynchronously to the closest publication in publications file.
Future<KSISignature>	asyncExtend(KSISignature signature, PublicationRecord publicationRecord) Extends the signature asynchronously to the specified publication record.
KSISignature	extend(KSISignature signature) Extends the signature to the closest publication in publications file.
KSISignature	extend(KSISignature signature, PublicationRecord publicationRecord) Extends the signature to specified publication record.
ExtenderConfiguration	getExtenderConfiguration() Deprecated. Deprecated since 4.10. Use KSIExtendingService.getExtendingConfiguration() in pair with KSIExtendingService.registerExtenderConfigurationListener(ConfigurationListener) instead. To acquire the KSIExtendingService which a KSI instance uses, call getExtendingService().
KSIExtendingService	getExtendingService() Gets the extender service that the SDK was initialized with.

Methods inherited from interface java.io.Closeable

close

Method Detail

extend

KSISignature extend(KSISignature signature)
             throws KSIException

Extends the signature to the closest publication in publications file.

Parameters:

signature - KSISignature to be extended, not null.

Returns:

Extended KSI signature (KSISignature).

Throws:

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

extend

KSISignature extend(KSISignature signature,
                    PublicationRecord publicationRecord)
             throws KSIException

Extends the signature to specified publication record. The publication time of the publication record must be after signature aggregation time. When signature is extended, the old calendar hash chain and publication record is removed.

Parameters:

signature - KSISignature to be extended, not null.

publicationRecord - publication record (PublicationRecord) to extend to, not null.

Returns:

Extended KSI signature with extended calendar hash chain and publication record.

Throws:

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

asyncExtend

Future<KSISignature> asyncExtend(KSISignature signature)
                          throws KSIException

Extends the signature asynchronously to the closest publication in publications file. Use method Future.getResult() to get the extended KSI signature.

Parameters:

signature - KSISignature to be extended, not null.

Returns:

Instance of Future.

Throws:

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

asyncExtend

Future<KSISignature> asyncExtend(KSISignature signature,
                                 PublicationRecord publicationRecord)
                          throws KSIException

Extends the signature asynchronously to the specified publication record. Use method Future.getResult() to get the extended KSI signature.

Parameters:

signature - KSISignature to be extended, not null.

publicationRecord - publication record (PublicationRecord) to extend the signature to.

Returns:

Instance of Future.

Throws:

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

getExtendingService

KSIExtendingService getExtendingService()

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

getExtenderConfiguration

@Deprecated
ExtenderConfiguration getExtenderConfiguration()
                                                    throws KSIException

Deprecated. Deprecated since 4.10. Use KSIExtendingService.getExtendingConfiguration() in pair with KSIExtendingService.registerExtenderConfigurationListener(ConfigurationListener) instead. To acquire the KSIExtendingService which a KSI instance uses, call getExtendingService().

Asks the extender 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