org.apache.camel.builder.endpoint.dsl

Interface AtlasMapEndpointBuilderFactory.AtlasMapEndpointBuilder

All Superinterfaces:

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

Enclosing interface:

AtlasMapEndpointBuilderFactory

public static interface AtlasMapEndpointBuilderFactory.AtlasMapEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint for the AtlasMap component.

Method Summary

Modifier and Type	Method and Description
default AtlasMapEndpointBuilderFactory.AdvancedAtlasMapEndpointBuilder	advanced()
default AtlasMapEndpointBuilderFactory.AtlasMapEndpointBuilder	allowContextMapAll(boolean allowContextMapAll) Sets whether the context map should allow access to all details.
default AtlasMapEndpointBuilderFactory.AtlasMapEndpointBuilder	allowContextMapAll(String allowContextMapAll) Sets whether the context map should allow access to all details.
default AtlasMapEndpointBuilderFactory.AtlasMapEndpointBuilder	contentCache(boolean contentCache) Sets whether to use resource content cache or not.
default AtlasMapEndpointBuilderFactory.AtlasMapEndpointBuilder	contentCache(String contentCache) Sets whether to use resource content cache or not.
default AtlasMapEndpointBuilderFactory.AtlasMapEndpointBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default AtlasMapEndpointBuilderFactory.AtlasMapEndpointBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default AtlasMapEndpointBuilderFactory.AtlasMapEndpointBuilder	sourceMapName(String sourceMapName) The Exchange property name for a source message map which hold java.util.Map<String, Message> where the key is AtlasMap Document ID.
default AtlasMapEndpointBuilderFactory.AtlasMapEndpointBuilder	targetMapMode(AtlasMapEndpointBuilderFactory.TargetMapMode targetMapMode) TargetMapMode enum value to specify how multiple target documents are delivered if exist.
default AtlasMapEndpointBuilderFactory.AtlasMapEndpointBuilder	targetMapMode(String targetMapMode) TargetMapMode enum value to specify how multiple target documents are delivered if exist.
default AtlasMapEndpointBuilderFactory.AtlasMapEndpointBuilder	targetMapName(String targetMapName) The Exchange property name for a target document map which hold java.util.Map<String, Object> where the key is AtlasMap Document ID.

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 AtlasMapEndpointBuilderFactory.AdvancedAtlasMapEndpointBuilder advanced()

allowContextMapAll

default AtlasMapEndpointBuilderFactory.AtlasMapEndpointBuilder 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 AtlasMapEndpointBuilderFactory.AtlasMapEndpointBuilder 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

contentCache

default AtlasMapEndpointBuilderFactory.AtlasMapEndpointBuilder 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 AtlasMapEndpointBuilderFactory.AtlasMapEndpointBuilder 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

lazyStartProducer

default AtlasMapEndpointBuilderFactory.AtlasMapEndpointBuilder 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 AtlasMapEndpointBuilderFactory.AtlasMapEndpointBuilder 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

sourceMapName

default AtlasMapEndpointBuilderFactory.AtlasMapEndpointBuilder sourceMapName(String sourceMapName)

The Exchange property name for a source message map which hold java.util.Map&amp;lt;String, Message&amp;gt; where the key is AtlasMap Document ID. AtlasMap consumes Message bodies as source documents, as well as message headers as source properties where the scope equals to Document ID. The option is a: <code>java.lang.String</code> type. Group: producer

Parameters:

sourceMapName - the value to set

Returns:

the dsl builder

targetMapMode

default AtlasMapEndpointBuilderFactory.AtlasMapEndpointBuilder targetMapMode(AtlasMapEndpointBuilderFactory.TargetMapMode targetMapMode)

TargetMapMode enum value to specify how multiple target documents are delivered if exist. 'MAP': Stores them into a java.util.Map, and the java.util.Map is set to an exchange property if 'targetMapName' is specified, otherwise message body. 'MESSAGE_HEADER': Stores them into message headers. 'EXCHANGE_PROPERTY': Stores them into exchange properties. ). The option is a: <code>org.apache.camel.component.atlasmap.AtlasMapEndpoint$TargetMapMode</code> type. Default: MAP Group: producer

Parameters:

targetMapMode - the value to set

Returns:

the dsl builder

targetMapMode

default AtlasMapEndpointBuilderFactory.AtlasMapEndpointBuilder targetMapMode(String targetMapMode)

TargetMapMode enum value to specify how multiple target documents are delivered if exist. 'MAP': Stores them into a java.util.Map, and the java.util.Map is set to an exchange property if 'targetMapName' is specified, otherwise message body. 'MESSAGE_HEADER': Stores them into message headers. 'EXCHANGE_PROPERTY': Stores them into exchange properties. ). The option will be converted to a <code>org.apache.camel.component.atlasmap.AtlasMapEndpoint$TargetMapMode</code> type. Default: MAP Group: producer

Parameters:

targetMapMode - the value to set

Returns:

the dsl builder

targetMapName

default AtlasMapEndpointBuilderFactory.AtlasMapEndpointBuilder targetMapName(String targetMapName)

The Exchange property name for a target document map which hold java.util.Map&amp;lt;String, Object&amp;gt; where the key is AtlasMap Document ID. AtlasMap populates multiple target documents into this map. The option is a: <code>java.lang.String</code> type. Group: producer

Parameters:

targetMapName - the value to set

Returns:

the dsl builder