org.apache.camel.builder.endpoint.dsl

Interface WsEndpointBuilderFactory.WsEndpointConsumerBuilder

All Superinterfaces:

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

All Known Subinterfaces:

WsEndpointBuilderFactory.WsEndpointBuilder

Enclosing interface:

WsEndpointBuilderFactory

public static interface WsEndpointBuilderFactory.WsEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

Builder for endpoint consumers for the Async HTTP Client (AHC) Websocket component.

Method Summary

Modifier and Type	Method and Description
default WsEndpointBuilderFactory.AdvancedWsEndpointConsumerBuilder	advanced()
default WsEndpointBuilderFactory.WsEndpointConsumerBuilder	bridgeEndpoint(boolean bridgeEndpoint) If the option is true, then the Exchange.HTTP_URI header is ignored, and use the endpoint's URI for request.
default WsEndpointBuilderFactory.WsEndpointConsumerBuilder	bridgeEndpoint(String bridgeEndpoint) If the option is true, then the Exchange.HTTP_URI header is ignored, and use the endpoint's URI for request.
default WsEndpointBuilderFactory.WsEndpointConsumerBuilder	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 WsEndpointBuilderFactory.WsEndpointConsumerBuilder	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 WsEndpointBuilderFactory.WsEndpointConsumerBuilder	bufferSize(int bufferSize) The initial in-memory buffer size used when transferring data between Camel and AHC Client.
default WsEndpointBuilderFactory.WsEndpointConsumerBuilder	bufferSize(String bufferSize) The initial in-memory buffer size used when transferring data between Camel and AHC Client.
default WsEndpointBuilderFactory.WsEndpointConsumerBuilder	headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy) To use a custom HeaderFilterStrategy to filter header to and from Camel message.
default WsEndpointBuilderFactory.WsEndpointConsumerBuilder	headerFilterStrategy(String headerFilterStrategy) To use a custom HeaderFilterStrategy to filter header to and from Camel message.
default WsEndpointBuilderFactory.WsEndpointConsumerBuilder	sendMessageOnError(boolean sendMessageOnError) Whether to send an message if the web-socket listener received an error.
default WsEndpointBuilderFactory.WsEndpointConsumerBuilder	sendMessageOnError(String sendMessageOnError) Whether to send an message if the web-socket listener received an error.
default WsEndpointBuilderFactory.WsEndpointConsumerBuilder	sslContextParameters(Object sslContextParameters) Reference to a org.apache.camel.support.jsse.SSLContextParameters in the Registry.
default WsEndpointBuilderFactory.WsEndpointConsumerBuilder	sslContextParameters(String sslContextParameters) Reference to a org.apache.camel.support.jsse.SSLContextParameters in the Registry.
default WsEndpointBuilderFactory.WsEndpointConsumerBuilder	throwExceptionOnFailure(boolean throwExceptionOnFailure) Option to disable throwing the AhcOperationFailedException in case of failed responses from the remote server.
default WsEndpointBuilderFactory.WsEndpointConsumerBuilder	throwExceptionOnFailure(String throwExceptionOnFailure) Option to disable throwing the AhcOperationFailedException in case of failed responses from the remote server.
default WsEndpointBuilderFactory.WsEndpointConsumerBuilder	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 (for example using Jetty or Servlet Camel components).
default WsEndpointBuilderFactory.WsEndpointConsumerBuilder	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 (for example using Jetty or Servlet Camel components).

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Method Detail

advanced

default WsEndpointBuilderFactory.AdvancedWsEndpointConsumerBuilder advanced()

bridgeEndpoint

default WsEndpointBuilderFactory.WsEndpointConsumerBuilder bridgeEndpoint(boolean bridgeEndpoint)

If the option is true, then the Exchange.HTTP_URI header is ignored, and use the endpoint's URI for request. You may also set the throwExceptionOnFailure to be false to let the AhcProducer send all the fault response back. The option is a: boolean type. Default: false Group: common

