org.apache.camel.model.dataformat

Class XMLSecurityDataFormat

java.lang.Object

org.apache.camel.model.IdentifiedType

org.apache.camel.model.DataFormatDefinition

org.apache.camel.model.dataformat.XMLSecurityDataFormat

All Implemented Interfaces:

OtherAttributesAware, NamespaceAware

@Metadata(firstVersion="2.0.0",
          label="dataformat,transformation,xml,security",
          title="XML Security")
public class XMLSecurityDataFormat
extends DataFormatDefinition
implements NamespaceAware

The XML Security data format facilitates encryption and decryption of XML payloads.

Constructor Summary

Constructors

Constructor and Description
XMLSecurityDataFormat()
XMLSecurityDataFormat(String secureTag, boolean secureTagContents) Deprecated.
XMLSecurityDataFormat(String secureTag, boolean secureTagContents, String passPhrase) Deprecated.
XMLSecurityDataFormat(String secureTag, boolean secureTagContents, String passPhrase, String xmlCipherAlgorithm) Deprecated.
XMLSecurityDataFormat(String secureTag, boolean secureTagContents, String recipientKeyAlias, String xmlCipherAlgorithm, String keyCipherAlgorithm) Deprecated. use {XMLSecurityDataFormat(String, boolean, String, String, String, String) or {XMLSecurityDataFormat(String, boolean, String, String, String, KeyStoreParameters) instead
XMLSecurityDataFormat(String secureTag, boolean secureTagContents, String recipientKeyAlias, String xmlCipherAlgorithm, String keyCipherAlgorithm, KeyStoreParameters keyOrTrustStoreParameters) Deprecated.
XMLSecurityDataFormat(String secureTag, boolean secureTagContents, String recipientKeyAlias, String xmlCipherAlgorithm, String keyCipherAlgorithm, KeyStoreParameters keyOrTrustStoreParameters, String keyPassword) Deprecated.
XMLSecurityDataFormat(String secureTag, boolean secureTagContents, String recipientKeyAlias, String xmlCipherAlgorithm, String keyCipherAlgorithm, String keyOrTrustStoreParametersId) Deprecated.
XMLSecurityDataFormat(String secureTag, boolean secureTagContents, String recipientKeyAlias, String xmlCipherAlgorithm, String keyCipherAlgorithm, String keyOrTrustStoreParametersId, String keyPassword) Deprecated.
XMLSecurityDataFormat(String secureTag, Map<String,String> namespaces, boolean secureTagContents) Deprecated.
XMLSecurityDataFormat(String secureTag, Map<String,String> namespaces, boolean secureTagContents, String passPhrase) Deprecated.
XMLSecurityDataFormat(String secureTag, Map<String,String> namespaces, boolean secureTagContents, String passPhrase, String xmlCipherAlgorithm) Deprecated.
XMLSecurityDataFormat(String secureTag, Map<String,String> namespaces, boolean secureTagContents, String recipientKeyAlias, String xmlCipherAlgorithm, String keyCipherAlgorithm) Deprecated. use {XMLSecurityDataFormat(String, Map, boolean, String, String, String, String) or {XMLSecurityDataFormat(String, Map, boolean, String, String, String, KeyStoreParameters) instead
XMLSecurityDataFormat(String secureTag, Map<String,String> namespaces, boolean secureTagContents, String recipientKeyAlias, String xmlCipherAlgorithm, String keyCipherAlgorithm, KeyStoreParameters keyOrTrustStoreParameters) Deprecated.
XMLSecurityDataFormat(String secureTag, Map<String,String> namespaces, boolean secureTagContents, String recipientKeyAlias, String xmlCipherAlgorithm, String keyCipherAlgorithm, KeyStoreParameters keyOrTrustStoreParameters, String keyPassword) Deprecated.
XMLSecurityDataFormat(String secureTag, Map<String,String> namespaces, boolean secureTagContents, String recipientKeyAlias, String xmlCipherAlgorithm, String keyCipherAlgorithm, KeyStoreParameters keyOrTrustStoreParameters, String keyPassword, String digestAlgorithm) Deprecated.
XMLSecurityDataFormat(String secureTag, Map<String,String> namespaces, boolean secureTagContents, String recipientKeyAlias, String xmlCipherAlgorithm, String keyCipherAlgorithm, String keyOrTrustStoreParametersId) Deprecated.
XMLSecurityDataFormat(String secureTag, Map<String,String> namespaces, boolean secureTagContents, String recipientKeyAlias, String xmlCipherAlgorithm, String keyCipherAlgorithm, String keyOrTrustStoreParametersId, String keyPassword) Deprecated.

Method Summary

Modifier and Type	Method and Description
protected void	configureDataFormat(DataFormat dataFormat, CamelContext camelContext) Allows derived classes to customize the data format
Boolean	getAddKeyValueForEncryptedKey()
String	getDigestAlgorithm()
String	getKeyCipherAlgorithm()
KeyStoreParameters	getKeyOrTrustStoreParameters()
String	getKeyOrTrustStoreParametersId()
String	getKeyPassword()
String	getMgfAlgorithm()
Map<String,String>	getNamespaces() Gets the XML Namespaces
String	getPassPhrase()
String	getRecipientKeyAlias()
String	getSecureTag()
Boolean	getSecureTagContents()
String	getXmlCipherAlgorithm()
void	setAddKeyValueForEncryptedKey(Boolean addKeyValueForEncryptedKey) Whether to add the public key used to encrypt the session key as a KeyValue in the EncryptedKey structure or not.
void	setDigestAlgorithm(String digestAlgorithm) The digest algorithm to use with the RSA OAEP algorithm.
void	setKeyCipherAlgorithm(String keyCipherAlgorithm) The cipher algorithm to be used for encryption/decryption of the asymmetric key.
void	setKeyOrTrustStoreParametersId(String id) Refers to a KeyStore instance to lookup in the registry, which is used for configuration options for creating and loading a KeyStore instance that represents the sender's trustStore or recipient's keyStore.
void	setKeyPassword(String keyPassword) The password to be used for retrieving the private key from the KeyStore.
void	setMgfAlgorithm(String mgfAlgorithm) The MGF Algorithm to use with the RSA OAEP algorithm.
void	setNamespaces(Map<String,String> nspaces) Injects the XML Namespaces of prefix -> uri mappings
void	setPassPhrase(String passPhrase) A String used as passPhrase to encrypt/decrypt content.
void	setRecipientKeyAlias(String recipientKeyAlias) The key alias to be used when retrieving the recipient's public or private key from a KeyStore when performing asymmetric key encryption or decryption.
void	setSecureTag(String secureTag) The XPath reference to the XML Element selected for encryption/decryption.
void	setSecureTagContents(Boolean secureTagContents) A boolean value to specify whether the XML Element is to be encrypted or the contents of the XML Element false = Element Level true = Element Content Level
void	setXmlCipherAlgorithm(String xmlCipherAlgorithm) The cipher algorithm to be used for encryption/decryption of the XML message content.

Methods inherited from class org.apache.camel.model.DataFormatDefinition

configureDataFormat, createDataFormat, getContentTypeHeader, getDataFormat, getDataFormat, getDataFormat, getDataFormatName, getOtherAttributes, getShortName, setContentTypeHeader, setDataFormat, setDataFormatName, setOtherAttributes, setProperty, setProperty

Methods inherited from class org.apache.camel.model.IdentifiedType

getId, setId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XMLSecurityDataFormat

public XMLSecurityDataFormat()

XMLSecurityDataFormat

@Deprecated
public XMLSecurityDataFormat(String secureTag,
                                         boolean secureTagContents)

Deprecated.

XMLSecurityDataFormat

@Deprecated
public XMLSecurityDataFormat(String secureTag,
                                         Map<String,String> namespaces,
                                         boolean secureTagContents)

Deprecated.

XMLSecurityDataFormat

@Deprecated
public XMLSecurityDataFormat(String secureTag,
                                         boolean secureTagContents,
                                         String passPhrase)

Deprecated.

XMLSecurityDataFormat

@Deprecated
public XMLSecurityDataFormat(String secureTag,
                                         Map<String,String> namespaces,
                                         boolean secureTagContents,
                                         String passPhrase)

Deprecated.

XMLSecurityDataFormat

@Deprecated
public XMLSecurityDataFormat(String secureTag,
                                         boolean secureTagContents,
                                         String passPhrase,
                                         String xmlCipherAlgorithm)

Deprecated.

XMLSecurityDataFormat

@Deprecated
public XMLSecurityDataFormat(String secureTag,
                                         Map<String,String> namespaces,
                                         boolean secureTagContents,
                                         String passPhrase,
                                         String xmlCipherAlgorithm)

Deprecated.

XMLSecurityDataFormat

@Deprecated
public XMLSecurityDataFormat(String secureTag,
                                         boolean secureTagContents,
                                         String recipientKeyAlias,
                                         String xmlCipherAlgorithm,
                                         String keyCipherAlgorithm)

Deprecated. use {XMLSecurityDataFormat(String, boolean, String, String, String, String) or {XMLSecurityDataFormat(String, boolean, String, String, String, KeyStoreParameters) instead

XMLSecurityDataFormat

@Deprecated
public XMLSecurityDataFormat(String secureTag,
                                         boolean secureTagContents,
                                         String recipientKeyAlias,
                                         String xmlCipherAlgorithm,
                                         String keyCipherAlgorithm,
                                         String keyOrTrustStoreParametersId)

Deprecated.

XMLSecurityDataFormat

@Deprecated
public XMLSecurityDataFormat(String secureTag,
                                         boolean secureTagContents,
                                         String recipientKeyAlias,
                                         String xmlCipherAlgorithm,
                                         String keyCipherAlgorithm,
                                         KeyStoreParameters keyOrTrustStoreParameters)

Deprecated.

XMLSecurityDataFormat

@Deprecated
public XMLSecurityDataFormat(String secureTag,
                                         boolean secureTagContents,
                                         String recipientKeyAlias,
                                         String xmlCipherAlgorithm,
                                         String keyCipherAlgorithm,
                                         String keyOrTrustStoreParametersId,
                                         String keyPassword)

Deprecated.

XMLSecurityDataFormat

@Deprecated
public XMLSecurityDataFormat(String secureTag,
                                         boolean secureTagContents,
                                         String recipientKeyAlias,
                                         String xmlCipherAlgorithm,
                                         String keyCipherAlgorithm,
                                         KeyStoreParameters keyOrTrustStoreParameters,
                                         String keyPassword)

Deprecated.

XMLSecurityDataFormat

@Deprecated
public XMLSecurityDataFormat(String secureTag,
                                         Map<String,String> namespaces,
                                         boolean secureTagContents,
                                         String recipientKeyAlias,
                                         String xmlCipherAlgorithm,
                                         String keyCipherAlgorithm)

Deprecated. use {XMLSecurityDataFormat(String, Map, boolean, String, String, String, String) or {XMLSecurityDataFormat(String, Map, boolean, String, String, String, KeyStoreParameters) instead

XMLSecurityDataFormat

@Deprecated
public XMLSecurityDataFormat(String secureTag,
                                         Map<String,String> namespaces,
                                         boolean secureTagContents,
                                         String recipientKeyAlias,
                                         String xmlCipherAlgorithm,
                                         String keyCipherAlgorithm,
                                         String keyOrTrustStoreParametersId)

Deprecated.

XMLSecurityDataFormat

@Deprecated
public XMLSecurityDataFormat(String secureTag,
                                         Map<String,String> namespaces,
                                         boolean secureTagContents,
                                         String recipientKeyAlias,
                                         String xmlCipherAlgorithm,
                                         String keyCipherAlgorithm,
                                         KeyStoreParameters keyOrTrustStoreParameters)

Deprecated.

XMLSecurityDataFormat

@Deprecated
public XMLSecurityDataFormat(String secureTag,
                                         Map<String,String> namespaces,
                                         boolean secureTagContents,
                                         String recipientKeyAlias,
                                         String xmlCipherAlgorithm,
                                         String keyCipherAlgorithm,
                                         String keyOrTrustStoreParametersId,
                                         String keyPassword)

Deprecated.

XMLSecurityDataFormat

@Deprecated
public XMLSecurityDataFormat(String secureTag,
                                         Map<String,String> namespaces,
                                         boolean secureTagContents,
                                         String recipientKeyAlias,
                                         String xmlCipherAlgorithm,
                                         String keyCipherAlgorithm,
                                         KeyStoreParameters keyOrTrustStoreParameters,
                                         String keyPassword)

Deprecated.

XMLSecurityDataFormat

@Deprecated
public XMLSecurityDataFormat(String secureTag,
                                         Map<String,String> namespaces,
                                         boolean secureTagContents,
                                         String recipientKeyAlias,
                                         String xmlCipherAlgorithm,
                                         String keyCipherAlgorithm,
                                         KeyStoreParameters keyOrTrustStoreParameters,
                                         String keyPassword,
                                         String digestAlgorithm)

Deprecated.

Method Detail

configureDataFormat

protected void configureDataFormat(DataFormat dataFormat,
                                   CamelContext camelContext)

Description copied from class: DataFormatDefinition

Allows derived classes to customize the data format

Overrides:

configureDataFormat in class DataFormatDefinition

getXmlCipherAlgorithm

public String getXmlCipherAlgorithm()

setXmlCipherAlgorithm

public void setXmlCipherAlgorithm(String xmlCipherAlgorithm)

The cipher algorithm to be used for encryption/decryption of the XML message content. The available choices are:

• XMLCipher.TRIPLEDES
• XMLCipher.AES_128
• XMLCipher.AES_128_GCM
• XMLCipher.AES_192
• XMLCipher.AES_192_GCM
• XMLCipher.AES_256
• XMLCipher.AES_256_GCM
• XMLCipher.SEED_128
• XMLCipher.CAMELLIA_128
• XMLCipher.CAMELLIA_192
• XMLCipher.CAMELLIA_256

The default value is MLCipher.TRIPLEDES

getPassPhrase

public String getPassPhrase()

setPassPhrase

public void setPassPhrase(String passPhrase)

A String used as passPhrase to encrypt/decrypt content. The passPhrase has to be provided. If no passPhrase is specified, a default passPhrase is used. The passPhrase needs to be put together in conjunction with the appropriate encryption algorithm. For example using TRIPLEDES the passPhase can be a "Only another 24 Byte key"

getSecureTag

public String getSecureTag()

setSecureTag

public void setSecureTag(String secureTag)

The XPath reference to the XML Element selected for encryption/decryption. If no tag is specified, the entire payload is encrypted/decrypted.

getSecureTagContents

public Boolean getSecureTagContents()

setSecureTagContents

public void setSecureTagContents(Boolean secureTagContents)

A boolean value to specify whether the XML Element is to be encrypted or the contents of the XML Element false = Element Level true = Element Content Level

setKeyCipherAlgorithm

public void setKeyCipherAlgorithm(String keyCipherAlgorithm)

The cipher algorithm to be used for encryption/decryption of the asymmetric key. The available choices are:

• XMLCipher.RSA_v1dot5
• XMLCipher.RSA_OAEP
• XMLCipher.RSA_OAEP_11

The default value is XMLCipher.RSA_OAEP

getKeyCipherAlgorithm

public String getKeyCipherAlgorithm()

setRecipientKeyAlias

public void setRecipientKeyAlias(String recipientKeyAlias)

The key alias to be used when retrieving the recipient's public or private key from a KeyStore when performing asymmetric key encryption or decryption.

getRecipientKeyAlias

public String getRecipientKeyAlias()

setKeyOrTrustStoreParametersId

public void setKeyOrTrustStoreParametersId(String id)

Refers to a KeyStore instance to lookup in the registry, which is used for configuration options for creating and loading a KeyStore instance that represents the sender's trustStore or recipient's keyStore.

getKeyOrTrustStoreParametersId

public String getKeyOrTrustStoreParametersId()

getKeyOrTrustStoreParameters

public KeyStoreParameters getKeyOrTrustStoreParameters()

getKeyPassword

public String getKeyPassword()

setKeyPassword

public void setKeyPassword(String keyPassword)

The password to be used for retrieving the private key from the KeyStore. This key is used for asymmetric decryption.

getDigestAlgorithm

public String getDigestAlgorithm()

setDigestAlgorithm

public void setDigestAlgorithm(String digestAlgorithm)

The digest algorithm to use with the RSA OAEP algorithm. The available choices are:

• XMLCipher.SHA1
• XMLCipher.SHA256
• XMLCipher.SHA512

The default value is XMLCipher.SHA1

getMgfAlgorithm

public String getMgfAlgorithm()

setMgfAlgorithm

public void setMgfAlgorithm(String mgfAlgorithm)

The MGF Algorithm to use with the RSA OAEP algorithm. The available choices are:

• EncryptionConstants.MGF1_SHA1
• EncryptionConstants.MGF1_SHA256
• EncryptionConstants.MGF1_SHA512

The default value is EncryptionConstants.MGF1_SHA1

getAddKeyValueForEncryptedKey

public Boolean getAddKeyValueForEncryptedKey()

setAddKeyValueForEncryptedKey

public void setAddKeyValueForEncryptedKey(Boolean addKeyValueForEncryptedKey)

Whether to add the public key used to encrypt the session key as a KeyValue in the EncryptedKey structure or not.

setNamespaces

public void setNamespaces(Map<String,String> nspaces)

Description copied from interface: NamespaceAware

Injects the XML Namespaces of prefix -> uri mappings

Specified by:

setNamespaces in interface NamespaceAware

Parameters:

nspaces - the XML namespaces with the key of prefixes and the value the URIs

getNamespaces

public Map<String,String> getNamespaces()

Description copied from interface: NamespaceAware

Gets the XML Namespaces

Specified by:

getNamespaces in interface NamespaceAware