org.apache.camel.builder.endpoint.dsl

Interface SparkEndpointBuilderFactory.SparkEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver

Enclosing interface:

SparkEndpointBuilderFactory

public static interface SparkEndpointBuilderFactory.SparkEndpointBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

Builder for endpoint for the Spark Rest component.

Method Summary

Modifier and Type	Method and Description
default SparkEndpointBuilderFactory.SparkEndpointBuilder	accept(String accept) Accept type such as: 'text/xml', or 'application/json'.
default SparkEndpointBuilderFactory.AdvancedSparkEndpointBuilder	advanced()
default SparkEndpointBuilderFactory.SparkEndpointBuilder	bridgeErrorHandler(boolean bridgeErrorHandler) Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.
default SparkEndpointBuilderFactory.SparkEndpointBuilder	bridgeErrorHandler(String bridgeErrorHandler) Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.
default SparkEndpointBuilderFactory.SparkEndpointBuilder	disableStreamCache(boolean disableStreamCache) Determines whether or not the raw input stream from Spark HttpRequest#getContent() is cached or not (Camel will read the stream into a in light-weight memory based Stream caching) cache.
default SparkEndpointBuilderFactory.SparkEndpointBuilder	disableStreamCache(String disableStreamCache) Determines whether or not the raw input stream from Spark HttpRequest#getContent() is cached or not (Camel will read the stream into a in light-weight memory based Stream caching) cache.
default SparkEndpointBuilderFactory.SparkEndpointBuilder	mapHeaders(boolean mapHeaders) If this option is enabled, then during binding from Spark to Camel Message then the headers will be mapped as well (eg added as header to the Camel Message as well).
default SparkEndpointBuilderFactory.SparkEndpointBuilder	mapHeaders(String mapHeaders) If this option is enabled, then during binding from Spark to Camel Message then the headers will be mapped as well (eg added as header to the Camel Message as well).
default SparkEndpointBuilderFactory.SparkEndpointBuilder	transferException(boolean transferException) If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type.
default SparkEndpointBuilderFactory.SparkEndpointBuilder	transferException(String transferException) If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type.
default SparkEndpointBuilderFactory.SparkEndpointBuilder	urlDecodeHeaders(boolean urlDecodeHeaders) If this option is enabled, then during binding from Spark to Camel Message then the header values will be URL decoded (eg %20 will be a space character.).
default SparkEndpointBuilderFactory.SparkEndpointBuilder	urlDecodeHeaders(String urlDecodeHeaders) If this option is enabled, then during binding from Spark to Camel Message then the header values will be URL decoded (eg %20 will be a space character.).

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

doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve

Method Detail

advanced

default SparkEndpointBuilderFactory.AdvancedSparkEndpointBuilder advanced()

accept

default SparkEndpointBuilderFactory.SparkEndpointBuilder accept(String accept)

Accept type such as: 'text/xml', or 'application/json'. By default we accept all kinds of types. The option is a: java.lang.String type. Group: consumer

bridgeErrorHandler

default SparkEndpointBuilderFactory.SparkEndpointBuilder bridgeErrorHandler(boolean bridgeErrorHandler)

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: boolean type. Default: false Group: consumer

bridgeErrorHandler

default SparkEndpointBuilderFactory.SparkEndpointBuilder bridgeErrorHandler(String bridgeErrorHandler)

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a boolean type. Default: false Group: consumer

disableStreamCache

default SparkEndpointBuilderFactory.SparkEndpointBuilder disableStreamCache(boolean disableStreamCache)

Determines whether or not the raw input stream from Spark HttpRequest#getContent() is cached or not (Camel will read the stream into a in light-weight memory based Stream caching) cache. By default Camel will cache the Netty input stream to support reading it multiple times to ensure Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. Mind that if you enable this option, then you cannot read the Netty stream multiple times out of the box, and you would need manually to reset the reader index on the Spark raw stream. The option is a: boolean type. Default: false Group: consumer

disableStreamCache

default SparkEndpointBuilderFactory.SparkEndpointBuilder disableStreamCache(String disableStreamCache)

Determines whether or not the raw input stream from Spark HttpRequest#getContent() is cached or not (Camel will read the stream into a in light-weight memory based Stream caching) cache. By default Camel will cache the Netty input stream to support reading it multiple times to ensure Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. Mind that if you enable this option, then you cannot read the Netty stream multiple times out of the box, and you would need manually to reset the reader index on the Spark raw stream. The option will be converted to a boolean type. Default: false Group: consumer

mapHeaders

default SparkEndpointBuilderFactory.SparkEndpointBuilder mapHeaders(boolean mapHeaders)

If this option is enabled, then during binding from Spark to Camel Message then the headers will be mapped as well (eg added as header to the Camel Message as well). You can turn off this option to disable this. The headers can still be accessed from the org.apache.camel.component.sparkrest.SparkMessage message with the method getRequest() that returns the Spark HTTP request instance. The option is a: boolean type. Default: true Group: consumer

mapHeaders

default SparkEndpointBuilderFactory.SparkEndpointBuilder mapHeaders(String mapHeaders)

If this option is enabled, then during binding from Spark to Camel Message then the headers will be mapped as well (eg added as header to the Camel Message as well). You can turn off this option to disable this. The headers can still be accessed from the org.apache.camel.component.sparkrest.SparkMessage message with the method getRequest() that returns the Spark HTTP request instance. The option will be converted to a boolean type. Default: true Group: consumer

transferException

default SparkEndpointBuilderFactory.SparkEndpointBuilder transferException(boolean transferException)

If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. The option is a: boolean type. Default: false Group: consumer

transferException

default SparkEndpointBuilderFactory.SparkEndpointBuilder transferException(String transferException)

If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. The option will be converted to a boolean type. Default: false Group: consumer

urlDecodeHeaders

default SparkEndpointBuilderFactory.SparkEndpointBuilder urlDecodeHeaders(boolean urlDecodeHeaders)

If this option is enabled, then during binding from Spark to Camel Message then the header values will be URL decoded (eg %20 will be a space character.). The option is a: boolean type. Default: false Group: consumer

urlDecodeHeaders

default SparkEndpointBuilderFactory.SparkEndpointBuilder urlDecodeHeaders(String urlDecodeHeaders)

If this option is enabled, then during binding from Spark to Camel Message then the header values will be URL decoded (eg %20 will be a space character.). The option will be converted to a boolean type. Default: false Group: consumer