org.apache.camel.builder.endpoint.dsl

Interface NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder

All Superinterfaces:

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

All Known Subinterfaces:

NettyHttpEndpointBuilderFactory.NettyHttpEndpointBuilder

Enclosing interface:

NettyHttpEndpointBuilderFactory

public static interface NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

Builder for endpoint consumers for the Netty HTTP component.

Method Summary

Modifier and Type	Method and Description
default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder	advanced()
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	bridgeEndpoint(boolean bridgeEndpoint) If the option is true, the producer will ignore the Exchange.HTTP_URI header, and use the endpoint's URI for request.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	bridgeEndpoint(String bridgeEndpoint) If the option is true, the producer will ignore the Exchange.HTTP_URI header, and use the endpoint's URI for request.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	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 NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	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 NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	decoders(List<Object> decoders) A list of decoders to be used.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	decoders(String decoders) A list of decoders to be used.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	disconnect(boolean disconnect) Whether or not to disconnect(close) from Netty Channel right after use.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	disconnect(String disconnect) Whether or not to disconnect(close) from Netty Channel right after use.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	enabledProtocols(String enabledProtocols) Which protocols to enable when using SSL.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	encoders(List<Object> encoders) A list of encoders to be used.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	encoders(String encoders) A list of encoders to be used.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	keepAlive(boolean keepAlive) Setting to ensure socket is not closed due to inactivity.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	keepAlive(String keepAlive) Setting to ensure socket is not closed due to inactivity.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	keyStoreFile(File keyStoreFile) Client side certificate keystore to be used for encryption.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	keyStoreFile(String keyStoreFile) Client side certificate keystore to be used for encryption.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	keyStoreFormat(String keyStoreFormat) Keystore format to be used for payload encryption.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	keyStoreResource(String keyStoreResource) Client side certificate keystore to be used for encryption.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	matchOnUriPrefix(boolean matchOnUriPrefix) Whether or not Camel should try to find a target consumer by matching the URI prefix if no exact match is found.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	matchOnUriPrefix(String matchOnUriPrefix) Whether or not Camel should try to find a target consumer by matching the URI prefix if no exact match is found.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	muteException(boolean muteException) If enabled and an Exchange failed processing on the consumer side the response's body won't contain the exception's stack trace.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	muteException(String muteException) If enabled and an Exchange failed processing on the consumer side the response's body won't contain the exception's stack trace.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	needClientAuth(boolean needClientAuth) Configures whether the server needs client authentication when using SSL.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	needClientAuth(String needClientAuth) Configures whether the server needs client authentication when using SSL.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	passphrase(String passphrase) Password setting to use in order to encrypt/decrypt payloads sent using SSH.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	reuseAddress(boolean reuseAddress) Setting to facilitate socket multiplexing.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	reuseAddress(String reuseAddress) Setting to facilitate socket multiplexing.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	reuseChannel(boolean reuseChannel) This option allows producers and consumers (in client mode) to reuse the same Netty Channel for the lifecycle of processing the Exchange.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	reuseChannel(String reuseChannel) This option allows producers and consumers (in client mode) to reuse the same Netty Channel for the lifecycle of processing the Exchange.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	securityConfiguration(Object securityConfiguration) Refers to a org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration for configuring secure web resources.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	securityConfiguration(String securityConfiguration) Refers to a org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration for configuring secure web resources.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	securityOptions(Map values) To configure NettyHttpSecurityConfiguration using key/value pairs from the map.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	securityOptions(String key, Object value) To configure NettyHttpSecurityConfiguration using key/value pairs from the map.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	securityProvider(String securityProvider) Security provider to be used for payload encryption.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	send503whenSuspended(boolean send503whenSuspended) Whether to send back HTTP status code 503 when the consumer has been suspended.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	send503whenSuspended(String send503whenSuspended) Whether to send back HTTP status code 503 when the consumer has been suspended.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	ssl(boolean ssl) Setting to specify whether SSL encryption is applied to this endpoint.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	ssl(String ssl) Setting to specify whether SSL encryption is applied to this endpoint.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	sslClientCertHeaders(boolean sslClientCertHeaders) When enabled and in SSL mode, then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name, issuer name, serial number, and the valid date range.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	sslClientCertHeaders(String sslClientCertHeaders) When enabled and in SSL mode, then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name, issuer name, serial number, and the valid date range.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	sslContextParameters(Object sslContextParameters) To configure security using SSLContextParameters.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	sslContextParameters(String sslContextParameters) To configure security using SSLContextParameters.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	sslHandler(Object sslHandler) Reference to a class that could be used to return an SSL Handler.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	sslHandler(String sslHandler) Reference to a class that could be used to return an SSL Handler.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	sync(boolean sync) Setting to set endpoint as one-way or request-response.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	sync(String sync) Setting to set endpoint as one-way or request-response.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	tcpNoDelay(boolean tcpNoDelay) Setting to improve TCP protocol performance.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	tcpNoDelay(String tcpNoDelay) Setting to improve TCP protocol performance.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	trustStoreFile(File trustStoreFile) Server side certificate keystore to be used for encryption.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	trustStoreFile(String trustStoreFile) Server side certificate keystore to be used for encryption.
default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder	trustStoreResource(String trustStoreResource) Server side certificate keystore to be used for encryption.

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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder advanced()

