Interface PQCEndpointBuilderFactory.AdvancedPQCEndpointBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
Enclosing interface:
PQCEndpointBuilderFactory

public static interface PQCEndpointBuilderFactory.AdvancedPQCEndpointBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Advanced builder for endpoint for the PQC Algorithms component.
  • Method Details

    • basic

    • lazyStartProducer

      default PQCEndpointBuilderFactory.AdvancedPQCEndpointBuilder 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: boolean type. Default: false Group: producer (advanced)
      Parameters:
      lazyStartProducer - the value to set
      Returns:
      the dsl builder
    • lazyStartProducer

      default PQCEndpointBuilderFactory.AdvancedPQCEndpointBuilder 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 boolean type. Default: false Group: producer (advanced)
      Parameters:
      lazyStartProducer - the value to set
      Returns:
      the dsl builder
    • keyEncapsulationAlgorithm

      default PQCEndpointBuilderFactory.AdvancedPQCEndpointBuilder keyEncapsulationAlgorithm(String keyEncapsulationAlgorithm)
      In case there is no keyGenerator, we specify an algorithm to build the KeyGenerator. The option is a: java.lang.String type. Group: advanced
      Parameters:
      keyEncapsulationAlgorithm - the value to set
      Returns:
      the dsl builder
    • keyGenerator

      The Key Generator to be used in encapsulation and extraction. The option is a: javax.crypto.KeyGenerator type. Group: advanced
      Parameters:
      keyGenerator - the value to set
      Returns:
      the dsl builder
    • keyGenerator

      default PQCEndpointBuilderFactory.AdvancedPQCEndpointBuilder keyGenerator(String keyGenerator)
      The Key Generator to be used in encapsulation and extraction. The option will be converted to a javax.crypto.KeyGenerator type. Group: advanced
      Parameters:
      keyGenerator - the value to set
      Returns:
      the dsl builder
    • keyPair

      The KeyPair to be used. The option is a: java.security.KeyPair type. Group: advanced
      Parameters:
      keyPair - the value to set
      Returns:
      the dsl builder
    • keyPair

      The KeyPair to be used. The option will be converted to a java.security.KeyPair type. Group: advanced
      Parameters:
      keyPair - the value to set
      Returns:
      the dsl builder
    • keyPairAlias

      default PQCEndpointBuilderFactory.AdvancedPQCEndpointBuilder keyPairAlias(String keyPairAlias)
      A KeyPair alias to use in combination with KeyStore parameter. The option is a: java.lang.String type. Group: advanced
      Parameters:
      keyPairAlias - the value to set
      Returns:
      the dsl builder
    • keyStore

      A KeyStore where we could get Cryptographic material. The option is a: java.security.KeyStore type. Group: advanced
      Parameters:
      keyStore - the value to set
      Returns:
      the dsl builder
    • keyStore

      A KeyStore where we could get Cryptographic material. The option will be converted to a java.security.KeyStore type. Group: advanced
      Parameters:
      keyStore - the value to set
      Returns:
      the dsl builder
    • keyStorePassword

      default PQCEndpointBuilderFactory.AdvancedPQCEndpointBuilder keyStorePassword(String keyStorePassword)
      The KeyStore password to use in combination with KeyStore Parameter. The option is a: java.lang.String type. Group: advanced
      Parameters:
      keyStorePassword - the value to set
      Returns:
      the dsl builder
    • signatureAlgorithm

      default PQCEndpointBuilderFactory.AdvancedPQCEndpointBuilder signatureAlgorithm(String signatureAlgorithm)
      In case there is no signer, we specify an algorithm to build the KeyPair or the Signer. The option is a: java.lang.String type. Group: advanced
      Parameters:
      signatureAlgorithm - the value to set
      Returns:
      the dsl builder
    • signer

      The Signer to be used. The option is a: java.security.Signature type. Group: advanced
      Parameters:
      signer - the value to set
      Returns:
      the dsl builder
    • signer

      The Signer to be used. The option will be converted to a java.security.Signature type. Group: advanced
      Parameters:
      signer - the value to set
      Returns:
      the dsl builder
    • storeExtractedSecretKeyAsHeader

      default PQCEndpointBuilderFactory.AdvancedPQCEndpointBuilder storeExtractedSecretKeyAsHeader(boolean storeExtractedSecretKeyAsHeader)
      In the context of extractSecretKeyFromEncapsulation operation, this option define if we want to have the key set as header. The option is a: boolean type. Default: false Group: advanced
      Parameters:
      storeExtractedSecretKeyAsHeader - the value to set
      Returns:
      the dsl builder
    • storeExtractedSecretKeyAsHeader

      default PQCEndpointBuilderFactory.AdvancedPQCEndpointBuilder storeExtractedSecretKeyAsHeader(String storeExtractedSecretKeyAsHeader)
      In the context of extractSecretKeyFromEncapsulation operation, this option define if we want to have the key set as header. The option will be converted to a boolean type. Default: false Group: advanced
      Parameters:
      storeExtractedSecretKeyAsHeader - the value to set
      Returns:
      the dsl builder
    • symmetricKeyAlgorithm

      default PQCEndpointBuilderFactory.AdvancedPQCEndpointBuilder symmetricKeyAlgorithm(String symmetricKeyAlgorithm)
      In case we are using KEM operations, we need a Symmetric algorithm to be defined for the flow to work. The option is a: java.lang.String type. Group: advanced
      Parameters:
      symmetricKeyAlgorithm - the value to set
      Returns:
      the dsl builder
    • symmetricKeyLength

      default PQCEndpointBuilderFactory.AdvancedPQCEndpointBuilder symmetricKeyLength(int symmetricKeyLength)
      The required length of the symmetric key used. The option is a: int type. Default: 128 Group: advanced
      Parameters:
      symmetricKeyLength - the value to set
      Returns:
      the dsl builder
    • symmetricKeyLength

      default PQCEndpointBuilderFactory.AdvancedPQCEndpointBuilder symmetricKeyLength(String symmetricKeyLength)
      The required length of the symmetric key used. The option will be converted to a int type. Default: 128 Group: advanced
      Parameters:
      symmetricKeyLength - the value to set
      Returns:
      the dsl builder