Package org.apache.camel.builder.component.dsl

Interface CryptoComponentBuilderFactory.CryptoComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.crypto.DigitalSignatureComponent>
All Known Implementing Classes:
CryptoComponentBuilderFactory.CryptoComponentBuilderImpl
Enclosing interface:
CryptoComponentBuilderFactory
public static interface CryptoComponentBuilderFactory.CryptoComponentBuilder extends ComponentBuilder<org.apache.camel.component.crypto.DigitalSignatureComponent>
Builder for the Crypto (JCE) component.

  • Method Details

    • algorithm

      default CryptoComponentBuilderFactory.CryptoComponentBuilder algorithm(String algorithm)
      Sets the JCE name of the Algorithm that should be used for the signer. The option is a: <code>java.lang.String</code> type. Default: SHA256withRSA Group: producer
      Parameters:
      algorithm - the value to set
      Returns:
      the dsl builder

    • alias

      default CryptoComponentBuilderFactory.CryptoComponentBuilder alias(String alias)
      Sets the alias used to query the KeyStore for keys and {link java.security.cert.Certificate Certificates} to be used in signing and verifying exchanges. This value can be provided at runtime via the message header org.apache.camel.component.crypto.DigitalSignatureConstants#KEYSTORE_ALIAS. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      alias - the value to set
      Returns:
      the dsl builder

    • certificateName

      default CryptoComponentBuilderFactory.CryptoComponentBuilder certificateName(String certificateName)
      Sets the reference name for a PrivateKey that can be found in the registry. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      certificateName - the value to set
      Returns:
      the dsl builder

    • keystore

      default CryptoComponentBuilderFactory.CryptoComponentBuilder keystore(KeyStore keystore)
      Sets the KeyStore that can contain keys and Certficates for use in signing and verifying exchanges. A KeyStore is typically used with an alias, either one supplied in the Route definition or dynamically via the message header CamelSignatureKeyStoreAlias. If no alias is supplied and there is only a single entry in the Keystore, then this single entry will be used. The option is a: <code>java.security.KeyStore</code> type. Group: producer
      Parameters:
      keystore - the value to set
      Returns:
      the dsl builder

    • keystoreName

      default CryptoComponentBuilderFactory.CryptoComponentBuilder keystoreName(String keystoreName)
      Sets the reference name for a Keystore that can be found in the registry. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      keystoreName - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default CryptoComponentBuilderFactory.CryptoComponentBuilder 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

    • privateKey

      default CryptoComponentBuilderFactory.CryptoComponentBuilder privateKey(PrivateKey privateKey)
      Set the PrivateKey that should be used to sign the exchange. The option is a: <code>java.security.PrivateKey</code> type. Group: producer
      Parameters:
      privateKey - the value to set
      Returns:
      the dsl builder

    • privateKeyName

      default CryptoComponentBuilderFactory.CryptoComponentBuilder privateKeyName(String privateKeyName)
      Sets the reference name for a PrivateKey that can be found in the registry. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      privateKeyName - the value to set
      Returns:
      the dsl builder

    • provider

      default CryptoComponentBuilderFactory.CryptoComponentBuilder provider(String provider)
      Set the id of the security provider that provides the configured Signature algorithm. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      provider - the value to set
      Returns:
      the dsl builder

    • publicKeyName

      default CryptoComponentBuilderFactory.CryptoComponentBuilder publicKeyName(String publicKeyName)
      references that should be resolved when the context changes. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      publicKeyName - the value to set
      Returns:
      the dsl builder

    • secureRandomName

      default CryptoComponentBuilderFactory.CryptoComponentBuilder secureRandomName(String secureRandomName)
      Sets the reference name for a SecureRandom that can be found in the registry. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      secureRandomName - the value to set
      Returns:
      the dsl builder

    • signatureHeaderName

      default CryptoComponentBuilderFactory.CryptoComponentBuilder signatureHeaderName(String signatureHeaderName)
      Set the name of the message header that should be used to store the base64 encoded signature. This defaults to 'CamelDigitalSignature'. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      signatureHeaderName - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default CryptoComponentBuilderFactory.CryptoComponentBuilder autowiredEnabled(boolean autowiredEnabled)
      Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      autowiredEnabled - the value to set
      Returns:
      the dsl builder

    • bufferSize

      default CryptoComponentBuilderFactory.CryptoComponentBuilder bufferSize(Integer bufferSize)
      Set the size of the buffer used to read in the Exchange payload data. The option is a: <code>java.lang.Integer</code> type. Default: 2048 Group: advanced
      Parameters:
      bufferSize - the value to set
      Returns:
      the dsl builder

    • certificate

      default CryptoComponentBuilderFactory.CryptoComponentBuilder certificate(Certificate certificate)
      Set the Certificate that should be used to verify the signature in the exchange based on its payload. The option is a: <code>java.security.cert.Certificate</code> type. Group: advanced
      Parameters:
      certificate - the value to set
      Returns:
      the dsl builder

    • clearHeaders

      default CryptoComponentBuilderFactory.CryptoComponentBuilder clearHeaders(boolean clearHeaders)
      Determines if the Signature specific headers be cleared after signing and verification. Defaults to true, and should only be made otherwise at your extreme peril as vital private information such as Keys and passwords may escape if unset. The option is a: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      clearHeaders - the value to set
      Returns:
      the dsl builder

    • configuration

      default CryptoComponentBuilderFactory.CryptoComponentBuilder configuration(org.apache.camel.component.crypto.DigitalSignatureConfiguration configuration)
      To use the shared DigitalSignatureConfiguration as configuration. The option is a: <code>org.apache.camel.component.crypto.DigitalSignatureConfiguration</code> type. Group: advanced
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder

    • keyStoreParameters

      default CryptoComponentBuilderFactory.CryptoComponentBuilder keyStoreParameters(org.apache.camel.support.jsse.KeyStoreParameters keyStoreParameters)
      Sets the KeyStore that can contain keys and Certficates for use in signing and verifying exchanges based on the given KeyStoreParameters. A KeyStore is typically used with an alias, either one supplied in the Route definition or dynamically via the message header CamelSignatureKeyStoreAlias. If no alias is supplied and there is only a single entry in the Keystore, then this single entry will be used. The option is a: <code>org.apache.camel.support.jsse.KeyStoreParameters</code> type. Group: advanced
      Parameters:
      keyStoreParameters - the value to set
      Returns:
      the dsl builder

    • publicKey

      default CryptoComponentBuilderFactory.CryptoComponentBuilder publicKey(PublicKey publicKey)
      Set the PublicKey that should be used to verify the signature in the exchange. The option is a: <code>java.security.PublicKey</code> type. Group: advanced
      Parameters:
      publicKey - the value to set
      Returns:
      the dsl builder

    • secureRandom

      default CryptoComponentBuilderFactory.CryptoComponentBuilder secureRandom(SecureRandom secureRandom)
      Set the SecureRandom used to initialize the Signature service. The option is a: <code>java.security.SecureRandom</code> type. Group: advanced
      Parameters:
      secureRandom - the value to set
      Returns:
      the dsl builder

    • password

      default CryptoComponentBuilderFactory.CryptoComponentBuilder password(String password)
      Sets the password used to access an aliased PrivateKey in the KeyStore. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      password - the value to set
      Returns:
      the dsl builder