Package io.tarantool.driver.api

Interface TarantoolCallOperations

All Known Subinterfaces:

TarantoolClient<T,R>

All Known Implementing Classes:

AbstractTarantoolClient, ClusterTarantoolClient, ClusterTarantoolTupleClient, ProxyTarantoolClient, ProxyTarantoolTupleClient, RetryingTarantoolClient, RetryingTarantoolTupleClient

public interface TarantoolCallOperations

Aggregates all call operation variants

Method Summary

Modifier and Type	Method	Description
CompletableFuture<List<?>>	call(String functionName)	Execute a function defined on Tarantool instance.
<T> CompletableFuture<TarantoolResult<T>>	call(String functionName, CallResultMapper<TarantoolResult<T>,SingleValueCallResult<TarantoolResult<T>>> resultMapper)	Execute a function defined on Tarantool instance.
<T> CompletableFuture<TarantoolResult<T>>	call(String functionName, Class<T> entityClass)	Execute a function defined on Tarantool instance.
CompletableFuture<List<?>>	call(String functionName, Object... arguments)	Execute a function defined on Tarantool instance, The value mapper specified in the client configuration will be used for converting the result values from MessagePack entities to objects.
CompletableFuture<List<?>>	call(String functionName, List<?> arguments)	Execute a function defined on Tarantool instance.
<T> CompletableFuture<TarantoolResult<T>>	call(String functionName, List<?> arguments, CallResultMapper<TarantoolResult<T>,SingleValueCallResult<TarantoolResult<T>>> resultMapper)	Execute a function defined on Tarantool instance.
CompletableFuture<List<?>>	call(String functionName, List<?> arguments, MessagePackMapper mapper)	Execute a function defined on Tarantool instance
<T> CompletableFuture<TarantoolResult<T>>	call(String functionName, List<?> arguments, MessagePackObjectMapper argumentsMapper, CallResultMapper<TarantoolResult<T>,SingleValueCallResult<TarantoolResult<T>>> resultMapper)	Execute a function defined on Tarantool instance.
<T> CompletableFuture<TarantoolResult<T>>	call(String functionName, List<?> arguments, MessagePackObjectMapper argumentsMapper, Class<T> entityClass)	Execute a function defined on Tarantool instance.
<T> CompletableFuture<TarantoolResult<T>>	call(String functionName, List<?> arguments, Class<T> entityClass)	Execute a function defined on Tarantool instance.
<T,R extends List<T>> CompletableFuture<R>	callForMultiResult(String functionName, CallResultMapper<R,MultiValueCallResult<T,R>> resultMapper)	Execute a function defined on Tarantool instance.
<T,R extends List<T>> CompletableFuture<R>	callForMultiResult(String functionName, Supplier<R> resultContainerSupplier, ValueConverter<org.msgpack.value.Value,T> valueConverter)	Execute a function defined on Tarantool instance.
<T,R extends List<T>> CompletableFuture<R>	callForMultiResult(String functionName, Supplier<R> resultContainerSupplier, Class<T> resultClass)	Execute a function defined on Tarantool instance.
<T,R extends List<T>> CompletableFuture<R>	callForMultiResult(String functionName, List<?> arguments, CallResultMapper<R,MultiValueCallResult<T,R>> resultMapper)	Execute a function defined on Tarantool instance.
<T,R extends List<T>> CompletableFuture<R>	callForMultiResult(String functionName, List<?> arguments, MessagePackObjectMapper argumentsMapper, CallResultMapper<R,MultiValueCallResult<T,R>> resultMapper)	Execute a function defined on Tarantool instance.
<T,R extends List<T>> CompletableFuture<R>	callForMultiResult(String functionName, List<?> arguments, MessagePackObjectMapper argumentsMapper, Supplier<R> resultContainerSupplier, ValueConverter<org.msgpack.value.Value,T> valueConverter)	Execute a function defined on Tarantool instance.
<T,R extends List<T>> CompletableFuture<R>	callForMultiResult(String functionName, List<?> arguments, MessagePackObjectMapper argumentsMapper, Supplier<R> resultContainerSupplier, Class<T> resultClass)	Execute a function defined on Tarantool instance.
<T,R extends List<T>> CompletableFuture<R>	callForMultiResult(String functionName, List<?> arguments, Supplier<R> resultContainerSupplier, ValueConverter<org.msgpack.value.Value,T> valueConverter)	Execute a function defined on Tarantool instance.
<T,R extends List<T>> CompletableFuture<R>	callForMultiResult(String functionName, List<?> arguments, Supplier<R> resultContainerSupplier, Class<T> resultClass)	Execute a function defined on Tarantool instance.
<T> CompletableFuture<T>	callForSingleResult(String functionName, CallResultMapper<T,SingleValueCallResult<T>> resultMapper)	Execute a function defined on Tarantool instance.
<T> CompletableFuture<T>	callForSingleResult(String functionName, ValueConverter<org.msgpack.value.Value,T> valueConverter)	Execute a function defined on Tarantool instance.
<T> CompletableFuture<T>	callForSingleResult(String functionName, Class<T> resultClass)	Execute a function defined on Tarantool instance.
<T> CompletableFuture<T>	callForSingleResult(String functionName, List<?> arguments, CallResultMapper<T,SingleValueCallResult<T>> resultMapper)	Execute a function defined on Tarantool instance.
<T> CompletableFuture<T>	callForSingleResult(String functionName, List<?> arguments, ValueConverter<org.msgpack.value.Value,T> valueConverter)	Execute a function defined on Tarantool instance.
<T> CompletableFuture<T>	callForSingleResult(String functionName, List<?> arguments, MessagePackObjectMapper argumentsMapper, CallResultMapper<T,SingleValueCallResult<T>> resultMapper)	Execute a function defined on Tarantool instance.
<T> CompletableFuture<T>	callForSingleResult(String functionName, List<?> arguments, MessagePackObjectMapper argumentsMapper, ValueConverter<org.msgpack.value.Value,T> valueConverter)	Execute a function defined on Tarantool instance.
<T> CompletableFuture<T>	callForSingleResult(String functionName, List<?> arguments, MessagePackObjectMapper argumentsMapper, Class<T> resultClass)	Execute a function defined on Tarantool instance.
<T> CompletableFuture<T>	callForSingleResult(String functionName, List<?> arguments, Class<T> resultClass)	Execute a function defined on Tarantool instance.
ResultMapperFactoryFactory	getResultMapperFactoryFactory()	Get the default factory for result mapper factory instances

