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
All Methods Instance Methods Default Methods Modifier and Type Method 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
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(String headerFilterStrategy)
To use a custom HeaderFilterStrategy to filter header to and from Camel message.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
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(String sslContextParameters)
Reference to a org.apache.camel.support.jsse.SSLContextParameters in the Registry.default WsEndpointBuilderFactory.WsEndpointConsumerBuilder
sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters 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).
-
-
-
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: <code>boolean</code> type. Default: false Group: common- Parameters:
bridgeEndpoint
- the value to set- Returns:
- the dsl builder
-
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 <code>boolean</code> type. Default: false Group: common- Parameters:
bridgeEndpoint
- the value to set- Returns:
- the dsl builder
-
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: <code>int</code> type. Default: 4096 Group: common- Parameters:
bufferSize
- the value to set- Returns:
- the dsl builder
-
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 <code>int</code> type. Default: 4096 Group: common- Parameters:
bufferSize
- the value to set- Returns:
- the dsl builder
-
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: <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: common- Parameters:
headerFilterStrategy
- the value to set- Returns:
- the dsl builder
-
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 <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: common- Parameters:
headerFilterStrategy
- the value to set- Returns:
- the dsl builder
-
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: <code>boolean</code> type. Default: true Group: common- Parameters:
throwExceptionOnFailure
- the value to set- Returns:
- the dsl builder
-
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 <code>boolean</code> type. Default: true Group: common- Parameters:
throwExceptionOnFailure
- the value to set- Returns:
- the dsl builder
-
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: <code>boolean</code> type. Default: false Group: common- Parameters:
transferException
- the value to set- Returns:
- the dsl builder
-
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 <code>boolean</code> type. Default: false Group: common- Parameters:
transferException
- the value to set- Returns:
- the dsl builder
-
sendMessageOnError
default WsEndpointBuilderFactory.WsEndpointConsumerBuilder sendMessageOnError(boolean sendMessageOnError)
Whether to send an message if the web-socket listener received an error. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
sendMessageOnError
- the value to set- Returns:
- the dsl builder
-
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 <code>boolean</code> type. Default: false Group: consumer- Parameters:
sendMessageOnError
- the value to set- Returns:
- the dsl builder
-
sslContextParameters
default WsEndpointBuilderFactory.WsEndpointConsumerBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters 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: <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security- Parameters:
sslContextParameters
- the value to set- Returns:
- the dsl builder
-
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 <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security- Parameters:
sslContextParameters
- the value to set- Returns:
- the dsl builder
-
-