com.guardtime.ksi.service

Interface Future<T>

Type Parameters:

T - future return type

All Known Implementing Classes:

AggregationResponseFuture, ApacheHttpGetRequestFuture, ApacheHttpPostRequestFuture, ExtensionFuture, ExtensionResponseFuture, HttpGetRequestFuture, HttpPostRequestFuture, SigningFuture, SimpleHttpGetRequestFuture, SimpleHttpPostRequestFuture

public interface Future<T>

KSI protocol related request response future.

Future is a design pattern for asynchronous request. A Future represents the result of an asynchronous operation. It is possible to check if the computation is complete, and to retrieve the result of the operation. The result can be retrieved using the method getResult() once the computation has completed. getResult() is blocking, until the result is ready.

Note: while recent Java versions also provide the Future pattern this API has it's own implementation to provide backwards compatibility with older Java versions.

Method Summary

Modifier and Type	Method and Description
T	getResult() Retrieves the result of the request.
boolean	isFinished() Returns true if result is available.

Method Detail

getResult

T getResult()
     throws KSIException

Retrieves the result of the request. If request is not finished this call will block until result is available.

Returns:

Result of the request.

Throws:

KSIException - when KSI service returns an error or does not work as expected.

isFinished

boolean isFinished()

Returns true if result is available. Does not necessarily mean that the computation is complete.

Returns:

True, if call is finished.