org.jacpfx.vxms.event.response.blocking

Class ExecuteEventbusStringResponse

java.lang.Object

org.jacpfx.vxms.event.response.AbstractResponse<String>

org.jacpfx.vxms.event.response.basic.ExecuteEventbusString

org.jacpfx.vxms.event.response.blocking.ExecuteEventbusString

org.jacpfx.vxms.event.response.blocking.ExecuteEventbusStringResponse

Direct Known Subclasses:

ExecuteEventbusStringCircuitBreaker

public class ExecuteEventbusStringResponse
extends ExecuteEventbusString

Created by Andy Moncsek on 12.01.16. Fluent API for byte responses, defines access to failure handling, timeouts,...

Field Summary

Fields inherited from class org.jacpfx.vxms.event.response.blocking.ExecuteEventbusString

chain, delay, excecuteAsyncEventBusAndReply, onFailureRespond, stringSupplier

Fields inherited from class org.jacpfx.vxms.event.response.basic.ExecuteEventbusString

circuitBreakerTimeout, deliveryOptions, errorHandler, errorMethodHandler, excecuteEventBusAndReply, failure, message, methodId, retryCount, stringConsumer, timeout, vxmsShared

Constructor Summary

Constructors

Constructor and Description
ExecuteEventbusStringResponse(String methodId, VxmsShared vxmsShared, Throwable failure, Consumer<Throwable> errorMethodHandler, io.vertx.core.eventbus.Message<Object> message, List<BlockingExecutionStep> chain, ThrowableSupplier<String> stringSupplier) The constructor to pass minimal needed members
ExecuteEventbusStringResponse(String methodId, VxmsShared vxmsShared, Throwable failure, Consumer<Throwable> errorMethodHandler, io.vertx.core.eventbus.Message<Object> message, List<BlockingExecutionStep> chain, ThrowableSupplier<String> stringSupplier, ExecuteEventbusStringCall excecuteAsyncEventBusAndReply, Consumer<Throwable> errorHandler, ThrowableFunction<Throwable,String> onFailureRespond, io.vertx.core.eventbus.DeliveryOptions deliveryOptions, int retryCount, long timeout, long delay, long circuitBreakerTimeout) The constructor to pass all needed members

Method Summary

Modifier and Type	Method and Description
ExecuteEventbusStringResponse	delay(long delay) Defines the delay (in ms) between the createResponse retries (on error).
ExecuteEventbusStringResponse	onError(Consumer<Throwable> errorHandler) intermediate error handler which will be called on each error (at least 1 time, in case on N retries... up to N times)
ExecuteEventbusString	onFailureRespond(ThrowableFunction<Throwable,String> onFailureRespond) defines an action for errors in byte responses, you can handle the error and return an alternate createResponse value
ExecuteEventbusStringCircuitBreaker	retry(int retryCount) retry operation on error
ExecuteEventbusStringResponse	timeout(long timeout) Defines how long a method can be executed before aborted.

Methods inherited from class org.jacpfx.vxms.event.response.blocking.ExecuteEventbusString

execute, execute

Methods inherited from class org.jacpfx.vxms.event.response.basic.ExecuteEventbusString

fail, respond

Methods inherited from class org.jacpfx.vxms.event.response.AbstractResponse

executeBlocking, executeBlockingStep, executeStep, getBlockingResultHandler, getBlockingResultHandler, getResultHandler

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecuteEventbusStringResponse

public ExecuteEventbusStringResponse(String methodId,
                                     VxmsShared vxmsShared,
                                     Throwable failure,
                                     Consumer<Throwable> errorMethodHandler,
                                     io.vertx.core.eventbus.Message<Object> message,
                                     List<BlockingExecutionStep> chain,
                                     ThrowableSupplier<String> stringSupplier,
                                     ExecuteEventbusStringCall excecuteAsyncEventBusAndReply,
                                     Consumer<Throwable> errorHandler,
                                     ThrowableFunction<Throwable,String> onFailureRespond,
                                     io.vertx.core.eventbus.DeliveryOptions deliveryOptions,
                                     int retryCount,
                                     long timeout,
                                     long delay,
                                     long circuitBreakerTimeout)

The constructor to pass all needed members

Parameters:

methodId - the method identifier

vxmsShared - the vxmsShared instance, containing the Vertx instance and other shared objects per instance

failure - the failure thrown while task execution

errorMethodHandler - the error handler

message - the message to responde to

chain - the execution chain

stringSupplier - the supplier, producing the byte response

excecuteAsyncEventBusAndReply - the response of an event-bus call which is passed to the fluent API

errorHandler - the error handler

onFailureRespond - the consumer that takes a Future with the alternate response value in case of failure

deliveryOptions - the response delivery serverOptions

retryCount - the amount of retries before failure execution is triggered

timeout - the amount of time before the execution will be aborted

delay - the delay time in ms between an execution error and the retry

circuitBreakerTimeout - the amount of time before the circuit breaker closed again

ExecuteEventbusStringResponse

public ExecuteEventbusStringResponse(String methodId,
                                     VxmsShared vxmsShared,
                                     Throwable failure,
                                     Consumer<Throwable> errorMethodHandler,
                                     io.vertx.core.eventbus.Message<Object> message,
                                     List<BlockingExecutionStep> chain,
                                     ThrowableSupplier<String> stringSupplier)

The constructor to pass minimal needed members

Parameters:

methodId - the method identifier

vxmsShared - the vxmsShared instance, containing the Vertx instance and other shared objects per instance

failure - the failure thrown while task execution

errorMethodHandler - the error handler

message - the message to responde to

chain - the execution chain

stringSupplier - the supplier, producing the byte response

Method Detail

onFailureRespond

public ExecuteEventbusString onFailureRespond(ThrowableFunction<Throwable,String> onFailureRespond)

defines an action for errors in byte responses, you can handle the error and return an alternate createResponse value

Parameters:

onFailureRespond - the handler (function) to execute on error

Returns:

the createResponse chain ExecuteEventbusString

onError

public ExecuteEventbusStringResponse onError(Consumer<Throwable> errorHandler)

intermediate error handler which will be called on each error (at least 1 time, in case on N retries... up to N times)

Parameters:

errorHandler - the handler to be executed on each error

Returns:

the response chain ExecuteEventbusStringResponse

retry

public ExecuteEventbusStringCircuitBreaker retry(int retryCount)

retry operation on error

Parameters:

retryCount - the amount of retries before failing the operation

Returns:

the createResponse chain ExecuteEventbusStringCircuitBreaker

timeout

public ExecuteEventbusStringResponse timeout(long timeout)

Defines how long a method can be executed before aborted.

Parameters:

timeout - time to wait in ms

Returns:

the createResponse chain ExecuteEventbusStringResponse

delay

public ExecuteEventbusStringResponse delay(long delay)

Defines the delay (in ms) between the createResponse retries (on error).

Parameters:

delay - the delay time in ms before retry

Returns:

the createResponse chain ExecuteEventbusStringResponse