org.apache.camel.model

Class HystrixDefinition

java.lang.Object

org.apache.camel.model.OptionalIdentifiedDefinition<Type>

org.apache.camel.model.ProcessorDefinition<HystrixDefinition>

org.apache.camel.model.HystrixDefinition

All Implemented Interfaces:

Block, OtherAttributesAware, NamedNode

@Metadata(label="eip,routing,circuitbreaker")
public class HystrixDefinition
extends ProcessorDefinition<HystrixDefinition>

Hystrix Circuit Breaker EIP

Field Summary

Fields inherited from class org.apache.camel.model.ProcessorDefinition

inheritErrorHandler, log

Constructor Summary

Constructors

Constructor and Description
HystrixDefinition()

Method Summary

Modifier and Type	Method and Description
void	addOutput(ProcessorDefinition<?> output) Adds the given definition as output to this block
Processor	createProcessor(RouteContext routeContext) Override this in definition class and implement logic to create the processor based on the definition model.
ProcessorDefinition<?>	end() Ends the current block
HystrixConfigurationDefinition	getHystrixConfiguration()
String	getHystrixConfigurationRef()
String	getLabel() Returns a label to describe this node such as the expression if some kind of expression node
OnFallbackDefinition	getOnFallback()
List<ProcessorDefinition<?>>	getOutputs()
HystrixDefinition	groupKey(String groupKey) Sets the group key to use.
HystrixConfigurationDefinition	hystrixConfiguration() Configures the Hystrix EIP Use end when configuration is complete, to return back to the Hystrix EIP.
HystrixDefinition	hystrixConfiguration(HystrixConfigurationDefinition configuration) Configures the Hystrix EIP using the given configuration
HystrixDefinition	hystrixConfiguration(String ref) Refers to a Hystrix configuration to use for configuring the Hystrix EIP.
boolean	isOutputSupported()
HystrixDefinition	onFallback() The Hystrix fallback route path to execute that does not go over the network.
HystrixDefinition	onFallbackViaNetwork() The Hystrix fallback route path to execute that will go over the network.
protected void	preCreateProcessor() Strategy to execute any custom logic before the Processor is created.
void	setHystrixConfiguration(HystrixConfigurationDefinition hystrixConfiguration)
void	setHystrixConfigurationRef(String hystrixConfigurationRef) Refers to a Hystrix configuration to use for configuring the Hystrix EIP.
void	setOnFallback(OnFallbackDefinition onFallback)
void	setOutputs(List<ProcessorDefinition<?>> outputs)
HystrixDefinition	threadPoolKey(String threadPoolKey) Sets the thread pool key to use.
String	toString()

Methods inherited from class org.apache.camel.model.ProcessorDefinition

addInterceptStrategies, addInterceptStrategy, addRoutes, aggregate, aggregate, aggregate, aggregate, aop, attribute, bean, bean, bean, bean, bean, bean, bean, bean, beanRef, beanRef, beanRef, beanRef, beanRef, choice, claimCheck, claimCheck, claimCheck, claimCheck, clearOutput, configureChild, convertBodyTo, convertBodyTo, createChannel, createChildProcessor, createCompositeProcessor, createOutputsProcessor, createOutputsProcessor, createOutputsProcessorImpl, createProcessor, delay, delay, delay, doTry, dynamicRouter, dynamicRouter, endChoice, endDoTry, endHystrix, endParent, endRest, enrich, enrich, enrich, enrich, enrich, enrichRef, enrichRef, enrichRef, enrichWith, enrichWith, enrichWith, filter, filter, filter, filter, getIndex, getInterceptStrategies, getOtherAttributes, getParent, hystrix, id, idempotentConsumer, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, inOnly, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, inOut, isAbstract, isInheritErrorHandler, isTopLevelOnly, isWrappingEntireOutput, loadBalance, loadBalance, log, log, log, log, log, log, loop, loop, loop, loopDoWhile, loopDoWhile, makeProcessor, markRollbackOnly, markRollbackOnlyLast, marshal, marshal, marshal, marshal, multicast, multicast, multicast, onCompletion, onException, onException, pipeline, pipeline, pipeline, pipeline, placeholder, policy, policy, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrichRef, pollEnrichRef, pollEnrichWith, pollEnrichWith, pollEnrichWith, process, process, process, processRef, recipientList, recipientList, recipientList, recipientList, removeFaultHeader, removeHeader, removeHeaders, removeHeaders, removeProperties, removeProperties, removeProperty, resequence, resequence, rollback, rollback, routeDescription, routeGroup, routeId, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, saga, sample, sample, sample, script, script, serviceCall, serviceCall, serviceCall, setBody, setBody, setBody, setBody, setExchangePattern, setFaultBody, setFaultHeader, setHeader, setHeader, setHeader, setInheritErrorHandler, setOtherAttributes, setOutHeader, setOutHeader, setParent, setProperty, setProperty, sort, sort, sort, split, split, split, startupOrder, stop, threads, threads, threads, threads, throttle, throttle, throttle, throwException, throwException, to, to, to, to, to, to, to, to, to, to, toD, toD, toD, toF, transacted, transacted, transform, transform, unmarshal, unmarshal, unmarshal, unmarshal, validate, validate, validate, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wrapChannel, wrapChannel, wrapInErrorHandler, wrapProcessor

