org.apache.camel.builder.endpoint.dsl

Interface AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder

All Superinterfaces:

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

All Known Subinterfaces:

AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointBuilder

Enclosing interface:

AtmosphereWebsocketEndpointBuilderFactory

public static interface AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

Advanced builder for endpoint consumers for the Atmosphere Websocket component.

Method Summary

Modifier and Type	Method and Description
default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder	attachmentMultipartBinding(boolean attachmentMultipartBinding) Whether to automatic bind multipart/form-data as attachments on the Camel Exchange.
default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder	attachmentMultipartBinding(String attachmentMultipartBinding) Whether to automatic bind multipart/form-data as attachments on the Camel Exchange.
default AtmosphereWebsocketEndpointBuilderFactory.AtmosphereWebsocketEndpointConsumerBuilder	basic()
default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder	eagerCheckContentAvailable(boolean eagerCheckContentAvailable) Whether to eager check whether the HTTP requests has content if the content-length header is 0 or not present.
default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder	eagerCheckContentAvailable(String eagerCheckContentAvailable) Whether to eager check whether the HTTP requests has content if the content-length header is 0 or not present.
default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder	exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler) To let the consumer use a custom ExceptionHandler.
default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder	exceptionHandler(String exceptionHandler) To let the consumer use a custom ExceptionHandler.
default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder	exchangePattern(org.apache.camel.ExchangePattern exchangePattern) Sets the exchange pattern when the consumer creates an exchange.
default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder	exchangePattern(String exchangePattern) Sets the exchange pattern when the consumer creates an exchange.
default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder	fileNameExtWhitelist(String fileNameExtWhitelist) Whitelist of accepted filename extensions for accepting uploaded files.
default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder	httpBinding(Object httpBinding) To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder	httpBinding(String httpBinding) To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder	mapHttpMessageBody(boolean mapHttpMessageBody) If this option is true then IN exchange Body of the exchange will be mapped to HTTP body.
default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder	mapHttpMessageBody(String mapHttpMessageBody) If this option is true then IN exchange Body of the exchange will be mapped to HTTP body.
default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder	mapHttpMessageFormUrlEncodedBody(boolean mapHttpMessageFormUrlEncodedBody) If this option is true then IN exchange Form Encoded body of the exchange will be mapped to HTTP.
default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder	mapHttpMessageFormUrlEncodedBody(String mapHttpMessageFormUrlEncodedBody) If this option is true then IN exchange Form Encoded body of the exchange will be mapped to HTTP.
default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder	mapHttpMessageHeaders(boolean mapHttpMessageHeaders) If this option is true then IN exchange Headers of the exchange will be mapped to HTTP headers.
default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder	mapHttpMessageHeaders(String mapHttpMessageHeaders) If this option is true then IN exchange Headers of the exchange will be mapped to HTTP headers.
default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder	optionsEnabled(boolean optionsEnabled) Specifies whether to enable HTTP OPTIONS for this Servlet consumer.
default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder	optionsEnabled(String optionsEnabled) Specifies whether to enable HTTP OPTIONS for this Servlet consumer.
default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder	traceEnabled(boolean traceEnabled) Specifies whether to enable HTTP TRACE for this Servlet consumer.
default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder	traceEnabled(String traceEnabled) Specifies whether to enable HTTP TRACE for this Servlet consumer.

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Method Detail

basic

default AtmosphereWebsocketEndpointBuilderFactory.AtmosphereWebsocketEndpointConsumerBuilder basic()

httpBinding

default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder httpBinding(Object httpBinding)

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

Parameters:

httpBinding - the value to set

Returns:

the dsl builder

httpBinding

default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder httpBinding(String httpBinding)

To use a custom HttpBinding to control the mapping between Camel message and HttpClient. The option will be converted to a <code>org.apache.camel.http.common.HttpBinding</code> type. Group: common (advanced)

Parameters:

httpBinding - the value to set

Returns:

the dsl builder

attachmentMultipartBinding

default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder 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: <code>boolean</code> type. Default: false Group: consumer (advanced)

Parameters:

attachmentMultipartBinding - the value to set

Returns:

the dsl builder

attachmentMultipartBinding

default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder attachmentMultipartBinding(String 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 will be converted to a <code>boolean</code> type. Default: false Group: consumer (advanced)

Parameters:

attachmentMultipartBinding - the value to set

Returns:

the dsl builder

eagerCheckContentAvailable

default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder eagerCheckContentAvailable(boolean eagerCheckContentAvailable)

Whether to eager check whether the HTTP requests has content if the content-length header is 0 or not present. This can be turned on in case HTTP clients do not send streamed data. The option is a: <code>boolean</code> type. Default: false Group: consumer (advanced)

Parameters:

eagerCheckContentAvailable - the value to set

Returns:

the dsl builder

eagerCheckContentAvailable

default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder eagerCheckContentAvailable(String eagerCheckContentAvailable)

Whether to eager check whether the HTTP requests has content if the content-length header is 0 or not present. This can be turned on in case HTTP clients do not send streamed data. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer (advanced)

Parameters:

eagerCheckContentAvailable - the value to set

Returns:

the dsl builder

exceptionHandler

default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler)

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)

