Package org.apache.camel.builder.endpoint.dsl

Interface CoAPEndpointBuilderFactory.CoAPEndpointProducerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    All Known Subinterfaces:
    CoAPEndpointBuilderFactory.CoAPEndpointBuilder
    Enclosing interface:
    CoAPEndpointBuilderFactory
    public static interface CoAPEndpointBuilderFactory.CoAPEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint producers for the CoAP component.

    • Method Detail

      • lazyStartProducer

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

      • alias

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