Methods inherited from class org.apache.camel.model.OptionalIdentifiedDefinition

description, description, getCustomId, getDescription, getDescriptionText, getId, getShortName, hasCustomIdAssigned, idOrCreate, setCustomId, setDescription, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

HystrixDefinition

public HystrixDefinition()

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getLabel

public String getLabel()

Description copied from class: ProcessorDefinition

Returns a label to describe this node such as the expression if some kind of expression node

Specified by:

getLabel in interface NamedNode

Overrides:

getLabel in class ProcessorDefinition<HystrixDefinition>

createProcessor

public Processor createProcessor(RouteContext routeContext)
                          throws Exception

Description copied from class: ProcessorDefinition

Override this in definition class and implement logic to create the processor based on the definition model.

Overrides:

createProcessor in class ProcessorDefinition<HystrixDefinition>

Throws:

Exception

getOutputs

public List<ProcessorDefinition<?>> getOutputs()

Specified by:

getOutputs in class ProcessorDefinition<HystrixDefinition>

isOutputSupported

public boolean isOutputSupported()

Specified by:

isOutputSupported in class ProcessorDefinition<HystrixDefinition>

setOutputs

public void setOutputs(List<ProcessorDefinition<?>> outputs)

addOutput

public void addOutput(ProcessorDefinition<?> output)

Description copied from interface: Block

Adds the given definition as output to this block

Specified by:

addOutput in interface Block

Overrides:

addOutput in class ProcessorDefinition<HystrixDefinition>

Parameters:

output - the processor definition

end

public ProcessorDefinition<?> end()

Description copied from class: ProcessorDefinition

Ends the current block

Overrides:

end in class ProcessorDefinition<HystrixDefinition>

Returns:

the builder

preCreateProcessor

protected void preCreateProcessor()

Description copied from class: ProcessorDefinition

Strategy to execute any custom logic before the Processor is created.

Overrides:

preCreateProcessor in class ProcessorDefinition<HystrixDefinition>

getHystrixConfiguration

public HystrixConfigurationDefinition getHystrixConfiguration()

setHystrixConfiguration

public void setHystrixConfiguration(HystrixConfigurationDefinition hystrixConfiguration)

getHystrixConfigurationRef

public String getHystrixConfigurationRef()

setHystrixConfigurationRef

public void setHystrixConfigurationRef(String hystrixConfigurationRef)

Refers to a Hystrix configuration to use for configuring the Hystrix EIP.

getOnFallback

public OnFallbackDefinition getOnFallback()

setOnFallback

public void setOnFallback(OnFallbackDefinition onFallback)

groupKey

public HystrixDefinition groupKey(String groupKey)

Sets the group key to use. The default value is CamelHystrix.

threadPoolKey

public HystrixDefinition threadPoolKey(String threadPoolKey)

Sets the thread pool key to use. The default value is CamelHystrix.

hystrixConfiguration

public HystrixConfigurationDefinition hystrixConfiguration()

Configures the Hystrix EIP

Use end when configuration is complete, to return back to the Hystrix EIP.

hystrixConfiguration

public HystrixDefinition hystrixConfiguration(HystrixConfigurationDefinition configuration)

Configures the Hystrix EIP using the given configuration

hystrixConfiguration

public HystrixDefinition hystrixConfiguration(String ref)

Refers to a Hystrix configuration to use for configuring the Hystrix EIP.

onFallback

public HystrixDefinition onFallback()

The Hystrix fallback route path to execute that does not go over the network.

This should be a static or cached result that can immediately be returned upon failure. If the fallback requires network connection then use onFallbackViaNetwork().

onFallbackViaNetwork

public HystrixDefinition onFallbackViaNetwork()

The Hystrix fallback route path to execute that will go over the network.

If the fallback will go over the network it is another possible point of failure and so it also needs to be wrapped by a HystrixCommand. It is important to execute the fallback command on a separate thread-pool, otherwise if the main command were to become latent and fill the thread-pool this would prevent the fallback from running if the two commands share the same pool.