org.apache.camel.builder.endpoint.dsl

Interface WsEndpointBuilderFactory.WsEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, WsEndpointBuilderFactory.WsEndpointConsumerBuilder, WsEndpointBuilderFactory.WsEndpointProducerBuilder

Enclosing interface:

WsEndpointBuilderFactory

public static interface WsEndpointBuilderFactory.WsEndpointBuilder
extends WsEndpointBuilderFactory.WsEndpointConsumerBuilder, WsEndpointBuilderFactory.WsEndpointProducerBuilder

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

Method Summary

Modifier and Type	Method and Description
default WsEndpointBuilderFactory.AdvancedWsEndpointBuilder	advanced()
default WsEndpointBuilderFactory.WsEndpointBuilder	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.WsEndpointBuilder	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.WsEndpointBuilder	bufferSize(int bufferSize) The initial in-memory buffer size used when transferring data between Camel and AHC Client.
default WsEndpointBuilderFactory.WsEndpointBuilder	bufferSize(String bufferSize) The initial in-memory buffer size used when transferring data between Camel and AHC Client.
default WsEndpointBuilderFactory.WsEndpointBuilder	headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy) To use a custom HeaderFilterStrategy to filter header to and from Camel message.
default WsEndpointBuilderFactory.WsEndpointBuilder	headerFilterStrategy(String headerFilterStrategy) To use a custom HeaderFilterStrategy to filter header to and from Camel message.
default WsEndpointBuilderFactory.WsEndpointBuilder	sslContextParameters(Object sslContextParameters) Reference to a org.apache.camel.support.jsse.SSLContextParameters in the Registry.
default WsEndpointBuilderFactory.WsEndpointBuilder	sslContextParameters(String sslContextParameters) Reference to a org.apache.camel.support.jsse.SSLContextParameters in the Registry.
default WsEndpointBuilderFactory.WsEndpointBuilder	throwExceptionOnFailure(boolean throwExceptionOnFailure) Option to disable throwing the AhcOperationFailedException in case of failed responses from the remote server.
default WsEndpointBuilderFactory.WsEndpointBuilder	throwExceptionOnFailure(String throwExceptionOnFailure) Option to disable throwing the AhcOperationFailedException in case of failed responses from the remote server.
default WsEndpointBuilderFactory.WsEndpointBuilder	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.WsEndpointBuilder	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.endpoint.dsl.WsEndpointBuilderFactory.WsEndpointConsumerBuilder

bridgeErrorHandler, bridgeErrorHandler, sendMessageOnError, sendMessageOnError

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.WsEndpointBuilderFactory.WsEndpointProducerBuilder

connectionClose, connectionClose, cookieHandler, cookieHandler, lazyStartProducer, lazyStartProducer, useStreaming, useStreaming

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default WsEndpointBuilderFactory.AdvancedWsEndpointBuilder advanced()

Specified by:

advanced in interface WsEndpointBuilderFactory.WsEndpointConsumerBuilder

Specified by:

advanced in interface WsEndpointBuilderFactory.WsEndpointProducerBuilder

bridgeEndpoint

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

Specified by:

bridgeEndpoint in interface WsEndpointBuilderFactory.WsEndpointConsumerBuilder

Specified by:

bridgeEndpoint in interface WsEndpointBuilderFactory.WsEndpointProducerBuilder

Parameters:

bridgeEndpoint - the value to set

Returns:

the dsl builder

bridgeEndpoint

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

Specified by:

bridgeEndpoint in interface WsEndpointBuilderFactory.WsEndpointConsumerBuilder

Specified by:

bridgeEndpoint in interface WsEndpointBuilderFactory.WsEndpointProducerBuilder

Parameters:

bridgeEndpoint - the value to set

Returns:

the dsl builder

bufferSize

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

Specified by:

bufferSize in interface WsEndpointBuilderFactory.WsEndpointConsumerBuilder

Specified by:

bufferSize in interface WsEndpointBuilderFactory.WsEndpointProducerBuilder

Parameters:

bufferSize - the value to set

Returns:

the dsl builder

bufferSize

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

Specified by:

bufferSize in interface WsEndpointBuilderFactory.WsEndpointConsumerBuilder

Specified by:

bufferSize in interface WsEndpointBuilderFactory.WsEndpointProducerBuilder

Parameters:

bufferSize - the value to set

Returns:

the dsl builder

headerFilterStrategy

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

Specified by:

headerFilterStrategy in interface WsEndpointBuilderFactory.WsEndpointConsumerBuilder

Specified by:

headerFilterStrategy in interface WsEndpointBuilderFactory.WsEndpointProducerBuilder

Parameters:

headerFilterStrategy - the value to set

Returns:

the dsl builder

headerFilterStrategy

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

Specified by:

headerFilterStrategy in interface WsEndpointBuilderFactory.WsEndpointConsumerBuilder

Specified by:

headerFilterStrategy in interface WsEndpointBuilderFactory.WsEndpointProducerBuilder

Parameters:

headerFilterStrategy - the value to set

Returns:

the dsl builder

throwExceptionOnFailure

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

Specified by:

throwExceptionOnFailure in interface WsEndpointBuilderFactory.WsEndpointConsumerBuilder

Specified by:

throwExceptionOnFailure in interface WsEndpointBuilderFactory.WsEndpointProducerBuilder

Parameters:

throwExceptionOnFailure - the value to set

Returns:

the dsl builder

throwExceptionOnFailure

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

Specified by:

throwExceptionOnFailure in interface WsEndpointBuilderFactory.WsEndpointConsumerBuilder

Specified by:

throwExceptionOnFailure in interface WsEndpointBuilderFactory.WsEndpointProducerBuilder

Parameters:

throwExceptionOnFailure - the value to set

Returns:

the dsl builder

transferException

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

Specified by:

transferException in interface WsEndpointBuilderFactory.WsEndpointConsumerBuilder

Specified by:

transferException in interface WsEndpointBuilderFactory.WsEndpointProducerBuilder

Parameters:

transferException - the value to set

Returns:

the dsl builder

transferException

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

Specified by:

transferException in interface WsEndpointBuilderFactory.WsEndpointConsumerBuilder

Specified by:

transferException in interface WsEndpointBuilderFactory.WsEndpointProducerBuilder

Parameters:

transferException - the value to set

Returns:

the dsl builder

sslContextParameters

default WsEndpointBuilderFactory.WsEndpointBuilder 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: <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security

Specified by:

sslContextParameters in interface WsEndpointBuilderFactory.WsEndpointConsumerBuilder

Specified by:

sslContextParameters in interface WsEndpointBuilderFactory.WsEndpointProducerBuilder

Parameters:

sslContextParameters - the value to set

Returns:

the dsl builder

sslContextParameters

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

Specified by:

sslContextParameters in interface WsEndpointBuilderFactory.WsEndpointConsumerBuilder

Specified by:

sslContextParameters in interface WsEndpointBuilderFactory.WsEndpointProducerBuilder

Parameters:

sslContextParameters - the value to set

Returns:

the dsl builder