org.jacpfx.vxms.event.response.basic

Class ExecuteEventbusStringResponse

java.lang.Object

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

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

org.jacpfx.vxms.event.response.basic.ExecuteEventbusStringResponse

Direct Known Subclasses:

ExecuteEventbusStringCircuitBreaker

public class ExecuteEventbusStringResponse
extends ExecuteEventbusString

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

Field Summary

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

chain, circuitBreakerTimeout, deliveryOptions, errorHandler, errorMethodHandler, excecuteEventBusAndReply, failure, message, methodId, onFailureRespond, 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<ExecutionStep> chain, ThrowableFutureConsumer<String> stringConsumer)
ExecuteEventbusStringResponse(String methodId, VxmsShared vxmsShared, Throwable failure, Consumer<Throwable> errorMethodHandler, io.vertx.core.eventbus.Message<Object> message, List<ExecutionStep> chain, ThrowableFutureConsumer<String> stringConsumer, ExecuteEventbusStringCall excecuteEventBusAndReply, Consumer<Throwable> errorHandler, ThrowableErrorConsumer<Throwable,String> onFailureRespond, io.vertx.core.eventbus.DeliveryOptions deliveryOptions, int retryCount, long timeout, long circuitBreakerTimeout) The constructor to pass all needed members

Method Summary

Modifier and Type	Method and Description
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)
ExecuteEventbusStringResponse	onFailureRespond(ThrowableErrorConsumer<Throwable,String> onFailureRespond) defines an action for errors in byte responses, you can handle the error and return an alternate createResponse value, this handler is a terminal handler and will be executed only once
ExecuteEventbusStringCircuitBreaker	retry(int retryCount) retry execution N times before
ExecuteEventbusStringResponse	timeout(long timeout) Defines how long a method can be executed before aborted.

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

execute, execute, 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<ExecutionStep> chain,
                                     ThrowableFutureConsumer<String> stringConsumer,
                                     ExecuteEventbusStringCall excecuteEventBusAndReply,
                                     Consumer<Throwable> errorHandler,
                                     ThrowableErrorConsumer<Throwable,String> onFailureRespond,
                                     io.vertx.core.eventbus.DeliveryOptions deliveryOptions,
                                     int retryCount,
                                     long timeout,
                                     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

stringConsumer - the consumer, producing the byte response

excecuteEventBusAndReply - 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

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<ExecutionStep> chain,
                                     ThrowableFutureConsumer<String> stringConsumer)

Method Detail

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

timeout

public ExecuteEventbusStringResponse timeout(long timeout)

Defines how long a method can be executed before aborted.

Parameters:

timeout - the amount of timeout in ms

Returns:

the response chain ExecuteEventbusStringResponse

retry

public ExecuteEventbusStringCircuitBreaker retry(int retryCount)

retry execution N times before

Parameters:

retryCount - the amount of retries

Returns:

the response chain ExecuteEventbusStringCircuitBreaker

onFailureRespond

public ExecuteEventbusStringResponse onFailureRespond(ThrowableErrorConsumer<Throwable,String> onFailureRespond)

defines an action for errors in byte responses, you can handle the error and return an alternate createResponse value, this handler is a terminal handler and will be executed only once

Parameters:

onFailureRespond - the handler (function) to execute on error

Returns:

the response chain ExecuteEventbusStringResponse