Interface DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
- Enclosing interface:
- DigitalSignatureEndpointBuilderFactory
public static interface DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint for the Crypto (JCE) component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default DigitalSignatureEndpointBuilderFactory.AdvancedDigitalSignatureEndpointBuilder
advanced()
default DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder
algorithm(String algorithm)
Sets the JCE name of the Algorithm that should be used for the signer.default DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder
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.default DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder
certificateName(String certificateName)
Sets the reference name for a PrivateKey that can be found in the registry.default DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder
keystore(String keystore)
Sets the KeyStore that can contain keys and Certficates for use in signing and verifying exchanges.default DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder
keystore(KeyStore keystore)
Sets the KeyStore that can contain keys and Certficates for use in signing and verifying exchanges.default DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder
keystoreName(String keystoreName)
Sets the reference name for a Keystore that can be found in the registry.default DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder
lazyStartProducer(boolean lazyStartProducer)
Whether the producer should be started lazy (on the first message).default DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder
lazyStartProducer(String lazyStartProducer)
Whether the producer should be started lazy (on the first message).default DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder
password(String password)
Sets the password used to access an aliased PrivateKey in the KeyStore.default DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder
privateKey(String privateKey)
Set the PrivateKey that should be used to sign the exchange.default DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder
privateKey(PrivateKey privateKey)
Set the PrivateKey that should be used to sign the exchange.default DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder
privateKeyName(String privateKeyName)
Sets the reference name for a PrivateKey that can be found in the registry.default DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder
provider(String provider)
Set the id of the security provider that provides the configured Signature algorithm.default DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder
publicKeyName(String publicKeyName)
references that should be resolved when the context changes.default DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder
secureRandomName(String secureRandomName)
Sets the reference name for a SecureRandom that can be found in the registry.default DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder
signatureHeaderName(String signatureHeaderName)
Set the name of the message header that should be used to store the base64 encoded signature.
-
-
-
Method Detail
-
advanced
default DigitalSignatureEndpointBuilderFactory.AdvancedDigitalSignatureEndpointBuilder advanced()
-
algorithm
default DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder 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 DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder 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 DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder 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 DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder 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
-
keystore
default DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder keystore(String 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 will be converted to a <code>java.security.KeyStore</code> type. Group: producer- Parameters:
keystore
- the value to set- Returns:
- the dsl builder
-
keystoreName
default DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder 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 DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder 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 DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder 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
-
privateKey
default DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder 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
-
privateKey
default DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder privateKey(String privateKey)
Set the PrivateKey that should be used to sign the exchange. The option will be converted to a <code>java.security.PrivateKey</code> type. Group: producer- Parameters:
privateKey
- the value to set- Returns:
- the dsl builder
-
privateKeyName
default DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder 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 DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder 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 DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder 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 DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder 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 DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder 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
-
password
default DigitalSignatureEndpointBuilderFactory.DigitalSignatureEndpointBuilder 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
-
-