Package org.apache.camel.model

Class BeanDefinition

java.lang.Object

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

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

org.apache.camel.model.NoOutputDefinition<BeanDefinition>

org.apache.camel.model.BeanDefinition

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.LineNumberAware, Block, org.apache.camel.NamedNode, org.apache.camel.spi.HasCamelContext, org.apache.camel.spi.HasId, org.apache.camel.spi.IdAware

@Metadata(label="eip,endpoint")
public class BeanDefinition
extends NoOutputDefinition<BeanDefinition>

Calls a Java bean

Field Summary

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

disabled, inheritErrorHandler

Constructor Summary

Constructors

Constructor	Description
BeanDefinition()
BeanDefinition(String ref)
BeanDefinition(String ref, String method)

Method Summary

Modifier and Type	Method	Description
String	description()
Object	getBean()
Class<?>	getBeanClass()
String	getBeanType()
String	getLabel()	Returns a label to describe this node such as the expression if some kind of expression node
String	getMethod()
String	getRef()
String	getScope()
String	getShortName()
void	setBean(Object bean)	Sets an existing instance of the bean to use
void	setBeanType(Class<?> beanType)	Sets the class name (fully qualified) of the bean to use
void	setBeanType(String beanType)	Sets the class name (fully qualified) of the bean to use
void	setMethod(String method)	Sets the method name on the bean to use
void	setRef(String ref)	Sets a reference to an exiting bean to use, which is looked up from the registry
void	setScope(String scope)
void	setScope(org.apache.camel.BeanScope scope)	Scope of bean.
String	toString()

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

getOutputs

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

addInterceptStrategy, addOutput, aggregate, aggregate, aggregate, aggregate, bean, bean, bean, bean, bean, bean, bean, bean, bean, bean, bean, choice, circuitBreaker, claimCheck, claimCheck, claimCheck, claimCheck, clearOutput, configureChild, convertBodyTo, convertBodyTo, convertBodyTo, delay, delay, delay, disabled, disabled, disabled, doTry, dynamicRouter, dynamicRouter, end, endChoice, endCircuitBreaker, endDoCatch, endDoTry, endParent, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, filter, filter, filter, filter, getDisabled, getIndex, getInterceptStrategies, getParent, getRouteConfiguration, id, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, isAbstract, isInheritErrorHandler, isTopLevelOnly, isWrappingEntireOutput, kamelet, loadBalance, loadBalance, log, log, log, log, log, log, loop, loop, loop, loopDoWhile, loopDoWhile, markRollbackOnly, markRollbackOnlyLast, marshal, marshal, marshal, marshal, multicast, multicast, multicast, nodePrefixId, onCompletion, onException, onException, onException, onException, pausable, pausable, pausable, pausable, pipeline, pipeline, pipeline, policy, policy, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, preCreateProcessor, process, process, process, recipientList, recipientList, recipientList, recipientList, removeHeader, removeHeaders, removeHeaders, removeProperties, removeProperties, removeProperty, resequence, resequence, resumable, resumable, resumable, rollback, rollback, routeDescription, routeGroup, routeId, routingSlip, routingSlip, routingSlip, saga, sample, sample, sample, sample, script, script, serviceCall, serviceCall, serviceCall, setBody, setBody, setBody, setDisabled, setExchangePattern, setExchangePattern, setHeader, setHeader, setHeader, setInheritErrorHandler, setParent, setProperty, setProperty, setProperty, setRouteConfiguration, sort, sort, sort, split, split, split, split, startupOrder, step, step, stop, threads, threads, threads, threads, throttle, throttle, throttle, throttle, throttle, throwException, throwException, to, to, to, to, to, to, to, to, to, to, to, to, toD, toD, toD, toD, toD, toD, toD, toF, transacted, transacted, transform, transform, transform, transform, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, validate, validate, validate, wireTap, wireTap, wireTap

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

description, getCamelContext, getCustomId, getDescription, getDescriptionText, getId, getLineNumber, getLocation, hasCustomIdAssigned, idOrCreate, setCamelContext, setCustomId, setDescription, setGeneratedId, setId, setLineNumber, setLocation

Methods inherited from class java.lang.Object

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

Constructor Details

BeanDefinition

public BeanDefinition()

BeanDefinition

public BeanDefinition(String ref)

BeanDefinition

public BeanDefinition(String ref,
 String method)

Method Details

toString

public String toString()

Overrides:

toString in class Object

description

public String description()

getShortName

public String getShortName()

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 org.apache.camel.NamedNode

Overrides:

getLabel in class ProcessorDefinition<BeanDefinition>

getRef

public String getRef()

setRef

public void setRef(String ref)

Sets a reference to an exiting bean to use, which is looked up from the registry

getMethod

public String getMethod()

setMethod

public void setMethod(String method)

Sets the method name on the bean to use

setBean

public void setBean(Object bean)

Sets an existing instance of the bean to use

getBean

public Object getBean()

getBeanType

public String getBeanType()

setBeanType

public void setBeanType(String beanType)

Sets the class name (fully qualified) of the bean to use

getBeanClass

public Class<?> getBeanClass()

setBeanType

public void setBeanType(Class<?> beanType)

Sets the class name (fully qualified) of the bean to use

getScope

public String getScope()

setScope

public void setScope(String scope)

setScope

public void setScope(org.apache.camel.BeanScope scope)

Scope of bean. When using singleton scope (default) the bean is created or looked up only once and reused for the lifetime of the endpoint. The bean should be thread-safe in case concurrent threads is calling the bean at the same time. When using request scope the bean is created or looked up once per request (exchange). This can be used if you want to store state on a bean while processing a request and you want to call the same bean instance multiple times while processing the request. The bean does not have to be thread-safe as the instance is only called from the same request. When using prototype scope, then the bean will be looked up or created per call. However in case of lookup then this is delegated to the bean registry such as Spring or CDI (if in use), which depends on their configuration can act as either singleton or prototype scope. So when using prototype scope then this depends on the bean registry implementation.