com.guardtime.ksi.service.ha

Class SigningHAService

java.lang.Object

com.guardtime.ksi.service.ha.SigningHAService

All Implemented Interfaces:

KSISigningService, Closeable, AutoCloseable

public class SigningHAService
extends Object
implements KSISigningService

KSI Signing Service which combines clients to achieve redundancy. NB! It is highly recommended that all the aggregator configurations would be in sync with each other (except credentials), but if this is not the case then the configurations will be consolidated in an optimistic manner which means that if a configuration parameter would improve how user can consume the service then it's preferred in the consolidated configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SigningHAService.Builder Builds the SigningHAService.

Method Summary

Modifier and Type	Method and Description
void	close() Closes all the subservices.
Future<AggregatorConfiguration>	getAggregationConfiguration() Invokes a configuration for all the subservices.
List<KSISigningService>	getSubSigningServices() Gets all the subservices in case of the implementation that combines multiple KSISigningServices.
void	registerAggregatorConfigurationListener(ConfigurationListener<AggregatorConfiguration> listener) Registers configuration listeners that will be called if this SigningHAService's configuration changes.
Future<AggregationResponse>	sign(DataHash dataHash, Long level) Creates a non-blocking signing request.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

sign

public Future<AggregationResponse> sign(DataHash dataHash,
                                        Long level)
                                 throws KSIException

Creates a non-blocking signing request. Sends the request to all the subservices in parallel. First successful response is used, others are cancelled. Request fails only if all the subservices fail.

Specified by:

sign in interface KSISigningService

Parameters:

dataHash - instance of DataHash to be signed.

level - the dataHash's level in the local aggregation tree.

Returns:

Instance of AggregationResponseFuture containing Aggregation response data.

Throws:

KSIException - in case any error occurs.

See Also:

KSISigningService.sign(DataHash, Long)

getSubSigningServices

public List<KSISigningService> getSubSigningServices()

Description copied from interface: KSISigningService

Gets all the subservices in case of the implementation that combines multiple KSISigningServices. If the implementation is a KSISigningService connecting directly to a single gateway, an empty list is returned.

Specified by:

getSubSigningServices in interface KSISigningService

Returns:

List of signing subservices this signing service composes of.

registerAggregatorConfigurationListener

public void registerAggregatorConfigurationListener(ConfigurationListener<AggregatorConfiguration> listener)

Registers configuration listeners that will be called if this SigningHAService's configuration changes. They will not be called if subservice's configuration changes in a way that does not change the consolidated configuration. To get detailed info about subservices' configurations one should register their own listeners directly on subservices. Listener will be called instantaneously once with the latest consolidation result as part of the registration if the latest result is not null.

Specified by:

registerAggregatorConfigurationListener in interface KSISigningService

Parameters:

listener - may not be null.

getAggregationConfiguration

public Future<AggregatorConfiguration> getAggregationConfiguration()

Invokes a configuration for all the subservices. Does not block until responses are received. Active configuration listeners are only called if any of the responses change the state of consolidated configuration.

Specified by:

getAggregationConfiguration in interface KSISigningService

Returns:

A future of the result. Can be used as an alternative to listeners to access the configuration result.

close

public void close()

Closes all the subservices.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

toString

public String toString()

Overrides:

toString in class Object