Method Detail

call

CompletableFuture<List<?>> call(String functionName)
                         throws TarantoolClientException

Execute a function defined on Tarantool instance. The value mapper specified in the client configuration will be used for converting the result values from MessagePack entities to objects. TODO example function call

Parameters:

functionName - function name, must not be null or empty

Returns:

some result

Throws:

TarantoolClientException - if the client is not connected or some other error occurred

call

CompletableFuture<List<?>> call(String functionName,
                                Object... arguments)
                         throws TarantoolClientException

Execute a function defined on Tarantool instance, The value mapper specified in the client configuration will be used for converting the result values from MessagePack entities to objects.

Parameters:

functionName - function name, must not be null or empty

arguments - vararg array of function arguments. The object mapper specified in the client configuration will be used for arguments conversion to MessagePack entities

Returns:

some result

Throws:

TarantoolClientException - if the client is not connected or some other error occurred

call

CompletableFuture<List<?>> call(String functionName,
                                List<?> arguments)
                         throws TarantoolClientException

Execute a function defined on Tarantool instance. The value mapper specified in the client configuration will be used for converting the result values from MessagePack entities to objects.

Parameters:

functionName - function name, must not be null or empty

arguments - list of function arguments. The object mapper specified in the client configuration will be used for arguments conversion to MessagePack entities

Returns:

some result

Throws:

TarantoolClientException - if the client is not connected or some other error occurred

call

CompletableFuture<List<?>> call(String functionName,
                                List<?> arguments,
                                MessagePackMapper mapper)
                         throws TarantoolClientException

