org.apache.camel.builder.endpoint.dsl

Interface CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

Enclosing interface:

CryptoCmsEndpointBuilderFactory

public static interface CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint for the Crypto CMS component.

Method Summary

Modifier and Type	Method and Description
default CryptoCmsEndpointBuilderFactory.AdvancedCryptoCmsEndpointBuilder	advanced()
default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder	contentEncryptionAlgorithm(String contentEncryptionAlgorithm) Encryption algorithm, for example DESede/CBC/PKCS5Padding.
default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder	fromBase64(boolean fromBase64) If true then the CMS message is base 64 encoded and must be decoded during the processing.
default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder	fromBase64(String fromBase64) If true then the CMS message is base 64 encoded and must be decoded during the processing.
default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder	includeContent(Boolean includeContent) Indicates whether the signed content should be included into the Signed Data instance.
default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder	includeContent(String includeContent) Indicates whether the signed content should be included into the Signed Data instance.
default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder	keyStore(KeyStore keyStore) Keystore which contains signer private keys, verifier public keys, encryptor public keys, decryptor private keys depending on the operation.
default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder	keyStore(String keyStore) Keystore which contains signer private keys, verifier public keys, encryptor public keys, decryptor private keys depending on the operation.
default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder	keyStoreParameters(Object keyStoreParameters) Keystore containing signer private keys, verifier public keys, encryptor public keys, decryptor private keys depending on the operation.
default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder	keyStoreParameters(String keyStoreParameters) Keystore containing signer private keys, verifier public keys, encryptor public keys, decryptor private keys depending on the operation.
default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder	originatorInformationProvider(Object originatorInformationProvider) Provider for the originator info.
default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder	originatorInformationProvider(String originatorInformationProvider) Provider for the originator info.
default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder	password(Character[] password) Sets the password of the private keys.
default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder	password(String password) Sets the password of the private keys.
default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder	recipient(List<Object> recipient) Recipient Info: reference to a bean which implements the interface org.apache.camel.component.crypto.cms.api.TransRecipientInfo.
default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder	recipient(String recipient) Recipient Info: reference to a bean which implements the interface org.apache.camel.component.crypto.cms.api.TransRecipientInfo.
default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder	secretKeyLength(int secretKeyLength) Key length for the secret symmetric key used for the content encryption.
default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder	secretKeyLength(String secretKeyLength) Key length for the secret symmetric key used for the content encryption.
default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder	signedDataHeaderBase64(boolean signedDataHeaderBase64) Indicates whether the value in the header CamelCryptoCmsSignedData is base64 encoded.
default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder	signedDataHeaderBase64(String signedDataHeaderBase64) Indicates whether the value in the header CamelCryptoCmsSignedData is base64 encoded.
default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder	signer(String signer) Signer information: reference to bean(s) which implements org.apache.camel.component.crypto.cms.api.SignerInfo.
default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder	toBase64(Boolean toBase64) Indicates whether the Signed Data or Enveloped Data instance shall be base 64 encoded.
default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder	toBase64(String toBase64) Indicates whether the Signed Data or Enveloped Data instance shall be base 64 encoded.
default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder	unprotectedAttributesGeneratorProvider(Object unprotectedAttributesGeneratorProvider) Provider of the generator for the unprotected attributes.
default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder	unprotectedAttributesGeneratorProvider(String unprotectedAttributesGeneratorProvider) Provider of the generator for the unprotected attributes.
default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder	verifySignaturesOfAllSigners(boolean verifySignaturesOfAllSigners) If true then the signatures of all signers contained in the Signed Data object are verified.
default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder	verifySignaturesOfAllSigners(String verifySignaturesOfAllSigners) If true then the signatures of all signers contained in the Signed Data object are verified.

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default CryptoCmsEndpointBuilderFactory.AdvancedCryptoCmsEndpointBuilder advanced()

keyStore

default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder keyStore(KeyStore keyStore)

Keystore which contains signer private keys, verifier public keys, encryptor public keys, decryptor private keys depending on the operation. Use either this parameter or the parameter 'keyStoreParameters'. The option is a: <code>java.security.KeyStore</code> type. Group: common

Parameters:

keyStore - the value to set

Returns:

the dsl builder

keyStore

default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder keyStore(String keyStore)

Keystore which contains signer private keys, verifier public keys, encryptor public keys, decryptor private keys depending on the operation. Use either this parameter or the parameter 'keyStoreParameters'. The option will be converted to a <code>java.security.KeyStore</code> type. Group: common

Parameters:

keyStore - the value to set

Returns:

the dsl builder

keyStoreParameters

default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder keyStoreParameters(Object keyStoreParameters)

Keystore containing signer private keys, verifier public keys, encryptor public keys, decryptor private keys depending on the operation. Use either this parameter or the parameter 'keystore'. The option is a: <code>org.apache.camel.support.jsse.KeyStoreParameters</code> type. Group: common

Parameters:

keyStoreParameters - the value to set

Returns:

