org.apache.camel.builder.component.dsl

Interface VelocityComponentBuilderFactory.VelocityComponentBuilder

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.velocity.VelocityComponent>

All Known Implementing Classes:

VelocityComponentBuilderFactory.VelocityComponentBuilderImpl

Enclosing interface:

VelocityComponentBuilderFactory

public static interface VelocityComponentBuilderFactory.VelocityComponentBuilder
extends ComponentBuilder<org.apache.camel.component.velocity.VelocityComponent>

Builder for the Velocity component.

Method Summary

Modifier and Type	Method and Description
default VelocityComponentBuilderFactory.VelocityComponentBuilder	allowContextMapAll(boolean allowContextMapAll) Sets whether the context map should allow access to all details.
default VelocityComponentBuilderFactory.VelocityComponentBuilder	allowTemplateFromHeader(boolean allowTemplateFromHeader) Whether to allow to use resource template from header or not (default false).
default VelocityComponentBuilderFactory.VelocityComponentBuilder	autowiredEnabled(boolean autowiredEnabled) Whether autowiring is enabled.
default VelocityComponentBuilderFactory.VelocityComponentBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default VelocityComponentBuilderFactory.VelocityComponentBuilder	velocityEngine(org.apache.velocity.app.VelocityEngine velocityEngine) To use the VelocityEngine otherwise a new engine is created.

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

build, build, doSetProperty, register

Method Detail

allowContextMapAll

default VelocityComponentBuilderFactory.VelocityComponentBuilder allowContextMapAll(boolean allowContextMapAll)

Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API. The option is a: <code>boolean</code> type. Default: false Group: producer

Parameters:

allowContextMapAll - the value to set

Returns:

the dsl builder

allowTemplateFromHeader

default VelocityComponentBuilderFactory.VelocityComponentBuilder allowTemplateFromHeader(boolean allowTemplateFromHeader)

Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care. The option is a: <code>boolean</code> type. Default: false Group: producer

Parameters:

allowTemplateFromHeader - the value to set

Returns:

the dsl builder

lazyStartProducer

default VelocityComponentBuilderFactory.VelocityComponentBuilder 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

autowiredEnabled

default VelocityComponentBuilderFactory.VelocityComponentBuilder autowiredEnabled(boolean autowiredEnabled)

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced

Parameters:

autowiredEnabled - the value to set

Returns:

the dsl builder

velocityEngine

default VelocityComponentBuilderFactory.VelocityComponentBuilder velocityEngine(org.apache.velocity.app.VelocityEngine velocityEngine)

To use the VelocityEngine otherwise a new engine is created. The option is a: <code>org.apache.velocity.app.VelocityEngine</code> type. Group: advanced

Parameters:

velocityEngine - the value to set

Returns:

the dsl builder