org.apache.camel.builder.endpoint.dsl

Interface JoltEndpointBuilderFactory.JoltEndpointBuilder

All Superinterfaces:

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

Enclosing interface:

JoltEndpointBuilderFactory

public static interface JoltEndpointBuilderFactory.JoltEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint for the JOLT component.

Method Summary

Modifier and Type	Method and Description
default JoltEndpointBuilderFactory.AdvancedJoltEndpointBuilder	advanced()
default JoltEndpointBuilderFactory.JoltEndpointBuilder	allowContextMapAll(boolean allowContextMapAll) Sets whether the context map should allow access to all details.
default JoltEndpointBuilderFactory.JoltEndpointBuilder	allowContextMapAll(String allowContextMapAll) Sets whether the context map should allow access to all details.
default JoltEndpointBuilderFactory.JoltEndpointBuilder	allowTemplateFromHeader(boolean allowTemplateFromHeader) Whether to allow to use resource template from header or not (default false).
default JoltEndpointBuilderFactory.JoltEndpointBuilder	allowTemplateFromHeader(String allowTemplateFromHeader) Whether to allow to use resource template from header or not (default false).
default JoltEndpointBuilderFactory.JoltEndpointBuilder	contentCache(boolean contentCache) Sets whether to use resource content cache or not.
default JoltEndpointBuilderFactory.JoltEndpointBuilder	contentCache(String contentCache) Sets whether to use resource content cache or not.
default JoltEndpointBuilderFactory.JoltEndpointBuilder	inputType(JoltEndpointBuilderFactory.JoltInputOutputType inputType) Specifies if the input is hydrated JSON or a JSON String.
default JoltEndpointBuilderFactory.JoltEndpointBuilder	inputType(String inputType) Specifies if the input is hydrated JSON or a JSON String.
default JoltEndpointBuilderFactory.JoltEndpointBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default JoltEndpointBuilderFactory.JoltEndpointBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default JoltEndpointBuilderFactory.JoltEndpointBuilder	outputType(JoltEndpointBuilderFactory.JoltInputOutputType outputType) Specifies if the output should be hydrated JSON or a JSON String.
default JoltEndpointBuilderFactory.JoltEndpointBuilder	outputType(String outputType) Specifies if the output should be hydrated JSON or a JSON String.
default JoltEndpointBuilderFactory.JoltEndpointBuilder	transformDsl(JoltEndpointBuilderFactory.JoltTransformType transformDsl) Specifies the Transform DSL of the endpoint resource.
default JoltEndpointBuilderFactory.JoltEndpointBuilder	transformDsl(String transformDsl) Specifies the Transform DSL of the endpoint resource.

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 JoltEndpointBuilderFactory.AdvancedJoltEndpointBuilder advanced()

allowContextMapAll

default JoltEndpointBuilderFactory.JoltEndpointBuilder 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 JoltEndpointBuilderFactory.JoltEndpointBuilder 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 JoltEndpointBuilderFactory.JoltEndpointBuilder 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 JoltEndpointBuilderFactory.JoltEndpointBuilder 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 JoltEndpointBuilderFactory.JoltEndpointBuilder 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 JoltEndpointBuilderFactory.JoltEndpointBuilder 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

inputType

default JoltEndpointBuilderFactory.JoltEndpointBuilder inputType(JoltEndpointBuilderFactory.JoltInputOutputType inputType)

Specifies if the input is hydrated JSON or a JSON String. The option is a: <code>org.apache.camel.component.jolt.JoltInputOutputType</code> type. Default: Hydrated Group: producer

Parameters:

inputType - the value to set

Returns:

the dsl builder

inputType

default JoltEndpointBuilderFactory.JoltEndpointBuilder inputType(String inputType)

Specifies if the input is hydrated JSON or a JSON String. The option will be converted to a <code>org.apache.camel.component.jolt.JoltInputOutputType</code> type. Default: Hydrated Group: producer

Parameters:

inputType - the value to set

Returns:

the dsl builder

lazyStartProducer

default JoltEndpointBuilderFactory.JoltEndpointBuilder 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 JoltEndpointBuilderFactory.JoltEndpointBuilder 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

outputType

default JoltEndpointBuilderFactory.JoltEndpointBuilder outputType(JoltEndpointBuilderFactory.JoltInputOutputType outputType)

Specifies if the output should be hydrated JSON or a JSON String. The option is a: <code>org.apache.camel.component.jolt.JoltInputOutputType</code> type. Default: Hydrated Group: producer

Parameters:

outputType - the value to set

Returns:

the dsl builder

outputType

default JoltEndpointBuilderFactory.JoltEndpointBuilder outputType(String outputType)

Specifies if the output should be hydrated JSON or a JSON String. The option will be converted to a <code>org.apache.camel.component.jolt.JoltInputOutputType</code> type. Default: Hydrated Group: producer

Parameters:

outputType - the value to set

Returns:

the dsl builder

transformDsl

default JoltEndpointBuilderFactory.JoltEndpointBuilder transformDsl(JoltEndpointBuilderFactory.JoltTransformType transformDsl)

Specifies the Transform DSL of the endpoint resource. If none is specified Chainr will be used. The option is a: <code>org.apache.camel.component.jolt.JoltTransformType</code> type. Default: Chainr Group: producer

Parameters:

transformDsl - the value to set

Returns:

the dsl builder

transformDsl

default JoltEndpointBuilderFactory.JoltEndpointBuilder transformDsl(String transformDsl)

Specifies the Transform DSL of the endpoint resource. If none is specified Chainr will be used. The option will be converted to a <code>org.apache.camel.component.jolt.JoltTransformType</code> type. Default: Chainr Group: producer

Parameters:

transformDsl - the value to set

Returns:

the dsl builder