org.apache.camel.builder.endpoint.dsl

Interface BeanEndpointBuilderFactory.BeanEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

Enclosing interface:

BeanEndpointBuilderFactory

public static interface BeanEndpointBuilderFactory.BeanEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint for the Bean component.

Method Summary

Modifier and Type	Method and Description
default BeanEndpointBuilderFactory.AdvancedBeanEndpointBuilder	advanced()
default BeanEndpointBuilderFactory.BeanEndpointBuilder	cache(Boolean cache) Deprecated.
default BeanEndpointBuilderFactory.BeanEndpointBuilder	cache(String cache) Deprecated.
default BeanEndpointBuilderFactory.BeanEndpointBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default BeanEndpointBuilderFactory.BeanEndpointBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default BeanEndpointBuilderFactory.BeanEndpointBuilder	method(String method) Sets the name of the method to invoke on the bean.
default BeanEndpointBuilderFactory.BeanEndpointBuilder	scope(org.apache.camel.BeanScope scope) Scope of bean.
default BeanEndpointBuilderFactory.BeanEndpointBuilder	scope(String scope) Scope of bean.

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default BeanEndpointBuilderFactory.AdvancedBeanEndpointBuilder advanced()

cache

@Deprecated
default BeanEndpointBuilderFactory.BeanEndpointBuilder cache(Boolean cache)

Deprecated.

Use scope option instead. The option is a: <code>java.lang.Boolean</code> type. Group: common

Parameters:

cache - the value to set

Returns:

the dsl builder

cache

@Deprecated
default BeanEndpointBuilderFactory.BeanEndpointBuilder cache(String cache)

Deprecated.

Use scope option instead. The option will be converted to a <code>java.lang.Boolean</code> type. Group: common

Parameters:

cache - the value to set

Returns:

the dsl builder

method

default BeanEndpointBuilderFactory.BeanEndpointBuilder method(String method)

Sets the name of the method to invoke on the bean. The option is a: <code>java.lang.String</code> type. Group: common

Parameters:

method - the value to set

Returns:

the dsl builder

scope

default BeanEndpointBuilderFactory.BeanEndpointBuilder scope(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 then this depends on the delegated registry. The option is a: <code>org.apache.camel.BeanScope</code> type. Default: Singleton Group: common

Parameters:

scope - the value to set

Returns:

the dsl builder

scope

default BeanEndpointBuilderFactory.BeanEndpointBuilder scope(String 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 then this depends on the delegated registry. The option will be converted to a <code>org.apache.camel.BeanScope</code> type. Default: Singleton Group: common

Parameters:

scope - the value to set

Returns:

the dsl builder

lazyStartProducer

default BeanEndpointBuilderFactory.BeanEndpointBuilder lazyStartProducer(boolean lazyStartProducer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer

Parameters:

lazyStartProducer - the value to set

Returns:

the dsl builder

lazyStartProducer

default BeanEndpointBuilderFactory.BeanEndpointBuilder lazyStartProducer(String lazyStartProducer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option will be converted to a <code>boolean</code> type. Default: false Group: producer

Parameters:

lazyStartProducer - the value to set

Returns:

the dsl builder