Parameters:

exceptionHandler - the value to set

Returns:

the dsl builder

exceptionHandler

default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder exceptionHandler(String exceptionHandler)

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)

Parameters:

exceptionHandler - the value to set

Returns:

the dsl builder

exchangePattern

default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder exchangePattern(org.apache.camel.ExchangePattern exchangePattern)

Sets the exchange pattern when the consumer creates an exchange. The option is a: <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)

Parameters:

exchangePattern - the value to set

Returns:

the dsl builder

exchangePattern

default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder exchangePattern(String exchangePattern)

Sets the exchange pattern when the consumer creates an exchange. The option will be converted to a <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)

Parameters:

exchangePattern - the value to set

Returns:

the dsl builder

fileNameExtWhitelist

default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder 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: <code>java.lang.String</code> type. Group: consumer (advanced)

Parameters:

fileNameExtWhitelist - the value to set

Returns:

the dsl builder

mapHttpMessageBody

default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder mapHttpMessageBody(boolean mapHttpMessageBody)

If this option is true then IN exchange Body of the exchange will be mapped to HTTP body. Setting this to false will avoid the HTTP mapping. The option is a: <code>boolean</code> type. Default: true Group: consumer (advanced)

Parameters:

mapHttpMessageBody - the value to set

Returns:

the dsl builder

mapHttpMessageBody

default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder mapHttpMessageBody(String mapHttpMessageBody)

If this option is true then IN exchange Body of the exchange will be mapped to HTTP body. Setting this to false will avoid the HTTP mapping. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer (advanced)

Parameters:

mapHttpMessageBody - the value to set

Returns:

the dsl builder

mapHttpMessageFormUrlEncodedBody

default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder mapHttpMessageFormUrlEncodedBody(boolean mapHttpMessageFormUrlEncodedBody)

If this option is true then IN exchange Form Encoded body of the exchange will be mapped to HTTP. Setting this to false will avoid the HTTP Form Encoded body mapping. The option is a: <code>boolean</code> type. Default: true Group: consumer (advanced)

Parameters:

mapHttpMessageFormUrlEncodedBody - the value to set

Returns:

the dsl builder

mapHttpMessageFormUrlEncodedBody

default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder mapHttpMessageFormUrlEncodedBody(String mapHttpMessageFormUrlEncodedBody)

If this option is true then IN exchange Form Encoded body of the exchange will be mapped to HTTP. Setting this to false will avoid the HTTP Form Encoded body mapping. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer (advanced)

Parameters:

mapHttpMessageFormUrlEncodedBody - the value to set

Returns:

the dsl builder

mapHttpMessageHeaders

default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder mapHttpMessageHeaders(boolean mapHttpMessageHeaders)

If this option is true then IN exchange Headers of the exchange will be mapped to HTTP headers. Setting this to false will avoid the HTTP Headers mapping. The option is a: <code>boolean</code> type. Default: true Group: consumer (advanced)

Parameters:

mapHttpMessageHeaders - the value to set

Returns:

the dsl builder

mapHttpMessageHeaders

default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder mapHttpMessageHeaders(String mapHttpMessageHeaders)

If this option is true then IN exchange Headers of the exchange will be mapped to HTTP headers. Setting this to false will avoid the HTTP Headers mapping. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer (advanced)

Parameters:

mapHttpMessageHeaders - the value to set

Returns:

the dsl builder

optionsEnabled

default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder optionsEnabled(boolean optionsEnabled)

Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off. The option is a: <code>boolean</code> type. Default: false Group: consumer (advanced)

Parameters:

optionsEnabled - the value to set

Returns:

the dsl builder

optionsEnabled

default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder optionsEnabled(String optionsEnabled)

Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer (advanced)

Parameters:

optionsEnabled - the value to set

Returns:

the dsl builder

traceEnabled

default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder traceEnabled(boolean traceEnabled)

Specifies whether to enable HTTP TRACE for this Servlet consumer. By default TRACE is turned off. The option is a: <code>boolean</code> type. Default: false Group: consumer (advanced)

Parameters:

traceEnabled - the value to set

Returns:

the dsl builder

traceEnabled

default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointConsumerBuilder traceEnabled(String traceEnabled)

Specifies whether to enable HTTP TRACE for this Servlet consumer. By default TRACE is turned off. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer (advanced)

Parameters:

traceEnabled - the value to set

Returns:

the dsl builder