bridgeEndpoint

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder bridgeEndpoint(boolean bridgeEndpoint)

If the option is true, the producer will ignore the Exchange.HTTP_URI header, and use the endpoint's URI for request. You may also set the throwExceptionOnFailure to be false to let the producer send all the fault response back. The consumer working in the bridge mode will skip the gzip compression and WWW URL form encoding (by adding the Exchange.SKIP_GZIP_ENCODING and Exchange.SKIP_WWW_FORM_URLENCODED headers to the consumed exchange). The option is a: <code>boolean</code> type. Default: false Group: common

Parameters:

bridgeEndpoint - the value to set

Returns:

the dsl builder

bridgeEndpoint

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder bridgeEndpoint(String bridgeEndpoint)

If the option is true, the producer will ignore the Exchange.HTTP_URI header, and use the endpoint's URI for request. You may also set the throwExceptionOnFailure to be false to let the producer send all the fault response back. The consumer working in the bridge mode will skip the gzip compression and WWW URL form encoding (by adding the Exchange.SKIP_GZIP_ENCODING and Exchange.SKIP_WWW_FORM_URLENCODED headers to the consumed exchange). 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

disconnect

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder disconnect(boolean disconnect)

Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer. The option is a: <code>boolean</code> type. Default: false Group: common

Parameters:

disconnect - the value to set

Returns:

the dsl builder

disconnect

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder disconnect(String disconnect)

Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer. The option will be converted to a <code>boolean</code> type. Default: false Group: common

Parameters:

disconnect - the value to set

Returns:

the dsl builder

keepAlive

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder keepAlive(boolean keepAlive)

Setting to ensure socket is not closed due to inactivity. The option is a: <code>boolean</code> type. Default: true Group: common

Parameters:

keepAlive - the value to set

Returns:

the dsl builder

keepAlive

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder keepAlive(String keepAlive)

Setting to ensure socket is not closed due to inactivity. The option will be converted to a <code>boolean</code> type. Default: true Group: common

Parameters:

keepAlive - the value to set

Returns:

the dsl builder

reuseAddress

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder reuseAddress(boolean reuseAddress)

Setting to facilitate socket multiplexing. The option is a: <code>boolean</code> type. Default: true Group: common

Parameters:

reuseAddress - the value to set

Returns:

the dsl builder

reuseAddress

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder reuseAddress(String reuseAddress)

Setting to facilitate socket multiplexing. The option will be converted to a <code>boolean</code> type. Default: true Group: common

Parameters:

reuseAddress - the value to set

Returns:

the dsl builder