Execute a function defined on Tarantool instance

Parameters:

functionName - function name, must not be null or empty

arguments - list of function arguments

mapper - mapper for arguments object-to-MessagePack entity conversion and result values conversion

Returns:

some result

Throws:

TarantoolClientException - if the client is not connected

call

<T> CompletableFuture<TarantoolResult<T>> call(String functionName,
                                               Class<T> entityClass)
                                        throws TarantoolClientException

Execute a function defined on Tarantool instance. The call result is interpreted as an array of tuples. The value mapper specified in the client configuration will be used for converting the result values from MessagePack arrays to the specified entity type.

Type Parameters:

T - desired function call result type

Parameters:

functionName - function name, must not be null or empty

entityClass - target result entity class

Returns:

some result

Throws:

TarantoolClientException - if the client is not connected or some other error occurred

call

<T> CompletableFuture<TarantoolResult<T>> call(String functionName,
                                               CallResultMapper<TarantoolResult<T>,SingleValueCallResult<TarantoolResult<T>>> resultMapper)
                                        throws TarantoolClientException

Execute a function defined on Tarantool instance. The call result is interpreted as an array of tuples.

Type Parameters:

T - desired function call result type

Parameters:

functionName - function name, must not be null or empty

resultMapper - mapper for result value MessagePack entity-to-object conversion

Returns:

some result

Throws:

TarantoolClientException - if the client is not connected or some other error occurred

call

<T> CompletableFuture<TarantoolResult<T>> call(String functionName,
                                               List<?> arguments,
                                               Class<T> entityClass)
                                        throws TarantoolClientException

Execute a function defined on Tarantool instance. The call result is interpreted as an array of tuples. The value mapper specified in the client configuration will be used for converting the result values from MessagePack arrays to the specified entity type.

Type Parameters:

T - desired function call result type

Parameters:

functionName - function name, must not be null or empty

arguments - list of function arguments. The object mapper specified in the client configuration will be used for arguments conversion to MessagePack entities

entityClass - target result entity class

Returns:

some result

Throws:

TarantoolClientException - if the client is not connected or some other error occurred

call

<T> CompletableFuture<TarantoolResult<T>> call(String functionName,
                                               List<?> arguments,
                                               CallResultMapper<TarantoolResult<T>,SingleValueCallResult<TarantoolResult<T>>> resultMapper)
                                        throws TarantoolClientException

Execute a function defined on Tarantool instance. The call result is interpreted as an array of tuples.

Type Parameters:

T - desired function call result type

Parameters:

functionName - function name, must not be null or empty

arguments - list of function arguments. The object mapper specified in the client configuration will be used for arguments conversion to MessagePack entities

resultMapper - mapper for result value MessagePack entity-to-object conversion

Returns:

some result

Throws:

TarantoolClientException - if the client is not connected or some other error occurred

call

<T> CompletableFuture<TarantoolResult<T>> call(String functionName,
                                               List<?> arguments,
                                               MessagePackObjectMapper argumentsMapper,
                                               Class<T> entityClass)
                                        throws TarantoolClientException

Execute a function defined on Tarantool instance. The call result is interpreted as an array of tuples. The value mapper specified in the client configuration will be used for converting the result values from MessagePack arrays to the specified entity type.

Type Parameters:

T - desired function call result type

Parameters:

functionName - function name, must not be null or empty

arguments - list of function arguments

argumentsMapper - mapper for arguments object-to-MessagePack entity conversion

entityClass - target result entity class

Returns:

some result

Throws:

TarantoolClientException - if the client is not connected or some other error occurred

call

<T> CompletableFuture<TarantoolResult<T>> call(String functionName,
                                               List<?> arguments,
                                               MessagePackObjectMapper argumentsMapper,
                                               CallResultMapper<TarantoolResult<T>,SingleValueCallResult<TarantoolResult<T>>> resultMapper)
                                        throws TarantoolClientException

Execute a function defined on Tarantool instance. The call result is interpreted as an array of tuples.

Type Parameters:

T - desired function call result type

Parameters:

functionName - function name, must not be null or empty

