org.jacpfx.vxms.event.response.blocking

Class ExecuteEventbusByteResponse

java.lang.Object

org.jacpfx.vxms.event.response.AbstractResponse<byte[]>

org.jacpfx.vxms.event.response.basic.ExecuteEventbusByte

org.jacpfx.vxms.event.response.blocking.ExecuteEventbusByte

org.jacpfx.vxms.event.response.blocking.ExecuteEventbusByteResponse

Direct Known Subclasses:

ExecuteEventbusByteCircuitBreaker

public class ExecuteEventbusByteResponse
extends ExecuteEventbusByte

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.ExecuteEventbusByte

byteSupplier, chain, delay, excecuteAsyncEventBusAndReply, onFailureRespond

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

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

Constructor Summary

Constructors

Constructor and Description
ExecuteEventbusByteResponse(String methodId, VxmsShared vxmsShared, Throwable failure, Consumer<Throwable> errorMethodHandler, io.vertx.core.eventbus.Message<Object> message, List<BlockingExecutionStep> chain, ThrowableSupplier<byte[]> byteSupplier) The constructor to pass needed members
ExecuteEventbusByteResponse(String methodId, VxmsShared vxmsShared, Throwable failure, Consumer<Throwable> errorMethodHandler, io.vertx.core.eventbus.Message<Object> message, List<BlockingExecutionStep> chain, ThrowableSupplier<byte[]> byteSupplier, ExecuteEventbusByteCall excecuteAsyncEventBusAndReply, Consumer<Throwable> errorHandler, ThrowableFunction<Throwable,byte[]> 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
ExecuteEventbusByteResponse	delay(long delay) Defines the delay (in ms) between the createResponse retries.
ExecuteEventbusByteResponse	onError(Consumer<Throwable> errorHandler) Will be executed on each error
ExecuteEventbusByte	onFailureRespond(ThrowableFunction<Throwable,byte[]> onFailureRespond) defines an action for errors in byte responses, you can handle the error and return an alternate createResponse value
ExecuteEventbusByteCircuitBreaker	retry(int retryCount) retry operation on error
ExecuteEventbusByteResponse	timeout(long timeout) Defines how long a method can be executed before aborted.

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

execute, execute

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

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

ExecuteEventbusByteResponse

public ExecuteEventbusByteResponse(String methodId,
                                   VxmsShared vxmsShared,
                                   Throwable failure,
                                   Consumer<Throwable> errorMethodHandler,
                                   io.vertx.core.eventbus.Message<Object> message,
                                   List<BlockingExecutionStep> chain,
                                   ThrowableSupplier<byte[]> byteSupplier,
                                   ExecuteEventbusByteCall excecuteAsyncEventBusAndReply,
                                   Consumer<Throwable> errorHandler,
                                   ThrowableFunction<Throwable,byte[]> 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

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

ExecuteEventbusByteResponse

public ExecuteEventbusByteResponse(String methodId,
                                   VxmsShared vxmsShared,
                                   Throwable failure,
                                   Consumer<Throwable> errorMethodHandler,
                                   io.vertx.core.eventbus.Message<Object> message,
                                   List<BlockingExecutionStep> chain,
                                   ThrowableSupplier<byte[]> byteSupplier)

The constructor to pass 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

byteSupplier - the supplier, producing the byte response

Method Detail

onFailureRespond

public ExecuteEventbusByte onFailureRespond(ThrowableFunction<Throwable,byte[]> 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 ExecuteEventbusByte

onError

public ExecuteEventbusByteResponse onError(Consumer<Throwable> errorHandler)

Will be executed on each error

Parameters:

errorHandler - the handler to be executed on each error

Returns:

the createResponse chain ExecuteEventbusByteResponse

retry

public ExecuteEventbusByteCircuitBreaker retry(int retryCount)

retry operation on error

Parameters:

retryCount - the amount of retries before failing the operation

Returns:

the createResponse chain ExecuteEventbusByteResponse

timeout

public ExecuteEventbusByteResponse timeout(long timeout)

Defines how long a method can be executed before aborted.

Parameters:

timeout - time to wait in ms

Returns:

the createResponse chain ExecuteEventbusByteResponse

delay

public ExecuteEventbusByteResponse delay(long delay)

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

Parameters:

delay - the delay time in ms before retry

Returns:

the createResponse chain ExecuteEventbusByteResponse