reuseChannel

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder reuseChannel(boolean reuseChannel)

This option allows producers and consumers (in client mode) to reuse the same Netty Channel for the lifecycle of processing the Exchange. This is useful if you need to call a server multiple times in a Camel route and want to use the same network connection. When using this, the channel is not returned to the connection pool until the Exchange is done; or disconnected if the disconnect option is set to true. The reused Channel is stored on the Exchange as an exchange property with the key NettyConstants#NETTY_CHANNEL which allows you to obtain the channel during routing and use it as well. The option is a: <code>boolean</code> type. Default: false Group: common

Parameters:

reuseChannel - the value to set

Returns:

the dsl builder

reuseChannel

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder reuseChannel(String reuseChannel)

This option allows producers and consumers (in client mode) to reuse the same Netty Channel for the lifecycle of processing the Exchange. This is useful if you need to call a server multiple times in a Camel route and want to use the same network connection. When using this, the channel is not returned to the connection pool until the Exchange is done; or disconnected if the disconnect option is set to true. The reused Channel is stored on the Exchange as an exchange property with the key NettyConstants#NETTY_CHANNEL which allows you to obtain the channel during routing and use it as well. The option will be converted to a <code>boolean</code> type. Default: false Group: common

Parameters:

reuseChannel - the value to set

Returns:

the dsl builder

sync

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder sync(boolean sync)

Setting to set endpoint as one-way or request-response. The option is a: <code>boolean</code> type. Default: true Group: common

Parameters:

sync - the value to set

Returns:

the dsl builder

sync

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder sync(String sync)

Setting to set endpoint as one-way or request-response. The option will be converted to a <code>boolean</code> type. Default: true Group: common

Parameters:

sync - the value to set

Returns:

the dsl builder

tcpNoDelay

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder tcpNoDelay(boolean tcpNoDelay)

Setting to improve TCP protocol performance. The option is a: <code>boolean</code> type. Default: true Group: common

Parameters:

tcpNoDelay - the value to set

Returns:

the dsl builder

tcpNoDelay

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder tcpNoDelay(String tcpNoDelay)

Setting to improve TCP protocol performance. The option will be converted to a <code>boolean</code> type. Default: true Group: common

Parameters:

tcpNoDelay - the value to set

Returns:

the dsl builder

bridgeErrorHandler

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder 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: <code>boolean</code> type. Default: false Group: consumer

Parameters:

bridgeErrorHandler - the value to set

Returns:

the dsl builder

bridgeErrorHandler

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder 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 <code>boolean</code> type. Default: false Group: consumer

Parameters:

bridgeErrorHandler - the value to set

Returns:

the dsl builder

matchOnUriPrefix

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder matchOnUriPrefix(boolean matchOnUriPrefix)

Whether or not Camel should try to find a target consumer by matching the URI prefix if no exact match is found. The option is a: <code>boolean</code> type. Default: false Group: consumer

Parameters:

matchOnUriPrefix - the value to set

Returns:

the dsl builder

matchOnUriPrefix

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder matchOnUriPrefix(String matchOnUriPrefix)

Whether or not Camel should try to find a target consumer by matching the URI prefix if no exact match is found. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer

Parameters:

matchOnUriPrefix - the value to set

Returns:

the dsl builder

muteException

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder muteException(boolean muteException)

If enabled and an Exchange failed processing on the consumer side the response's body won't contain the exception's stack trace. The option is a: <code>boolean</code> type. Default: false Group: consumer

Parameters:

muteException - the value to set

Returns:

the dsl builder

muteException

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder muteException(String muteException)

If enabled and an Exchange failed processing on the consumer side the response's body won't contain the exception's stack trace. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer

Parameters:

muteException - the value to set

Returns:

the dsl builder

send503whenSuspended

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder send503whenSuspended(boolean send503whenSuspended)

Whether to send back HTTP status code 503 when the consumer has been suspended. If the option is false then the Netty Acceptor is unbound when the consumer is suspended, so clients cannot connect anymore. The option is a: <code>boolean</code> type. Default: true Group: consumer

