org.apache.camel.builder.endpoint.dsl

Interface CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder

All Superinterfaces:

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

All Known Subinterfaces:

CoAPEndpointBuilderFactory.CoAPEndpointBuilder

Enclosing interface:

CoAPEndpointBuilderFactory

public static interface CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

Builder for endpoint consumers for the CoAP component.

Method Summary

Modifier and Type	Method and Description
default CoAPEndpointBuilderFactory.AdvancedCoAPEndpointConsumerBuilder	advanced()
default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder	alias(String alias) Sets the alias used to query the KeyStore for the private key and certificate.
default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder	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 CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder	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 CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder	cipherSuites(String cipherSuites) Sets the cipherSuites String.
default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder	clientAuthentication(String clientAuthentication) Sets the configuration options for server-side client-authentication requirements.
default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder	coapMethodRestrict(String coapMethodRestrict) Comma separated list of methods that the CoAP consumer will bind to.
default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder	privateKey(PrivateKey privateKey) Set the configured private key for use with Raw Public Key.
default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder	privateKey(String privateKey) Set the configured private key for use with Raw Public Key.
default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder	pskStore(Object pskStore) Set the PskStore to use for pre-shared key.
default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder	pskStore(String pskStore) Set the PskStore to use for pre-shared key.
default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder	publicKey(PublicKey publicKey) Set the configured public key for use with Raw Public Key.
default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder	publicKey(String publicKey) Set the configured public key for use with Raw Public Key.
default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder	recommendedCipherSuitesOnly(boolean recommendedCipherSuitesOnly) The CBC cipher suites are not recommended.
default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder	recommendedCipherSuitesOnly(String recommendedCipherSuitesOnly) The CBC cipher suites are not recommended.
default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder	sslContextParameters(Object sslContextParameters) Set the SSLContextParameters object for setting up TLS.
default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder	sslContextParameters(String sslContextParameters) Set the SSLContextParameters object for setting up TLS.
default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder	trustedRpkStore(Object trustedRpkStore) Set the TrustedRpkStore to use to determine trust in raw public keys.
default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder	trustedRpkStore(String trustedRpkStore) Set the TrustedRpkStore to use to determine trust in raw public keys.

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Method Detail

advanced

default CoAPEndpointBuilderFactory.AdvancedCoAPEndpointConsumerBuilder advanced()

bridgeErrorHandler

default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder 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 CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder 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

coapMethodRestrict

default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder coapMethodRestrict(String coapMethodRestrict)

Comma separated list of methods that the CoAP consumer will bind to. The default is to bind to all methods (DELETE, GET, POST, PUT). The option is a: <code>java.lang.String</code> type. Group: consumer

Parameters:

coapMethodRestrict - the value to set

Returns:

the dsl builder

alias

default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder alias(String alias)

Sets the alias used to query the KeyStore for the private key and certificate. This parameter is used when we are enabling TLS with certificates on the service side, and similarly on the client side when TLS is used with certificates and client authentication. If the parameter is not specified then the default behavior is to use the first alias in the keystore that contains a key entry. This configuration parameter does not apply to configuring TLS via a Raw Public Key or a Pre-Shared Key. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

alias - the value to set

Returns:

the dsl builder

cipherSuites

default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder cipherSuites(String cipherSuites)

Sets the cipherSuites String. This is a comma separated String of ciphersuites to configure. If it is not specified, then it falls back to getting the ciphersuites from the sslContextParameters object. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

cipherSuites - the value to set

Returns:

the dsl builder

clientAuthentication

default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder clientAuthentication(String clientAuthentication)

Sets the configuration options for server-side client-authentication requirements. The value must be one of NONE, WANT, REQUIRE. If this value is not specified, then it falls back to checking the sslContextParameters.getServerParameters().getClientAuthentication() value. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

clientAuthentication - the value to set

Returns:

the dsl builder

privateKey

default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder privateKey(PrivateKey privateKey)

Set the configured private key for use with Raw Public Key. The option is a: <code>java.security.PrivateKey</code> type. Group: security

Parameters:

privateKey - the value to set

Returns:

the dsl builder

privateKey

default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder privateKey(String privateKey)

Set the configured private key for use with Raw Public Key. The option will be converted to a <code>java.security.PrivateKey</code> type. Group: security

Parameters:

privateKey - the value to set

Returns:

the dsl builder

pskStore

default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder pskStore(Object pskStore)

Set the PskStore to use for pre-shared key. The option is a: <code>org.eclipse.californium.scandium.dtls.pskstore.PskStore</code> type. Group: security

Parameters:

pskStore - the value to set

Returns:

the dsl builder

pskStore

default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder pskStore(String pskStore)

Set the PskStore to use for pre-shared key. The option will be converted to a <code>org.eclipse.californium.scandium.dtls.pskstore.PskStore</code> type. Group: security

Parameters:

pskStore - the value to set

Returns:

the dsl builder

publicKey

default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder publicKey(PublicKey publicKey)

Set the configured public key for use with Raw Public Key. The option is a: <code>java.security.PublicKey</code> type. Group: security

Parameters:

publicKey - the value to set

Returns:

the dsl builder

publicKey

default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder publicKey(String publicKey)

Set the configured public key for use with Raw Public Key. The option will be converted to a <code>java.security.PublicKey</code> type. Group: security

Parameters:

publicKey - the value to set

Returns:

the dsl builder

recommendedCipherSuitesOnly

default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder recommendedCipherSuitesOnly(boolean recommendedCipherSuitesOnly)

The CBC cipher suites are not recommended. If you want to use them, you first need to set the recommendedCipherSuitesOnly option to false. The option is a: <code>boolean</code> type. Default: true Group: security

Parameters:

recommendedCipherSuitesOnly - the value to set

Returns:

the dsl builder

recommendedCipherSuitesOnly

default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder recommendedCipherSuitesOnly(String recommendedCipherSuitesOnly)

The CBC cipher suites are not recommended. If you want to use them, you first need to set the recommendedCipherSuitesOnly option to false. The option will be converted to a <code>boolean</code> type. Default: true Group: security

Parameters:

recommendedCipherSuitesOnly - the value to set

Returns:

the dsl builder

sslContextParameters

default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder sslContextParameters(Object sslContextParameters)

Set the SSLContextParameters object for setting up TLS. This is required for coapstcp, and for coaps when we are using certificates for TLS (as opposed to RPK or PKS). 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 CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder sslContextParameters(String sslContextParameters)

Set the SSLContextParameters object for setting up TLS. This is required for coapstcp, and for coaps when we are using certificates for TLS (as opposed to RPK or PKS). 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

trustedRpkStore

default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder trustedRpkStore(Object trustedRpkStore)

Set the TrustedRpkStore to use to determine trust in raw public keys. The option is a: <code>org.eclipse.californium.scandium.dtls.rpkstore.TrustedRpkStore</code> type. Group: security

Parameters:

trustedRpkStore - the value to set

Returns:

the dsl builder

trustedRpkStore

default CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder trustedRpkStore(String trustedRpkStore)

Set the TrustedRpkStore to use to determine trust in raw public keys. The option will be converted to a <code>org.eclipse.californium.scandium.dtls.rpkstore.TrustedRpkStore</code> type. Group: security

Parameters:

trustedRpkStore - the value to set

Returns:

the dsl builder