arguments - list of function arguments

argumentsMapper - mapper for arguments object-to-MessagePack entity conversion

resultMapper - mapper for result value MessagePack entity-to-object conversion

Returns:

some result

Throws:

TarantoolClientException - if the client is not connected or some other error occurred

callForSingleResult

<T> CompletableFuture<T> callForSingleResult(String functionName,
                                             List<?> arguments,
                                             MessagePackObjectMapper argumentsMapper,
                                             Class<T> resultClass)
                                      throws TarantoolClientException

Execute a function defined on Tarantool instance. The first item of the call result will be interpreted as a value, and the second -- as an error

Type Parameters:

T - target result content type

Parameters:

functionName - function name, must not be null or empty

arguments - list of function arguments

argumentsMapper - mapper for arguments object-to-MessagePack entity conversion

resultClass - target result entity class

Returns:

some result

Throws:

TarantoolClientException - if the client is not connected or some other error occurred

callForSingleResult

<T> CompletableFuture<T> callForSingleResult(String functionName,
                                             List<?> arguments,
                                             MessagePackObjectMapper argumentsMapper,
                                             ValueConverter<org.msgpack.value.Value,T> valueConverter)
                                      throws TarantoolClientException

Execute a function defined on Tarantool instance. The first item of the call result will be interpreted as a value, and the second -- as an error

Type Parameters:

T - target result content type

Parameters:

functionName - function name, must not be null or empty

arguments - list of function arguments

argumentsMapper - mapper for arguments object-to-MessagePack entity conversion

valueConverter - MessagePack value to entity converter for each result item

Returns:

some result

Throws:

TarantoolClientException - if the client is not connected or some other error occurred

callForSingleResult

<T> CompletableFuture<T> callForSingleResult(String functionName,
                                             List<?> arguments,
                                             MessagePackObjectMapper argumentsMapper,
                                             CallResultMapper<T,SingleValueCallResult<T>> resultMapper)
                                      throws TarantoolClientException

Execute a function defined on Tarantool instance. The first item of the call result will be interpreted as a value, and the second -- as an error

Type Parameters:

T - target result content type

Parameters:

functionName - function name, must not be null or empty

arguments - list of function arguments

argumentsMapper - mapper for arguments object-to-MessagePack entity conversion

resultMapper - mapper for result conversion

Returns:

some result

Throws:

TarantoolClientException - if the client is not connected or some other error occurred

callForSingleResult

<T> CompletableFuture<T> callForSingleResult(String functionName,
                                             List<?> arguments,
                                             Class<T> resultClass)
                                      throws TarantoolClientException

Execute a function defined on Tarantool instance. The first item of the call result will be interpreted as a value, and the second -- as an error

Type Parameters:

T - target result content type

Parameters:

functionName - function name, must not be null or empty

arguments - list of function arguments

resultClass - target result entity class

Returns:

some result

Throws:

TarantoolClientException - if the client is not connected or some other error occurred

callForSingleResult

<T> CompletableFuture<T> callForSingleResult(String functionName,
                                             List<?> arguments,
                                             ValueConverter<org.msgpack.value.Value,T> valueConverter)
                                      throws TarantoolClientException

Execute a function defined on Tarantool instance. The first item of the call result will be interpreted as a value, and the second -- as an error

Type Parameters:

T - target result content type

Parameters:

functionName - function name, must not be null or empty

arguments - list of function arguments

valueConverter - MessagePack value to entity converter for each result item

Returns:

some result

Throws:

TarantoolClientException - if the client is not connected or some other error occurred

callForSingleResult

<T> CompletableFuture<T> callForSingleResult(String functionName,
                                             List<?> arguments,
                                             CallResultMapper<T,SingleValueCallResult<T>> resultMapper)
                                      throws TarantoolClientException

Execute a function defined on Tarantool instance. The first item of the call result will be interpreted as a value, and the second -- as an error

Type Parameters:

T - target result content type

Parameters:

functionName - function name, must not be null or empty

arguments - list of function arguments

resultMapper - mapper for result conversion