Parameters:

send503whenSuspended - the value to set

Returns:

the dsl builder

send503whenSuspended

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder send503whenSuspended(String send503whenSuspended)

Whether to send back HTTP status code 503 when the consumer has been suspended. If the option is false then the Netty Acceptor is unbound when the consumer is suspended, so clients cannot connect anymore. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer

Parameters:

send503whenSuspended - the value to set

Returns:

the dsl builder

decoders

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder decoders(List<Object> decoders)

A list of decoders to be used. You can use a String which have values separated by comma, and have the values be looked up in the Registry. Just remember to prefix the value with # so Camel knows it should lookup. The option is a: <code>java.util.List&lt;io.netty.channel.ChannelHandler&gt;</code> type. Group: codec

Parameters:

decoders - the value to set

Returns:

the dsl builder

decoders

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder decoders(String decoders)

A list of decoders to be used. You can use a String which have values separated by comma, and have the values be looked up in the Registry. Just remember to prefix the value with # so Camel knows it should lookup. The option will be converted to a <code>java.util.List&lt;io.netty.channel.ChannelHandler&gt;</code> type. Group: codec

Parameters:

decoders - the value to set

Returns:

the dsl builder

encoders

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder encoders(List<Object> encoders)

A list of encoders to be used. You can use a String which have values separated by comma, and have the values be looked up in the Registry. Just remember to prefix the value with # so Camel knows it should lookup. The option is a: <code>java.util.List&lt;io.netty.channel.ChannelHandler&gt;</code> type. Group: codec

Parameters:

encoders - the value to set

Returns:

the dsl builder

encoders

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder encoders(String encoders)

A list of encoders to be used. You can use a String which have values separated by comma, and have the values be looked up in the Registry. Just remember to prefix the value with # so Camel knows it should lookup. The option will be converted to a <code>java.util.List&lt;io.netty.channel.ChannelHandler&gt;</code> type. Group: codec

Parameters:

encoders - the value to set

Returns:

the dsl builder

enabledProtocols

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder enabledProtocols(String enabledProtocols)

Which protocols to enable when using SSL. The option is a: <code>java.lang.String</code> type. Default: TLSv1,TLSv1.1,TLSv1.2 Group: security

Parameters:

enabledProtocols - the value to set

Returns:

the dsl builder

keyStoreFile

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder keyStoreFile(File keyStoreFile)

Client side certificate keystore to be used for encryption. The option is a: <code>java.io.File</code> type. Group: security

Parameters:

keyStoreFile - the value to set

Returns:

the dsl builder

keyStoreFile

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder keyStoreFile(String keyStoreFile)

Client side certificate keystore to be used for encryption. The option will be converted to a <code>java.io.File</code> type. Group: security

Parameters:

keyStoreFile - the value to set

Returns:

the dsl builder

keyStoreFormat

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder keyStoreFormat(String keyStoreFormat)

Keystore format to be used for payload encryption. Defaults to JKS if not set. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

keyStoreFormat - the value to set

Returns:

the dsl builder

keyStoreResource

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder keyStoreResource(String keyStoreResource)

Client side certificate keystore to be used for encryption. Is loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

keyStoreResource - the value to set

Returns:

the dsl builder

needClientAuth

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder needClientAuth(boolean needClientAuth)

Configures whether the server needs client authentication when using SSL. The option is a: <code>boolean</code> type. Default: false Group: security

Parameters:

needClientAuth - the value to set

Returns:

the dsl builder

needClientAuth

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder needClientAuth(String needClientAuth)

Configures whether the server needs client authentication when using SSL. The option will be converted to a <code>boolean</code> type. Default: false Group: security

Parameters:

needClientAuth - the value to set

Returns:

the dsl builder

passphrase

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder passphrase(String passphrase)

Password setting to use in order to encrypt/decrypt payloads sent using SSH. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