the dsl builder

keyStoreParameters

default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder keyStoreParameters(String keyStoreParameters)

Keystore containing signer private keys, verifier public keys, encryptor public keys, decryptor private keys depending on the operation. Use either this parameter or the parameter 'keystore'. The option will be converted to a <code>org.apache.camel.support.jsse.KeyStoreParameters</code> type. Group: common

Parameters:

keyStoreParameters - the value to set

Returns:

the dsl builder

lazyStartProducer

default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder 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 CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder 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

password

default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder password(Character[] password)

Sets the password of the private keys. It is assumed that all private keys in the keystore have the same password. If not set then it is assumed that the password of the private keys is given by the keystore password given in the KeyStoreParameters. The option is a: <code>char[]</code> type. Group: decrypt

Parameters:

password - the value to set

Returns:

the dsl builder

password

default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder password(String password)

Sets the password of the private keys. It is assumed that all private keys in the keystore have the same password. If not set then it is assumed that the password of the private keys is given by the keystore password given in the KeyStoreParameters. The option will be converted to a <code>char[]</code> type. Group: decrypt

Parameters:

password - the value to set

Returns:

the dsl builder

fromBase64

default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder fromBase64(boolean fromBase64)

If true then the CMS message is base 64 encoded and must be decoded during the processing. Default value is false. The option is a: <code>boolean</code> type. Default: false Group: decrypt_verify

Parameters:

fromBase64 - the value to set

Returns:

the dsl builder

fromBase64

default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder fromBase64(String fromBase64)

If true then the CMS message is base 64 encoded and must be decoded during the processing. Default value is false. The option will be converted to a <code>boolean</code> type. Default: false Group: decrypt_verify

Parameters:

fromBase64 - the value to set

Returns:

the dsl builder

contentEncryptionAlgorithm

default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder contentEncryptionAlgorithm(String contentEncryptionAlgorithm)

Encryption algorithm, for example DESede/CBC/PKCS5Padding. Further possible values: DESede/CBC/PKCS5Padding, AES/CBC/PKCS5Padding, Camellia/CBC/PKCS5Padding, CAST5/CBC/PKCS5Padding. The option is a: <code>java.lang.String</code> type. Group: encrypt

Parameters:

contentEncryptionAlgorithm - the value to set

Returns:

the dsl builder

originatorInformationProvider

default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder originatorInformationProvider(Object originatorInformationProvider)

Provider for the originator info. See https://tools.ietf.org/html/rfc5652#section-6.1. The default value is null. The option is a: <code>org.apache.camel.component.crypto.cms.common.OriginatorInformationProvider</code> type. Group: encrypt

Parameters:

originatorInformationProvider - the value to set

Returns:

the dsl builder

originatorInformationProvider

default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder originatorInformationProvider(String originatorInformationProvider)

Provider for the originator info. See https://tools.ietf.org/html/rfc5652#section-6.1. The default value is null. The option will be converted to a <code>org.apache.camel.component.crypto.cms.common.OriginatorInformationProvider</code> type. Group: encrypt

Parameters:

originatorInformationProvider - the value to set

Returns:

the dsl builder

recipient

default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder recipient(List<Object> recipient)

Recipient Info: reference to a bean which implements the interface org.apache.camel.component.crypto.cms.api.TransRecipientInfo. The option is a: <code>java.util.List&lt;org.apache.camel.component.crypto.cms.crypt.RecipientInfo&gt;</code> type. Group: encrypt

Parameters:

recipient - the value to set

Returns:

the dsl builder

recipient

default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder recipient(String recipient)

Recipient Info: reference to a bean which implements the interface org.apache.camel.component.crypto.cms.api.TransRecipientInfo. The option will be converted to a <code>java.util.List&lt;org.apache.camel.component.crypto.cms.crypt.RecipientInfo&gt;</code> type. Group: encrypt

Parameters:

recipient - the value to set

Returns:

the dsl builder

secretKeyLength

default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder secretKeyLength(int secretKeyLength)

Key length for the secret symmetric key used for the content encryption. Only used if the specified content-encryption algorithm allows keys of different sizes. If contentEncryptionAlgorithm=AES/CBC/PKCS5Padding or Camellia/CBC/PKCS5Padding then 128; if contentEncryptionAlgorithm=DESede/CBC/PKCS5Padding then 192, 128; if strong encryption is enabled then for AES/CBC/PKCS5Padding and Camellia/CBC/PKCS5Padding also the key lengths 192 and 256 are possible. The option is a: <code>int</code> type. Group: encrypt

Parameters:

secretKeyLength - the value to set

Returns:

the dsl builder

secretKeyLength

default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder secretKeyLength(String secretKeyLength)

Key length for the secret symmetric key used for the content encryption. Only used if the specified content-encryption algorithm allows keys of different sizes. If contentEncryptionAlgorithm=AES/CBC/PKCS5Padding or Camellia/CBC/PKCS5Padding then 128; if contentEncryptionAlgorithm=DESede/CBC/PKCS5Padding then 192, 128; if strong encryption is enabled then for AES/CBC/PKCS5Padding and Camellia/CBC/PKCS5Padding also the key lengths 192 and 256 are possible. The option will be converted to a <code>int</code> type. Group: encrypt

