org.apache.camel.builder.component.dsl

Interface AtmosphereWebsocketComponentBuilderFactory.AtmosphereWebsocketComponentBuilder

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.atmosphere.websocket.WebsocketComponent>

All Known Implementing Classes:

AtmosphereWebsocketComponentBuilderFactory.AtmosphereWebsocketComponentBuilderImpl

Enclosing interface:

AtmosphereWebsocketComponentBuilderFactory

public static interface AtmosphereWebsocketComponentBuilderFactory.AtmosphereWebsocketComponentBuilder
extends ComponentBuilder<org.apache.camel.component.atmosphere.websocket.WebsocketComponent>

Builder for the Atmosphere Websocket component.

Method Summary

Modifier and Type	Method and Description
default AtmosphereWebsocketComponentBuilderFactory.AtmosphereWebsocketComponentBuilder	allowJavaSerializedObject(boolean allowJavaSerializedObject) Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object.
default AtmosphereWebsocketComponentBuilderFactory.AtmosphereWebsocketComponentBuilder	attachmentMultipartBinding(boolean attachmentMultipartBinding) Whether to automatic bind multipart/form-data as attachments on the Camel Exchange.
default AtmosphereWebsocketComponentBuilderFactory.AtmosphereWebsocketComponentBuilder	basicPropertyBinding(boolean basicPropertyBinding) Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities.
default AtmosphereWebsocketComponentBuilderFactory.AtmosphereWebsocketComponentBuilder	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 AtmosphereWebsocketComponentBuilderFactory.AtmosphereWebsocketComponentBuilder	fileNameExtWhitelist(String fileNameExtWhitelist) Whitelist of accepted filename extensions for accepting uploaded files.
default AtmosphereWebsocketComponentBuilderFactory.AtmosphereWebsocketComponentBuilder	headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy) To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
default AtmosphereWebsocketComponentBuilderFactory.AtmosphereWebsocketComponentBuilder	httpBinding(org.apache.camel.http.common.HttpBinding httpBinding) To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
default AtmosphereWebsocketComponentBuilderFactory.AtmosphereWebsocketComponentBuilder	httpConfiguration(org.apache.camel.http.common.HttpConfiguration httpConfiguration) To use the shared HttpConfiguration as base configuration.
default AtmosphereWebsocketComponentBuilderFactory.AtmosphereWebsocketComponentBuilder	httpRegistry(org.apache.camel.component.servlet.HttpRegistry httpRegistry) To use a custom org.apache.camel.component.servlet.HttpRegistry.
default AtmosphereWebsocketComponentBuilderFactory.AtmosphereWebsocketComponentBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default AtmosphereWebsocketComponentBuilderFactory.AtmosphereWebsocketComponentBuilder	servletName(String servletName) Default name of servlet to use.

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

build, build, doSetProperty, register

Method Detail

bridgeErrorHandler

default AtmosphereWebsocketComponentBuilderFactory.AtmosphereWebsocketComponentBuilder 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

servletName

default AtmosphereWebsocketComponentBuilderFactory.AtmosphereWebsocketComponentBuilder servletName(String servletName)

Default name of servlet to use. The default name is CamelServlet. The option is a: java.lang.String type. Default: CamelServlet Group: consumer

attachmentMultipartBinding

default AtmosphereWebsocketComponentBuilderFactory.AtmosphereWebsocketComponentBuilder attachmentMultipartBinding(boolean attachmentMultipartBinding)

Whether to automatic bind multipart/form-data as attachments on the Camel Exchange. The options attachmentMultipartBinding=true and disableStreamCache=false cannot work together. Remove disableStreamCache to use AttachmentMultipartBinding. This is turn off by default as this may require servlet specific configuration to enable this when using Servlet's. The option is a: boolean type. Default: false Group: consumer (advanced)

fileNameExtWhitelist

default AtmosphereWebsocketComponentBuilderFactory.AtmosphereWebsocketComponentBuilder fileNameExtWhitelist(String fileNameExtWhitelist)

Whitelist of accepted filename extensions for accepting uploaded files. Multiple extensions can be separated by comma, such as txt,xml. The option is a: java.lang.String type. Group: consumer (advanced)

httpRegistry

default AtmosphereWebsocketComponentBuilderFactory.AtmosphereWebsocketComponentBuilder httpRegistry(org.apache.camel.component.servlet.HttpRegistry httpRegistry)

To use a custom org.apache.camel.component.servlet.HttpRegistry. The option is a: org.apache.camel.component.servlet.HttpRegistry type. Group: consumer (advanced)

lazyStartProducer

default AtmosphereWebsocketComponentBuilderFactory.AtmosphereWebsocketComponentBuilder 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: boolean type. Default: false Group: producer

allowJavaSerializedObject

default AtmosphereWebsocketComponentBuilderFactory.AtmosphereWebsocketComponentBuilder allowJavaSerializedObject(boolean allowJavaSerializedObject)

Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object. 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: advanced

basicPropertyBinding

default AtmosphereWebsocketComponentBuilderFactory.AtmosphereWebsocketComponentBuilder basicPropertyBinding(boolean basicPropertyBinding)

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities. The option is a: boolean type. Default: false Group: advanced

httpBinding

default AtmosphereWebsocketComponentBuilderFactory.AtmosphereWebsocketComponentBuilder httpBinding(org.apache.camel.http.common.HttpBinding httpBinding)

To use a custom HttpBinding to control the mapping between Camel message and HttpClient. The option is a: org.apache.camel.http.common.HttpBinding type. Group: advanced

httpConfiguration

default AtmosphereWebsocketComponentBuilderFactory.AtmosphereWebsocketComponentBuilder httpConfiguration(org.apache.camel.http.common.HttpConfiguration httpConfiguration)

To use the shared HttpConfiguration as base configuration. The option is a: org.apache.camel.http.common.HttpConfiguration type. Group: advanced

headerFilterStrategy

default AtmosphereWebsocketComponentBuilderFactory.AtmosphereWebsocketComponentBuilder headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)

To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. The option is a: org.apache.camel.spi.HeaderFilterStrategy type. Group: filter