org.apache.camel.builder.endpoint.dsl

Interface FreemarkerEndpointBuilderFactory.FreemarkerEndpointBuilder

All Superinterfaces:

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

Enclosing interface:

FreemarkerEndpointBuilderFactory

public static interface FreemarkerEndpointBuilderFactory.FreemarkerEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint for the Freemarker component.

Method Summary

Modifier and Type	Method and Description
default FreemarkerEndpointBuilderFactory.AdvancedFreemarkerEndpointBuilder	advanced()
default FreemarkerEndpointBuilderFactory.FreemarkerEndpointBuilder	allowContextMapAll(boolean allowContextMapAll) Sets whether the context map should allow access to all details.
default FreemarkerEndpointBuilderFactory.FreemarkerEndpointBuilder	allowContextMapAll(String allowContextMapAll) Sets whether the context map should allow access to all details.
default FreemarkerEndpointBuilderFactory.FreemarkerEndpointBuilder	allowTemplateFromHeader(boolean allowTemplateFromHeader) Whether to allow to use resource template from header or not (default false).
default FreemarkerEndpointBuilderFactory.FreemarkerEndpointBuilder	allowTemplateFromHeader(String allowTemplateFromHeader) Whether to allow to use resource template from header or not (default false).
default FreemarkerEndpointBuilderFactory.FreemarkerEndpointBuilder	configuration(Object configuration) Sets the Freemarker configuration to use.
default FreemarkerEndpointBuilderFactory.FreemarkerEndpointBuilder	configuration(String configuration) Sets the Freemarker configuration to use.
default FreemarkerEndpointBuilderFactory.FreemarkerEndpointBuilder	contentCache(boolean contentCache) Sets whether to use resource content cache or not.
default FreemarkerEndpointBuilderFactory.FreemarkerEndpointBuilder	contentCache(String contentCache) Sets whether to use resource content cache or not.
default FreemarkerEndpointBuilderFactory.FreemarkerEndpointBuilder	encoding(String encoding) Sets the encoding to be used for loading the template file.
default FreemarkerEndpointBuilderFactory.FreemarkerEndpointBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default FreemarkerEndpointBuilderFactory.FreemarkerEndpointBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default FreemarkerEndpointBuilderFactory.FreemarkerEndpointBuilder	templateUpdateDelay(int templateUpdateDelay) Number of seconds the loaded template resource will remain in the cache.
default FreemarkerEndpointBuilderFactory.FreemarkerEndpointBuilder	templateUpdateDelay(String templateUpdateDelay) Number of seconds the loaded template resource will remain in the cache.

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 FreemarkerEndpointBuilderFactory.AdvancedFreemarkerEndpointBuilder advanced()

allowContextMapAll

default FreemarkerEndpointBuilderFactory.FreemarkerEndpointBuilder 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 FreemarkerEndpointBuilderFactory.FreemarkerEndpointBuilder 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 FreemarkerEndpointBuilderFactory.FreemarkerEndpointBuilder 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 FreemarkerEndpointBuilderFactory.FreemarkerEndpointBuilder 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

configuration

default FreemarkerEndpointBuilderFactory.FreemarkerEndpointBuilder configuration(Object configuration)

Sets the Freemarker configuration to use. The option is a: <code>freemarker.template.Configuration</code> type. Group: producer

Parameters:

configuration - the value to set

Returns:

the dsl builder

configuration

default FreemarkerEndpointBuilderFactory.FreemarkerEndpointBuilder configuration(String configuration)

Sets the Freemarker configuration to use. The option will be converted to a <code>freemarker.template.Configuration</code> type. Group: producer

Parameters:

configuration - the value to set

Returns:

the dsl builder

contentCache

default FreemarkerEndpointBuilderFactory.FreemarkerEndpointBuilder 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 FreemarkerEndpointBuilderFactory.FreemarkerEndpointBuilder 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 FreemarkerEndpointBuilderFactory.FreemarkerEndpointBuilder encoding(String encoding)

Sets the encoding to be used for loading the template file. The option is a: <code>java.lang.String</code> type. Group: producer

Parameters:

encoding - the value to set

Returns:

the dsl builder

lazyStartProducer

default FreemarkerEndpointBuilderFactory.FreemarkerEndpointBuilder 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 FreemarkerEndpointBuilderFactory.FreemarkerEndpointBuilder 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

templateUpdateDelay

default FreemarkerEndpointBuilderFactory.FreemarkerEndpointBuilder templateUpdateDelay(int templateUpdateDelay)

Number of seconds the loaded template resource will remain in the cache. The option is a: <code>int</code> type. Group: producer

Parameters:

templateUpdateDelay - the value to set

Returns:

the dsl builder

templateUpdateDelay

default FreemarkerEndpointBuilderFactory.FreemarkerEndpointBuilder templateUpdateDelay(String templateUpdateDelay)

Number of seconds the loaded template resource will remain in the cache. The option will be converted to a <code>int</code> type. Group: producer

Parameters:

templateUpdateDelay - the value to set

Returns:

the dsl builder