Parameters:

secretKeyLength - the value to set

Returns:

the dsl builder

unprotectedAttributesGeneratorProvider

default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder unprotectedAttributesGeneratorProvider(Object unprotectedAttributesGeneratorProvider)

Provider of the generator for the unprotected attributes. The default value is null which means no unprotected attribute is added to the Enveloped Data object. See https://tools.ietf.org/html/rfc5652#section-6.1. The option is a: <code>org.apache.camel.component.crypto.cms.common.AttributesGeneratorProvider</code> type. Group: encrypt

Parameters:

unprotectedAttributesGeneratorProvider - the value to set

Returns:

the dsl builder

unprotectedAttributesGeneratorProvider

default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder unprotectedAttributesGeneratorProvider(String unprotectedAttributesGeneratorProvider)

Provider of the generator for the unprotected attributes. The default value is null which means no unprotected attribute is added to the Enveloped Data object. See https://tools.ietf.org/html/rfc5652#section-6.1. The option will be converted to a <code>org.apache.camel.component.crypto.cms.common.AttributesGeneratorProvider</code> type. Group: encrypt

Parameters:

unprotectedAttributesGeneratorProvider - the value to set

Returns:

the dsl builder

toBase64

default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder toBase64(Boolean toBase64)

Indicates whether the Signed Data or Enveloped Data instance shall be base 64 encoded. Default value is false. The option is a: <code>java.lang.Boolean</code> type. Default: false Group: encrypt_sign

Parameters:

toBase64 - the value to set

Returns:

the dsl builder

toBase64

default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder toBase64(String toBase64)

Indicates whether the Signed Data or Enveloped Data instance shall be base 64 encoded. Default value is false. The option will be converted to a <code>java.lang.Boolean</code> type. Default: false Group: encrypt_sign

Parameters:

toBase64 - the value to set

Returns:

the dsl builder

includeContent

default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder includeContent(Boolean includeContent)

Indicates whether the signed content should be included into the Signed Data instance. If false then a detached Signed Data instance is created in the header CamelCryptoCmsSignedData. The option is a: <code>java.lang.Boolean</code> type. Default: true Group: sign

Parameters:

includeContent - the value to set

Returns:

the dsl builder

includeContent

default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder includeContent(String includeContent)

Indicates whether the signed content should be included into the Signed Data instance. If false then a detached Signed Data instance is created in the header CamelCryptoCmsSignedData. The option will be converted to a <code>java.lang.Boolean</code> type. Default: true Group: sign

Parameters:

includeContent - the value to set

Returns:

the dsl builder

signer

default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder signer(String signer)

Signer information: reference to bean(s) which implements org.apache.camel.component.crypto.cms.api.SignerInfo. Multiple values can be separated by comma. The option is a: <code>java.lang.String</code> type. Group: sign

Parameters:

signer - the value to set

Returns:

the dsl builder

signedDataHeaderBase64

default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder signedDataHeaderBase64(boolean signedDataHeaderBase64)

Indicates whether the value in the header CamelCryptoCmsSignedData is base64 encoded. Default value is false. Only relevant for detached signatures. In the detached signature case, the header contains the Signed Data object. The option is a: <code>boolean</code> type. Default: false Group: verify

Parameters:

signedDataHeaderBase64 - the value to set

Returns:

the dsl builder

signedDataHeaderBase64

default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder signedDataHeaderBase64(String signedDataHeaderBase64)

Indicates whether the value in the header CamelCryptoCmsSignedData is base64 encoded. Default value is false. Only relevant for detached signatures. In the detached signature case, the header contains the Signed Data object. The option will be converted to a <code>boolean</code> type. Default: false Group: verify

Parameters:

signedDataHeaderBase64 - the value to set

Returns:

the dsl builder

verifySignaturesOfAllSigners

default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder verifySignaturesOfAllSigners(boolean verifySignaturesOfAllSigners)

If true then the signatures of all signers contained in the Signed Data object are verified. If false then only one signature whose signer info matches with one of the specified certificates is verified. Default value is true. The option is a: <code>boolean</code> type. Default: true Group: verify

Parameters:

verifySignaturesOfAllSigners - the value to set

Returns:

the dsl builder

verifySignaturesOfAllSigners

default CryptoCmsEndpointBuilderFactory.CryptoCmsEndpointBuilder verifySignaturesOfAllSigners(String verifySignaturesOfAllSigners)

If true then the signatures of all signers contained in the Signed Data object are verified. If false then only one signature whose signer info matches with one of the specified certificates is verified. Default value is true. The option will be converted to a <code>boolean</code> type. Default: true Group: verify

Parameters:

verifySignaturesOfAllSigners - the value to set

Returns:

the dsl builder