Returns:

some result

Throws:

TarantoolClientException - if the client is not connected or some other error occurred

callForSingleResult

<T> CompletableFuture<T> callForSingleResult(String functionName,
                                             Class<T> resultClass)
                                      throws TarantoolClientException

Execute a function defined on Tarantool instance. The first item of the call result will be interpreted as a value, and the second -- as an error

Type Parameters:

T - target result content type

Parameters:

functionName - function name, must not be null or empty

resultClass - target result entity class

Returns:

some result

Throws:

TarantoolClientException - if the client is not connected or some other error occurred

callForSingleResult

<T> CompletableFuture<T> callForSingleResult(String functionName,
                                             ValueConverter<org.msgpack.value.Value,T> valueConverter)
                                      throws TarantoolClientException

Execute a function defined on Tarantool instance. The first item of the call result will be interpreted as a value, and the second -- as an error

Type Parameters:

T - target result content type

Parameters:

functionName - function name, must not be null or empty

valueConverter - MessagePack value to entity converter for each result item

Returns:

some result

Throws:

TarantoolClientException - if the client is not connected or some other error occurred

callForSingleResult

<T> CompletableFuture<T> callForSingleResult(String functionName,
                                             CallResultMapper<T,SingleValueCallResult<T>> resultMapper)
                                      throws TarantoolClientException

Execute a function defined on Tarantool instance. The first item of the call result will be interpreted as a value, and the second -- as an error

Type Parameters:

T - target result content type

Parameters:

functionName - function name, must not be null or empty

resultMapper - mapper for result conversion

Returns:

some result

Throws:

TarantoolClientException - if the client is not connected or some other error occurred

callForMultiResult

<T,R extends List<T>> CompletableFuture<R> callForMultiResult(String functionName,
                                                                    List<?> arguments,
                                                                    MessagePackObjectMapper argumentsMapper,
                                                                    Supplier<R> resultContainerSupplier,
                                                                    Class<T> resultClass)
                                                             throws TarantoolClientException

Execute a function defined on Tarantool instance. All multi-return result items will be put into a list

Type Parameters:

T - target result content type

R - target result type

Parameters:

functionName - function name, must not be null or empty

arguments - list of function arguments

argumentsMapper - mapper for arguments object-to-MessagePack entity conversion

resultContainerSupplier - supplier function for new empty result collection

resultClass - target result entity class

Returns:

some result

Throws:

TarantoolClientException - if the client is not connected or some other error occurred

callForMultiResult

<T,R extends List<T>> CompletableFuture<R> callForMultiResult(String functionName,
                                                                    List<?> arguments,
                                                                    MessagePackObjectMapper argumentsMapper,
                                                                    Supplier<R> resultContainerSupplier,
                                                                    ValueConverter<org.msgpack.value.Value,T> valueConverter)
                                                             throws TarantoolClientException

Execute a function defined on Tarantool instance. All multi-return result items will be put into a list

Type Parameters:

T - target result content type

R - target result type

Parameters:

functionName - function name, must not be null or empty

arguments - list of function arguments

argumentsMapper - mapper for arguments object-to-MessagePack entity conversion

resultContainerSupplier - supplier function for new empty result collection

valueConverter - MessagePack value to entity converter for each result item

Returns:

some result

Throws:

TarantoolClientException - if the client is not connected or some other error occurred

callForMultiResult

<T,R extends List<T>> CompletableFuture<R> callForMultiResult(String functionName,
                                                                    List<?> arguments,
                                                                    MessagePackObjectMapper argumentsMapper,
                                                                    CallResultMapper<R,MultiValueCallResult<T,R>> resultMapper)
                                                             throws TarantoolClientException

Execute a function defined on Tarantool instance. All multi-return result items will be put into a list

Type Parameters:

T - target result content type

R - target result type

Parameters:

functionName - function name, must not be null or empty

arguments - list of function arguments

argumentsMapper - mapper for arguments object-to-MessagePack entity conversion

resultMapper - mapper for result conversion

Returns:

some result

Throws:

TarantoolClientException - if the client is not connected or some other error occurred

