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

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

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	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.

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Details

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: java.lang.String 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: java.lang.String 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: java.lang.String 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: java.security.KeyStore 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 java.security.KeyStore 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: java.lang.String type. Group: producer

Parameters:

keystoreName - 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: java.security.PrivateKey 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 java.security.PrivateKey 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: java.lang.String 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: java.lang.String 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: java.lang.String 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: java.lang.String 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: java.lang.String 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: java.lang.String type. Group: security

Parameters:

password - the value to set

Returns:

the dsl builder