Interface WsEndpointBuilderFactory.WsEndpointProducerBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
- All Known Subinterfaces:
WsEndpointBuilderFactory.WsEndpointBuilder
- Enclosing interface:
- WsEndpointBuilderFactory
public static interface WsEndpointBuilderFactory.WsEndpointProducerBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint producers for the Async HTTP Client (AHC) Websocket component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default WsEndpointBuilderFactory.AdvancedWsEndpointProducerBuilder
advanced()
default WsEndpointBuilderFactory.WsEndpointProducerBuilder
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.WsEndpointProducerBuilder
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.WsEndpointProducerBuilder
bufferSize(int bufferSize)
The initial in-memory buffer size used when transferring data between Camel and AHC Client.default WsEndpointBuilderFactory.WsEndpointProducerBuilder
bufferSize(String bufferSize)
The initial in-memory buffer size used when transferring data between Camel and AHC Client.default WsEndpointBuilderFactory.WsEndpointProducerBuilder
connectionClose(boolean connectionClose)
Define if the Connection Close header has to be added to HTTP Request.default WsEndpointBuilderFactory.WsEndpointProducerBuilder
connectionClose(String connectionClose)
Define if the Connection Close header has to be added to HTTP Request.default WsEndpointBuilderFactory.WsEndpointProducerBuilder
cookieHandler(String cookieHandler)
Configure a cookie handler to maintain a HTTP session.default WsEndpointBuilderFactory.WsEndpointProducerBuilder
cookieHandler(org.apache.camel.http.base.cookie.CookieHandler cookieHandler)
Configure a cookie handler to maintain a HTTP session.default WsEndpointBuilderFactory.WsEndpointProducerBuilder
headerFilterStrategy(String headerFilterStrategy)
To use a custom HeaderFilterStrategy to filter header to and from Camel message.default WsEndpointBuilderFactory.WsEndpointProducerBuilder
headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
To use a custom HeaderFilterStrategy to filter header to and from Camel message.default WsEndpointBuilderFactory.WsEndpointProducerBuilder
lazyStartProducer(boolean lazyStartProducer)
Whether the producer should be started lazy (on the first message).default WsEndpointBuilderFactory.WsEndpointProducerBuilder
lazyStartProducer(String lazyStartProducer)
Whether the producer should be started lazy (on the first message).default WsEndpointBuilderFactory.WsEndpointProducerBuilder
sslContextParameters(String sslContextParameters)
Reference to a org.apache.camel.support.jsse.SSLContextParameters in the Registry.default WsEndpointBuilderFactory.WsEndpointProducerBuilder
sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
Reference to a org.apache.camel.support.jsse.SSLContextParameters in the Registry.default WsEndpointBuilderFactory.WsEndpointProducerBuilder
throwExceptionOnFailure(boolean throwExceptionOnFailure)
Option to disable throwing the AhcOperationFailedException in case of failed responses from the remote server.default WsEndpointBuilderFactory.WsEndpointProducerBuilder
throwExceptionOnFailure(String throwExceptionOnFailure)
Option to disable throwing the AhcOperationFailedException in case of failed responses from the remote server.default WsEndpointBuilderFactory.WsEndpointProducerBuilder
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.WsEndpointProducerBuilder
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).default WsEndpointBuilderFactory.WsEndpointProducerBuilder
useStreaming(boolean useStreaming)
To enable streaming to send data as multiple text fragments.default WsEndpointBuilderFactory.WsEndpointProducerBuilder
useStreaming(String useStreaming)
To enable streaming to send data as multiple text fragments.
-
-
-
Method Detail
-
advanced
default WsEndpointBuilderFactory.AdvancedWsEndpointProducerBuilder advanced()
-
bridgeEndpoint
default WsEndpointBuilderFactory.WsEndpointProducerBuilder 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.WsEndpointProducerBuilder 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.WsEndpointProducerBuilder 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.WsEndpointProducerBuilder 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.WsEndpointProducerBuilder 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.WsEndpointProducerBuilder 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.WsEndpointProducerBuilder 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.WsEndpointProducerBuilder 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.WsEndpointProducerBuilder 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.WsEndpointProducerBuilder 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
-
connectionClose
default WsEndpointBuilderFactory.WsEndpointProducerBuilder connectionClose(boolean connectionClose)
Define if the Connection Close header has to be added to HTTP Request. This parameter is false by default. The option is a: <code>boolean</code> type. Default: false Group: producer- Parameters:
connectionClose
- the value to set- Returns:
- the dsl builder
-
connectionClose
default WsEndpointBuilderFactory.WsEndpointProducerBuilder connectionClose(String connectionClose)
Define if the Connection Close header has to be added to HTTP Request. This parameter is false by default. The option will be converted to a <code>boolean</code> type. Default: false Group: producer- Parameters:
connectionClose
- the value to set- Returns:
- the dsl builder
-
cookieHandler
default WsEndpointBuilderFactory.WsEndpointProducerBuilder cookieHandler(org.apache.camel.http.base.cookie.CookieHandler cookieHandler)
Configure a cookie handler to maintain a HTTP session. The option is a: <code>org.apache.camel.http.base.cookie.CookieHandler</code> type. Group: producer- Parameters:
cookieHandler
- the value to set- Returns:
- the dsl builder
-
cookieHandler
default WsEndpointBuilderFactory.WsEndpointProducerBuilder cookieHandler(String cookieHandler)
Configure a cookie handler to maintain a HTTP session. The option will be converted to a <code>org.apache.camel.http.base.cookie.CookieHandler</code> type. Group: producer- Parameters:
cookieHandler
- the value to set- Returns:
- the dsl builder
-
lazyStartProducer
default WsEndpointBuilderFactory.WsEndpointProducerBuilder 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: <code>boolean</code> type. Default: false Group: producer- Parameters:
lazyStartProducer
- the value to set- Returns:
- the dsl builder
-
lazyStartProducer
default WsEndpointBuilderFactory.WsEndpointProducerBuilder lazyStartProducer(String 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 will be converted to a <code>boolean</code> type. Default: false Group: producer- Parameters:
lazyStartProducer
- the value to set- Returns:
- the dsl builder
-
useStreaming
default WsEndpointBuilderFactory.WsEndpointProducerBuilder useStreaming(boolean useStreaming)
To enable streaming to send data as multiple text fragments. The option is a: <code>boolean</code> type. Default: false Group: producer- Parameters:
useStreaming
- the value to set- Returns:
- the dsl builder
-
useStreaming
default WsEndpointBuilderFactory.WsEndpointProducerBuilder useStreaming(String useStreaming)
To enable streaming to send data as multiple text fragments. The option will be converted to a <code>boolean</code> type. Default: false Group: producer- Parameters:
useStreaming
- the value to set- Returns:
- the dsl builder
-
sslContextParameters
default WsEndpointBuilderFactory.WsEndpointProducerBuilder 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.WsEndpointProducerBuilder 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
-
-