callForMultiResult

<T,R extends List<T>> CompletableFuture<R> callForMultiResult(String functionName,
                                                                    List<?> arguments,
                                                                    Supplier<R> resultContainerSupplier,
                                                                    Class<T> resultClass)
                                                             throws TarantoolClientException

Execute a function defined on Tarantool instance. All multi-return result items will be put into a list

Type Parameters:

T - target result content type

R - target result type

Parameters:

functionName - function name, must not be null or empty

arguments - list of function arguments

resultContainerSupplier - supplier function for new empty result collection

resultClass - target result entity class

Returns:

some result

Throws:

TarantoolClientException - if the client is not connected or some other error occurred

callForMultiResult

<T,R extends List<T>> CompletableFuture<R> callForMultiResult(String functionName,
                                                                    List<?> arguments,
                                                                    Supplier<R> resultContainerSupplier,
                                                                    ValueConverter<org.msgpack.value.Value,T> valueConverter)
                                                             throws TarantoolClientException

Execute a function defined on Tarantool instance. All multi-return result items will be put into a list

Type Parameters:

T - target result content type

R - target result type

Parameters:

functionName - function name, must not be null or empty

arguments - list of function arguments

resultContainerSupplier - supplier function for new empty result collection

valueConverter - MessagePack value to entity converter for each result item

Returns:

some result

Throws:

TarantoolClientException - if the client is not connected or some other error occurred

callForMultiResult

<T,R extends List<T>> CompletableFuture<R> callForMultiResult(String functionName,
                                                                    List<?> arguments,
                                                                    CallResultMapper<R,MultiValueCallResult<T,R>> resultMapper)
                                                             throws TarantoolClientException

Execute a function defined on Tarantool instance. All multi-return result items will be put into a list

Type Parameters:

T - target result content type

R - target result type

Parameters:

functionName - function name, must not be null or empty

arguments - list of function arguments

resultMapper - mapper for result conversion

Returns:

some result

Throws:

TarantoolClientException - if the client is not connected or some other error occurred

callForMultiResult

<T,R extends List<T>> CompletableFuture<R> callForMultiResult(String functionName,
                                                                    Supplier<R> resultContainerSupplier,
                                                                    Class<T> resultClass)
                                                             throws TarantoolClientException

Execute a function defined on Tarantool instance. All multi-return result items will be put into a list

Type Parameters:

T - target result content type

R - target result type

Parameters:

functionName - function name, must not be null or empty

resultContainerSupplier - supplier function for new empty result collection

resultClass - target result entity class

Returns:

some result

Throws:

TarantoolClientException - if the client is not connected or some other error occurred

callForMultiResult

<T,R extends List<T>> CompletableFuture<R> callForMultiResult(String functionName,
                                                                    Supplier<R> resultContainerSupplier,
                                                                    ValueConverter<org.msgpack.value.Value,T> valueConverter)
                                                             throws TarantoolClientException

Execute a function defined on Tarantool instance. All multi-return result items will be put into a list

Type Parameters:

T - target result content type

R - target result type

Parameters:

functionName - function name, must not be null or empty

resultContainerSupplier - supplier function for new empty result collection

valueConverter - MessagePack value to entity converter for each result item

Returns:

some result

Throws:

TarantoolClientException - if the client is not connected or some other error occurred

callForMultiResult

<T,R extends List<T>> CompletableFuture<R> callForMultiResult(String functionName,
                                                                    CallResultMapper<R,MultiValueCallResult<T,R>> resultMapper)
                                                             throws TarantoolClientException

Execute a function defined on Tarantool instance. All multi-return result items will be put into a list

Type Parameters:

T - target result content type

R - target result type

Parameters:

functionName - function name, must not be null or empty

resultMapper - mapper for result conversion

Returns:

some result

Throws:

TarantoolClientException - if the client is not connected or some other error occurred

getResultMapperFactoryFactory

ResultMapperFactoryFactory getResultMapperFactoryFactory()

Get the default factory for result mapper factory instances

Returns:

result mapper factory instances factory instance