Interface CoAPEndpointBuilderFactory.CoAPEndpointBuilder
-
- All Superinterfaces:
CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder
,CoAPEndpointBuilderFactory.CoAPEndpointProducerBuilder
,org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
,org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
- Enclosing interface:
- CoAPEndpointBuilderFactory
public static interface CoAPEndpointBuilderFactory.CoAPEndpointBuilder extends CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder, CoAPEndpointBuilderFactory.CoAPEndpointProducerBuilder
Builder for endpoint for the CoAP component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default CoAPEndpointBuilderFactory.AdvancedCoAPEndpointBuilder
advanced()
default CoAPEndpointBuilderFactory.CoAPEndpointBuilder
alias(String alias)
Sets the alias used to query the KeyStore for the private key and certificate.default CoAPEndpointBuilderFactory.CoAPEndpointBuilder
cipherSuites(String cipherSuites)
Sets the cipherSuites String.default CoAPEndpointBuilderFactory.CoAPEndpointBuilder
clientAuthentication(String clientAuthentication)
Sets the configuration options for server-side client-authentication requirements.default CoAPEndpointBuilderFactory.CoAPEndpointBuilder
privateKey(String privateKey)
Set the configured private key for use with Raw Public Key.default CoAPEndpointBuilderFactory.CoAPEndpointBuilder
privateKey(PrivateKey privateKey)
Set the configured private key for use with Raw Public Key.default CoAPEndpointBuilderFactory.CoAPEndpointBuilder
pskStore(String pskStore)
Set the PskStore to use for pre-shared key.default CoAPEndpointBuilderFactory.CoAPEndpointBuilder
pskStore(org.eclipse.californium.scandium.dtls.pskstore.PskStore pskStore)
Set the PskStore to use for pre-shared key.default CoAPEndpointBuilderFactory.CoAPEndpointBuilder
publicKey(String publicKey)
Set the configured public key for use with Raw Public Key.default CoAPEndpointBuilderFactory.CoAPEndpointBuilder
publicKey(PublicKey publicKey)
Set the configured public key for use with Raw Public Key.default CoAPEndpointBuilderFactory.CoAPEndpointBuilder
recommendedCipherSuitesOnly(boolean recommendedCipherSuitesOnly)
The CBC cipher suites are not recommended.default CoAPEndpointBuilderFactory.CoAPEndpointBuilder
recommendedCipherSuitesOnly(String recommendedCipherSuitesOnly)
The CBC cipher suites are not recommended.default CoAPEndpointBuilderFactory.CoAPEndpointBuilder
sslContextParameters(String sslContextParameters)
Set the SSLContextParameters object for setting up TLS.default CoAPEndpointBuilderFactory.CoAPEndpointBuilder
sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
Set the SSLContextParameters object for setting up TLS.default CoAPEndpointBuilderFactory.CoAPEndpointBuilder
trustedRpkStore(String trustedRpkStore)
Set the TrustedRpkStore to use to determine trust in raw public keys.default CoAPEndpointBuilderFactory.CoAPEndpointBuilder
trustedRpkStore(org.eclipse.californium.scandium.dtls.rpkstore.TrustedRpkStore trustedRpkStore)
Set the TrustedRpkStore to use to determine trust in raw public keys.-
Methods inherited from interface org.apache.camel.builder.endpoint.dsl.CoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder
coapMethodRestrict
-
Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
-
-
-
-
Method Detail
-
advanced
default CoAPEndpointBuilderFactory.AdvancedCoAPEndpointBuilder advanced()
- Specified by:
advanced
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder
- Specified by:
advanced
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointProducerBuilder
-
alias
default CoAPEndpointBuilderFactory.CoAPEndpointBuilder 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- Specified by:
alias
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder
- Specified by:
alias
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointProducerBuilder
- Parameters:
alias
- the value to set- Returns:
- the dsl builder
-
cipherSuites
default CoAPEndpointBuilderFactory.CoAPEndpointBuilder 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- Specified by:
cipherSuites
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder
- Specified by:
cipherSuites
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointProducerBuilder
- Parameters:
cipherSuites
- the value to set- Returns:
- the dsl builder
-
clientAuthentication
default CoAPEndpointBuilderFactory.CoAPEndpointBuilder 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- Specified by:
clientAuthentication
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder
- Specified by:
clientAuthentication
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointProducerBuilder
- Parameters:
clientAuthentication
- the value to set- Returns:
- the dsl builder
-
privateKey
default CoAPEndpointBuilderFactory.CoAPEndpointBuilder 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- Specified by:
privateKey
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder
- Specified by:
privateKey
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointProducerBuilder
- Parameters:
privateKey
- the value to set- Returns:
- the dsl builder
-
privateKey
default CoAPEndpointBuilderFactory.CoAPEndpointBuilder 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- Specified by:
privateKey
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder
- Specified by:
privateKey
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointProducerBuilder
- Parameters:
privateKey
- the value to set- Returns:
- the dsl builder
-
pskStore
default CoAPEndpointBuilderFactory.CoAPEndpointBuilder pskStore(org.eclipse.californium.scandium.dtls.pskstore.PskStore 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- Specified by:
pskStore
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder
- Specified by:
pskStore
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointProducerBuilder
- Parameters:
pskStore
- the value to set- Returns:
- the dsl builder
-
pskStore
default CoAPEndpointBuilderFactory.CoAPEndpointBuilder 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- Specified by:
pskStore
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder
- Specified by:
pskStore
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointProducerBuilder
- Parameters:
pskStore
- the value to set- Returns:
- the dsl builder
-
publicKey
default CoAPEndpointBuilderFactory.CoAPEndpointBuilder 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- Specified by:
publicKey
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder
- Specified by:
publicKey
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointProducerBuilder
- Parameters:
publicKey
- the value to set- Returns:
- the dsl builder
-
publicKey
default CoAPEndpointBuilderFactory.CoAPEndpointBuilder 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- Specified by:
publicKey
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder
- Specified by:
publicKey
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointProducerBuilder
- Parameters:
publicKey
- the value to set- Returns:
- the dsl builder
-
recommendedCipherSuitesOnly
default CoAPEndpointBuilderFactory.CoAPEndpointBuilder 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- Specified by:
recommendedCipherSuitesOnly
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder
- Specified by:
recommendedCipherSuitesOnly
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointProducerBuilder
- Parameters:
recommendedCipherSuitesOnly
- the value to set- Returns:
- the dsl builder
-
recommendedCipherSuitesOnly
default CoAPEndpointBuilderFactory.CoAPEndpointBuilder 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- Specified by:
recommendedCipherSuitesOnly
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder
- Specified by:
recommendedCipherSuitesOnly
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointProducerBuilder
- Parameters:
recommendedCipherSuitesOnly
- the value to set- Returns:
- the dsl builder
-
sslContextParameters
default CoAPEndpointBuilderFactory.CoAPEndpointBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters 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- Specified by:
sslContextParameters
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder
- Specified by:
sslContextParameters
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointProducerBuilder
- Parameters:
sslContextParameters
- the value to set- Returns:
- the dsl builder
-
sslContextParameters
default CoAPEndpointBuilderFactory.CoAPEndpointBuilder 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- Specified by:
sslContextParameters
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder
- Specified by:
sslContextParameters
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointProducerBuilder
- Parameters:
sslContextParameters
- the value to set- Returns:
- the dsl builder
-
trustedRpkStore
default CoAPEndpointBuilderFactory.CoAPEndpointBuilder trustedRpkStore(org.eclipse.californium.scandium.dtls.rpkstore.TrustedRpkStore 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- Specified by:
trustedRpkStore
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder
- Specified by:
trustedRpkStore
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointProducerBuilder
- Parameters:
trustedRpkStore
- the value to set- Returns:
- the dsl builder
-
trustedRpkStore
default CoAPEndpointBuilderFactory.CoAPEndpointBuilder 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- Specified by:
trustedRpkStore
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointConsumerBuilder
- Specified by:
trustedRpkStore
in interfaceCoAPEndpointBuilderFactory.CoAPEndpointProducerBuilder
- Parameters:
trustedRpkStore
- the value to set- Returns:
- the dsl builder
-
-