org.apache.camel.builder.endpoint.dsl

Interface VelocityEndpointBuilderFactory.VelocityEndpointBuilder

All Superinterfaces:

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

Enclosing interface:

VelocityEndpointBuilderFactory

public static interface VelocityEndpointBuilderFactory.VelocityEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint for the Velocity component.

Method Summary

Modifier and Type	Method and Description
default VelocityEndpointBuilderFactory.VelocityEndpointBuilder	allowContextMapAll(boolean allowContextMapAll) Sets whether the context map should allow access to all details.
default VelocityEndpointBuilderFactory.VelocityEndpointBuilder	allowContextMapAll(String allowContextMapAll) Sets whether the context map should allow access to all details.
default VelocityEndpointBuilderFactory.VelocityEndpointBuilder	allowTemplateFromHeader(boolean allowTemplateFromHeader) Whether to allow to use resource template from header or not (default false).
default VelocityEndpointBuilderFactory.VelocityEndpointBuilder	allowTemplateFromHeader(String allowTemplateFromHeader) Whether to allow to use resource template from header or not (default false).
default VelocityEndpointBuilderFactory.VelocityEndpointBuilder	contentCache(boolean contentCache) Sets whether to use resource content cache or not.
default VelocityEndpointBuilderFactory.VelocityEndpointBuilder	contentCache(String contentCache) Sets whether to use resource content cache or not.
default VelocityEndpointBuilderFactory.VelocityEndpointBuilder	encoding(String encoding) Character encoding of the resource content.
default VelocityEndpointBuilderFactory.VelocityEndpointBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default VelocityEndpointBuilderFactory.VelocityEndpointBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default VelocityEndpointBuilderFactory.VelocityEndpointBuilder	loaderCache(boolean loaderCache) Enables / disables the velocity resource loader cache which is enabled by default.
default VelocityEndpointBuilderFactory.VelocityEndpointBuilder	loaderCache(String loaderCache) Enables / disables the velocity resource loader cache which is enabled by default.
default VelocityEndpointBuilderFactory.VelocityEndpointBuilder	propertiesFile(String propertiesFile) The URI of the properties file which is used for VelocityEngine initialization.

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

allowContextMapAll

default VelocityEndpointBuilderFactory.VelocityEndpointBuilder 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

allowContextMapAll

default VelocityEndpointBuilderFactory.VelocityEndpointBuilder allowContextMapAll(String 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 will be converted to a <code>boolean</code> type. Default: false Group: producer

Parameters:

allowContextMapAll - the value to set

Returns:

the dsl builder

allowTemplateFromHeader

default VelocityEndpointBuilderFactory.VelocityEndpointBuilder 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

allowTemplateFromHeader

default VelocityEndpointBuilderFactory.VelocityEndpointBuilder allowTemplateFromHeader(String 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 will be converted to a <code>boolean</code> type. Default: false Group: producer

Parameters:

allowTemplateFromHeader - the value to set

Returns:

the dsl builder

contentCache

default VelocityEndpointBuilderFactory.VelocityEndpointBuilder contentCache(boolean contentCache)

Sets whether to use resource content cache or not. The option is a: <code>boolean</code> type. Default: false Group: producer

Parameters:

contentCache - the value to set

Returns:

the dsl builder

contentCache

default VelocityEndpointBuilderFactory.VelocityEndpointBuilder contentCache(String contentCache)

Sets whether to use resource content cache or not. The option will be converted to a <code>boolean</code> type. Default: false Group: producer

Parameters:

contentCache - the value to set

Returns:

the dsl builder

encoding

default VelocityEndpointBuilderFactory.VelocityEndpointBuilder encoding(String encoding)

Character encoding of the resource content. The option is a: <code>java.lang.String</code> type. Group: producer

Parameters:

encoding - the value to set

Returns:

the dsl builder

lazyStartProducer

default VelocityEndpointBuilderFactory.VelocityEndpointBuilder 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 VelocityEndpointBuilderFactory.VelocityEndpointBuilder 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

loaderCache

default VelocityEndpointBuilderFactory.VelocityEndpointBuilder loaderCache(boolean loaderCache)

Enables / disables the velocity resource loader cache which is enabled by default. The option is a: <code>boolean</code> type. Default: true Group: producer

Parameters:

loaderCache - the value to set

Returns:

the dsl builder

loaderCache

default VelocityEndpointBuilderFactory.VelocityEndpointBuilder loaderCache(String loaderCache)

Enables / disables the velocity resource loader cache which is enabled by default. The option will be converted to a <code>boolean</code> type. Default: true Group: producer

Parameters:

loaderCache - the value to set

Returns:

the dsl builder

propertiesFile

default VelocityEndpointBuilderFactory.VelocityEndpointBuilder propertiesFile(String propertiesFile)

The URI of the properties file which is used for VelocityEngine initialization. The option is a: <code>java.lang.String</code> type. Group: producer

Parameters:

propertiesFile - the value to set

Returns:

the dsl builder