passphrase - the value to set

Returns:

the dsl builder

securityConfiguration

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder securityConfiguration(Object securityConfiguration)

Refers to a org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration for configuring secure web resources. The option is a: <code>org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration</code> type. Group: security

Parameters:

securityConfiguration - the value to set

Returns:

the dsl builder

securityConfiguration

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder securityConfiguration(String securityConfiguration)

Refers to a org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration for configuring secure web resources. The option will be converted to a <code>org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration</code> type. Group: security

Parameters:

securityConfiguration - the value to set

Returns:

the dsl builder

securityOptions

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder securityOptions(String key,
                                                                                         Object value)

To configure NettyHttpSecurityConfiguration using key/value pairs from the map. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the securityOptions(String, Object) method to add a value (call the method multiple times to set more values). Group: security

Parameters:

key - the option key

value - the option value

Returns:

the dsl builder

securityOptions

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder securityOptions(Map values)

To configure NettyHttpSecurityConfiguration using key/value pairs from the map. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the securityOptions(String, Object) method to add a value (call the method multiple times to set more values). Group: security

Parameters:

values - the values

Returns:

the dsl builder

securityProvider

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder securityProvider(String securityProvider)

Security provider to be used for payload encryption. Defaults to SunX509 if not set. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

securityProvider - the value to set

Returns:

the dsl builder

ssl

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder ssl(boolean ssl)

Setting to specify whether SSL encryption is applied to this endpoint. The option is a: <code>boolean</code> type. Default: false Group: security

Parameters:

ssl - the value to set

Returns:

the dsl builder

ssl

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder ssl(String ssl)

Setting to specify whether SSL encryption is applied to this endpoint. The option will be converted to a <code>boolean</code> type. Default: false Group: security

Parameters:

ssl - the value to set

Returns:

the dsl builder

sslClientCertHeaders

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder sslClientCertHeaders(boolean sslClientCertHeaders)

When enabled and in SSL mode, then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name, issuer name, serial number, and the valid date range. The option is a: <code>boolean</code> type. Default: false Group: security

Parameters:

sslClientCertHeaders - the value to set

Returns:

the dsl builder

sslClientCertHeaders

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder sslClientCertHeaders(String sslClientCertHeaders)

When enabled and in SSL mode, then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name, issuer name, serial number, and the valid date range. The option will be converted to a <code>boolean</code> type. Default: false Group: security

Parameters:

sslClientCertHeaders - the value to set

Returns:

the dsl builder

sslContextParameters

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder sslContextParameters(Object sslContextParameters)

To configure security using SSLContextParameters. 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 NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder sslContextParameters(String sslContextParameters)

To configure security using SSLContextParameters. 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

sslHandler

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder sslHandler(Object sslHandler)

Reference to a class that could be used to return an SSL Handler. The option is a: <code>io.netty.handler.ssl.SslHandler</code> type. Group: security

Parameters:

sslHandler - the value to set

Returns:

the dsl builder

sslHandler

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder sslHandler(String sslHandler)

Reference to a class that could be used to return an SSL Handler. The option will be converted to a <code>io.netty.handler.ssl.SslHandler</code> type. Group: security

Parameters:

sslHandler - the value to set

Returns:

the dsl builder

trustStoreFile

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder trustStoreFile(File trustStoreFile)

Server side certificate keystore to be used for encryption. The option is a: <code>java.io.File</code> type. Group: security

Parameters:

trustStoreFile - the value to set

Returns:

the dsl builder

trustStoreFile

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder trustStoreFile(String trustStoreFile)

Server side certificate keystore to be used for encryption. The option will be converted to a <code>java.io.File</code> type. Group: security

Parameters:

trustStoreFile - the value to set

Returns:

the dsl builder

trustStoreResource

default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder trustStoreResource(String trustStoreResource)

Server side certificate keystore to be used for encryption. Is loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

trustStoreResource - the value to set

Returns:

the dsl builder