com.guardtime.ksi.service.ha

Class ExtendingHAService

java.lang.Object

com.guardtime.ksi.service.ha.ExtendingHAService

All Implemented Interfaces:

KSIExtendingService, Closeable, AutoCloseable

public class ExtendingHAService
extends Object
implements KSIExtendingService

KSI Extending Service which combines clients to achieve redundancy. NB! It is highly recommended that all the extender 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	ExtendingHAService.Builder Builds the ExtendingHAService.

Method Summary

Modifier and Type	Method and Description
void	close() Closes all the subservices.
Future<ExtensionResponse>	extend(Date aggregationTime, Date publicationTime) Creates a non-blocking extending request.
Future<ExtenderConfiguration>	getExtendingConfiguration() Invokes a configuration for all the subservices.
List<KSIExtendingService>	getSubExtendingServices() Gets the subclients in case of the implementation that combines multiple clients.
void	registerExtenderConfigurationListener(ConfigurationListener<ExtenderConfiguration> listener) Registers configuration listeners that will be called if this ExtendingHAService's configuration changes.

Methods inherited from class java.lang.Object

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

Method Detail

extend

public Future<ExtensionResponse> extend(Date aggregationTime,
                                        Date publicationTime)
                                 throws KSIException

Creates a non-blocking extending 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:

extend in interface KSIExtendingService

Parameters:

aggregationTime - aggregation time of the existing signature.

publicationTime - publication time to which the existing signature is to be extended.

Returns:

Instance of ExtensionResponseFuture containing calendar chains needed to extend the signature.

Throws:

KSIException - in case any error occurs.

See Also:

KSIExtendingService.extend(Date, Date)

getSubExtendingServices

public List<KSIExtendingService> getSubExtendingServices()

Description copied from interface: KSIExtendingService

Gets the subclients in case of the implementation that combines multiple clients. If the implementation is a client that directly connects to a single gateway, an empty list will be returned.

Specified by:

getSubExtendingServices in interface KSIExtendingService

Returns:

List of extender subservices this service composes of.

registerExtenderConfigurationListener

public void registerExtenderConfigurationListener(ConfigurationListener<ExtenderConfiguration> listener)

Registers configuration listeners that will be called if this ExtendingHAService'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:

registerExtenderConfigurationListener in interface KSIExtendingService

Parameters:

listener - may not be null.

getExtendingConfiguration

public Future<ExtenderConfiguration> getExtendingConfiguration()

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:

getExtendingConfiguration in interface KSIExtendingService

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