bridgeEndpoint

default WsEndpointBuilderFactory.WsEndpointConsumerBuilder bridgeEndpoint(String bridgeEndpoint)

If the option is true, then the Exchange.HTTP_URI header is ignored, and use the endpoint's URI for request. You may also set the throwExceptionOnFailure to be false to let the AhcProducer send all the fault response back. The option will be converted to a boolean type. Default: false Group: common

bufferSize

default WsEndpointBuilderFactory.WsEndpointConsumerBuilder bufferSize(int bufferSize)

The initial in-memory buffer size used when transferring data between Camel and AHC Client. The option is a: int type. Default: 4096 Group: common

bufferSize

default WsEndpointBuilderFactory.WsEndpointConsumerBuilder bufferSize(String bufferSize)

The initial in-memory buffer size used when transferring data between Camel and AHC Client. The option will be converted to a int type. Default: 4096 Group: common

headerFilterStrategy

default WsEndpointBuilderFactory.WsEndpointConsumerBuilder headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)

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

headerFilterStrategy

default WsEndpointBuilderFactory.WsEndpointConsumerBuilder headerFilterStrategy(String headerFilterStrategy)

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

throwExceptionOnFailure

default WsEndpointBuilderFactory.WsEndpointConsumerBuilder throwExceptionOnFailure(boolean throwExceptionOnFailure)

Option to disable throwing the AhcOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code. The option is a: boolean type. Default: true Group: common

throwExceptionOnFailure

default WsEndpointBuilderFactory.WsEndpointConsumerBuilder throwExceptionOnFailure(String throwExceptionOnFailure)

Option to disable throwing the AhcOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code. The option will be converted to a boolean type. Default: true Group: common

transferException

default WsEndpointBuilderFactory.WsEndpointConsumerBuilder 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 (for example using Jetty or Servlet Camel components). On the producer side the exception will be deserialized and thrown as is, instead of the AhcOperationFailedException. The caused exception is required to be serialized. 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: common

transferException

default WsEndpointBuilderFactory.WsEndpointConsumerBuilder 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 (for example using Jetty or Servlet Camel components). On the producer side the exception will be deserialized and thrown as is, instead of the AhcOperationFailedException. The caused exception is required to be serialized. 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: common

bridgeErrorHandler

default WsEndpointBuilderFactory.WsEndpointConsumerBuilder 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 WsEndpointBuilderFactory.WsEndpointConsumerBuilder 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

sendMessageOnError

default WsEndpointBuilderFactory.WsEndpointConsumerBuilder sendMessageOnError(boolean sendMessageOnError)

Whether to send an message if the web-socket listener received an error. The option is a: boolean type. Default: false Group: consumer

sendMessageOnError

default WsEndpointBuilderFactory.WsEndpointConsumerBuilder sendMessageOnError(String sendMessageOnError)

Whether to send an message if the web-socket listener received an error. The option will be converted to a boolean type. Default: false Group: consumer

sslContextParameters

default WsEndpointBuilderFactory.WsEndpointConsumerBuilder sslContextParameters(Object sslContextParameters)

Reference to a org.apache.camel.support.jsse.SSLContextParameters in the Registry. This reference overrides any configured SSLContextParameters at the component level. See Using the JSSE Configuration Utility. Note that configuring this option will override any SSL/TLS configuration options provided through the clientConfig option at the endpoint or component level. The option is a: org.apache.camel.support.jsse.SSLContextParameters type. Group: security

sslContextParameters

default WsEndpointBuilderFactory.WsEndpointConsumerBuilder sslContextParameters(String sslContextParameters)

Reference to a org.apache.camel.support.jsse.SSLContextParameters in the Registry. This reference overrides any configured SSLContextParameters at the component level. See Using the JSSE Configuration Utility. Note that configuring this option will override any SSL/TLS configuration options provided through the clientConfig option at the endpoint or component level. The option will be converted to a org.apache.camel.support.jsse.SSLContextParameters type. Group: security