org.apache.camel.builder.endpoint.dsl

Interface XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder

All Superinterfaces:

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

Enclosing interface:

XmlSignatureEndpointBuilderFactory

public static interface XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint for the XML Security component.

Method Summary

Modifier and Type	Method and Description
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	addKeyInfoReference(Boolean addKeyInfoReference) In order to protect the KeyInfo element from tampering you can add a reference to the signed info element so that it is protected via the signature value.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	addKeyInfoReference(String addKeyInfoReference) In order to protect the KeyInfo element from tampering you can add a reference to the signed info element so that it is protected via the signature value.
default XmlSignatureEndpointBuilderFactory.AdvancedXmlSignatureEndpointBuilder	advanced()
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	baseUri(String baseUri) You can set a base URI which is used in the URI dereferencing.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	canonicalizationMethod(Object canonicalizationMethod) Canonicalization method used to canonicalize the SignedInfo element before the digest is calculated.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	canonicalizationMethod(String canonicalizationMethod) Canonicalization method used to canonicalize the SignedInfo element before the digest is calculated.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	clearHeaders(Boolean clearHeaders) Determines if the XML signature specific headers be cleared after signing and verification.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	clearHeaders(String clearHeaders) Determines if the XML signature specific headers be cleared after signing and verification.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	contentObjectId(String contentObjectId) Sets the content object Id attribute value.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	contentReferenceType(String contentReferenceType) Type of the content reference.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	contentReferenceUri(String contentReferenceUri) Reference URI for the content to be signed.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	cryptoContextProperties(Map<String,Object> cryptoContextProperties) Sets the crypto context properties.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	cryptoContextProperties(String cryptoContextProperties) Sets the crypto context properties.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	digestAlgorithm(String digestAlgorithm) Digest algorithm URI.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	disallowDoctypeDecl(Boolean disallowDoctypeDecl) Disallows that the incoming XML document contains DTD DOCTYPE declaration.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	disallowDoctypeDecl(String disallowDoctypeDecl) Disallows that the incoming XML document contains DTD DOCTYPE declaration.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	keyAccessor(Object keyAccessor) For the signing process, a private key is necessary.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	keyAccessor(String keyAccessor) For the signing process, a private key is necessary.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	keySelector(Object keySelector) Provides the key for validating the XML signature.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	keySelector(String keySelector) Provides the key for validating the XML signature.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	omitXmlDeclaration(Boolean omitXmlDeclaration) Indicator whether the XML declaration in the outgoing message body should be omitted.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	omitXmlDeclaration(String omitXmlDeclaration) Indicator whether the XML declaration in the outgoing message body should be omitted.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	outputNodeSearch(Object outputNodeSearch) Sets the output node search value for determining the node from the XML signature document which shall be set to the output message body.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	outputNodeSearch(String outputNodeSearch) Sets the output node search value for determining the node from the XML signature document which shall be set to the output message body.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	outputNodeSearchType(String outputNodeSearchType) Determines the search type for determining the output node which is serialized into the output message bodyF.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	outputXmlEncoding(String outputXmlEncoding) The character encoding of the resulting signed XML document.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	parentLocalName(String parentLocalName) Local name of the parent element to which the XML signature element will be added.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	parentNamespace(String parentNamespace) Namespace of the parent element to which the XML signature element will be added.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	parentXpath(Object parentXpath) Sets the XPath to find the parent node in the enveloped case.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	parentXpath(String parentXpath) Sets the XPath to find the parent node in the enveloped case.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	plainText(Boolean plainText) Indicator whether the message body contains plain text.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	plainText(String plainText) Indicator whether the message body contains plain text.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	plainTextEncoding(String plainTextEncoding) Encoding of the plain text.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	prefixForXmlSignatureNamespace(String prefixForXmlSignatureNamespace) Namespace prefix for the XML signature namespace http://www.w3.org/2000/09/xmldsig#.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	properties(Object properties) For adding additional References and Objects to the XML signature which contain additional properties, you can provide a bean which implements the XmlSignatureProperties interface.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	properties(String properties) For adding additional References and Objects to the XML signature which contain additional properties, you can provide a bean which implements the XmlSignatureProperties interface.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	removeSignatureElements(Boolean removeSignatureElements) Indicator whether the XML signature elements (elements with local name Signature and namesapce http://www.w3.org/2000/09/xmldsig#) shall be removed from the document set to the output message.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	removeSignatureElements(String removeSignatureElements) Indicator whether the XML signature elements (elements with local name Signature and namesapce http://www.w3.org/2000/09/xmldsig#) shall be removed from the document set to the output message.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	schemaResourceUri(String schemaResourceUri) Classpath to the XML Schema.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	secureValidation(Boolean secureValidation) Enables secure validation.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	secureValidation(String secureValidation) Enables secure validation.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	signatureAlgorithm(String signatureAlgorithm) Signature algorithm.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	signatureId(String signatureId) Sets the signature Id.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	transformMethods(List<Object> transformMethods) Transforms which are executed on the message body before the digest is calculated.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	transformMethods(String transformMethods) Transforms which are executed on the message body before the digest is calculated.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	validationFailedHandler(Object validationFailedHandler) Handles the different validation failed situations.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	validationFailedHandler(String validationFailedHandler) Handles the different validation failed situations.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	xmlSignature2Message(Object xmlSignature2Message) Bean which maps the XML signature to the output-message after the validation.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	xmlSignature2Message(String xmlSignature2Message) Bean which maps the XML signature to the output-message after the validation.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	xmlSignatureChecker(Object xmlSignatureChecker) This interface allows the application to check the XML signature before the validation is executed.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	xmlSignatureChecker(String xmlSignatureChecker) This interface allows the application to check the XML signature before the validation is executed.
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	xpathsToIdAttributes(List<Object> xpathsToIdAttributes) Define the elements which are signed in the detached case via XPATH expressions to ID attributes (attributes of type ID).
default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder	xpathsToIdAttributes(String xpathsToIdAttributes) Define the elements which are signed in the detached case via XPATH expressions to ID attributes (attributes of type ID).

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

doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve

Method Detail

advanced

default XmlSignatureEndpointBuilderFactory.AdvancedXmlSignatureEndpointBuilder advanced()

baseUri

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder baseUri(String baseUri)

You can set a base URI which is used in the URI dereferencing. Relative URIs are then concatenated with the base URI. The option is a: java.lang.String type. Group: common

clearHeaders

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder clearHeaders(Boolean clearHeaders)

Determines if the XML signature specific headers be cleared after signing and verification. Defaults to true. The option is a: java.lang.Boolean type. Default: true Group: common

clearHeaders

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder clearHeaders(String clearHeaders)

Determines if the XML signature specific headers be cleared after signing and verification. Defaults to true. The option will be converted to a java.lang.Boolean type. Default: true Group: common

cryptoContextProperties

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder cryptoContextProperties(Map<String,Object> cryptoContextProperties)

Sets the crypto context properties. See XMLCryptoContext#setProperty(String,Object) . Possible properties are defined in XMLSignContext an XMLValidateContext (see Supported Properties). The following properties are set by default to the value Boolean#TRUE for the XML validation. If you want to switch these features off you must set the property value to Boolean#FALSE . org.jcp.xml.dsig.validateManifests javax.xml.crypto.dsig.cacheReference. The option is a: java.util.Map<java.lang.String, java.lang.Object> type. Group: common

cryptoContextProperties

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder cryptoContextProperties(String cryptoContextProperties)

Sets the crypto context properties. See XMLCryptoContext#setProperty(String,Object) . Possible properties are defined in XMLSignContext an XMLValidateContext (see Supported Properties). The following properties are set by default to the value Boolean#TRUE for the XML validation. If you want to switch these features off you must set the property value to Boolean#FALSE . org.jcp.xml.dsig.validateManifests javax.xml.crypto.dsig.cacheReference. The option will be converted to a java.util.Map<java.lang.String, java.lang.Object> type. Group: common

disallowDoctypeDecl

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder disallowDoctypeDecl(Boolean disallowDoctypeDecl)

Disallows that the incoming XML document contains DTD DOCTYPE declaration. The default value is Boolean#TRUE . The option is a: java.lang.Boolean type. Default: true Group: common

disallowDoctypeDecl

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder disallowDoctypeDecl(String disallowDoctypeDecl)

Disallows that the incoming XML document contains DTD DOCTYPE declaration. The default value is Boolean#TRUE . The option will be converted to a java.lang.Boolean type. Default: true Group: common

omitXmlDeclaration

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder omitXmlDeclaration(Boolean omitXmlDeclaration)

Indicator whether the XML declaration in the outgoing message body should be omitted. Default value is false. Can be overwritten by the header XmlSignatureConstants#HEADER_OMIT_XML_DECLARATION . The option is a: java.lang.Boolean type. Default: false Group: common

omitXmlDeclaration

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder omitXmlDeclaration(String omitXmlDeclaration)

Indicator whether the XML declaration in the outgoing message body should be omitted. Default value is false. Can be overwritten by the header XmlSignatureConstants#HEADER_OMIT_XML_DECLARATION . The option will be converted to a java.lang.Boolean type. Default: false Group: common

outputXmlEncoding

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder outputXmlEncoding(String outputXmlEncoding)

The character encoding of the resulting signed XML document. If null then the encoding of the original XML document is used. The option is a: java.lang.String type. Group: common

schemaResourceUri

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder schemaResourceUri(String schemaResourceUri)

Classpath to the XML Schema. Must be specified in the detached XML Signature case for determining the ID attributes, might be set in the enveloped and enveloping case. If set, then the XML document is validated with the specified XML schema. The schema resource URI can be overwritten by the header XmlSignatureConstants#HEADER_SCHEMA_RESOURCE_URI . The option is a: java.lang.String type. Group: common

lazyStartProducer

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder 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: boolean type. Default: false Group: producer

lazyStartProducer

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder 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 boolean type. Default: false Group: producer

addKeyInfoReference

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder addKeyInfoReference(Boolean addKeyInfoReference)

In order to protect the KeyInfo element from tampering you can add a reference to the signed info element so that it is protected via the signature value. The default value is true. Only relevant when a KeyInfo is returned by KeyAccessor . and KeyInfo#getId() is not null. The option is a: java.lang.Boolean type. Default: true Group: sign

addKeyInfoReference

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder addKeyInfoReference(String addKeyInfoReference)

In order to protect the KeyInfo element from tampering you can add a reference to the signed info element so that it is protected via the signature value. The default value is true. Only relevant when a KeyInfo is returned by KeyAccessor . and KeyInfo#getId() is not null. The option will be converted to a java.lang.Boolean type. Default: true Group: sign

canonicalizationMethod

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder canonicalizationMethod(Object canonicalizationMethod)

Canonicalization method used to canonicalize the SignedInfo element before the digest is calculated. You can use the helper methods XmlSignatureHelper.getCanonicalizationMethod(String algorithm) or getCanonicalizationMethod(String algorithm, List inclusiveNamespacePrefixes) to create a canonicalization method. The option is a: javax.xml.crypto.AlgorithmMethod type. Default: http://www.w3.org/TR/2001/REC-xml-c14n-20010315 Group: sign

canonicalizationMethod

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder canonicalizationMethod(String canonicalizationMethod)

Canonicalization method used to canonicalize the SignedInfo element before the digest is calculated. You can use the helper methods XmlSignatureHelper.getCanonicalizationMethod(String algorithm) or getCanonicalizationMethod(String algorithm, List inclusiveNamespacePrefixes) to create a canonicalization method. The option will be converted to a javax.xml.crypto.AlgorithmMethod type. Default: http://www.w3.org/TR/2001/REC-xml-c14n-20010315 Group: sign

contentObjectId

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder contentObjectId(String contentObjectId)

Sets the content object Id attribute value. By default a UUID is generated. If you set the null value, then a new UUID will be generated. Only used in the enveloping case. The option is a: java.lang.String type. Group: sign

contentReferenceType

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder contentReferenceType(String contentReferenceType)

Type of the content reference. The default value is null. This value can be overwritten by the header XmlSignatureConstants#HEADER_CONTENT_REFERENCE_TYPE . The option is a: java.lang.String type. Group: sign

contentReferenceUri

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder contentReferenceUri(String contentReferenceUri)

Reference URI for the content to be signed. Only used in the enveloped case. If the reference URI contains an ID attribute value, then the resource schema URI ( setSchemaResourceUri(String) ) must also be set because the schema validator will then find out which attributes are ID attributes. Will be ignored in the enveloping or detached case. The option is a: java.lang.String type. Group: sign

digestAlgorithm

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder digestAlgorithm(String digestAlgorithm)

Digest algorithm URI. Optional parameter. This digest algorithm is used for calculating the digest of the input message. If this digest algorithm is not specified then the digest algorithm is calculated from the signature algorithm. Example: http://www.w3.org/2001/04/xmlenc#sha256. The option is a: java.lang.String type. Group: sign

keyAccessor

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder keyAccessor(Object keyAccessor)

For the signing process, a private key is necessary. You specify a key accessor bean which provides this private key. The key accessor bean must implement the KeyAccessor interface. The package org.apache.camel.component.xmlsecurity.api contains the default implementation class DefaultKeyAccessor which reads the private key from a Java keystore. The option is a: org.apache.camel.component.xmlsecurity.api.KeyAccessor type. Group: sign

keyAccessor

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder keyAccessor(String keyAccessor)

For the signing process, a private key is necessary. You specify a key accessor bean which provides this private key. The key accessor bean must implement the KeyAccessor interface. The package org.apache.camel.component.xmlsecurity.api contains the default implementation class DefaultKeyAccessor which reads the private key from a Java keystore. The option will be converted to a org.apache.camel.component.xmlsecurity.api.KeyAccessor type. Group: sign

parentLocalName

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder parentLocalName(String parentLocalName)

Local name of the parent element to which the XML signature element will be added. Only relevant for enveloped XML signature. Alternatively you can also use setParentXpath(XPathFilterParameterSpec) . Default value is null. The value must be null for enveloping and detached XML signature. This parameter or the parameter setParentXpath(XPathFilterParameterSpec) for enveloped signature and the parameter setXpathsToIdAttributes(List) for detached signature must not be set in the same configuration. If the parameters parentXpath and parentLocalName are specified in the same configuration then an exception is thrown. The option is a: java.lang.String type. Group: sign

parentNamespace

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder parentNamespace(String parentNamespace)

Namespace of the parent element to which the XML signature element will be added. The option is a: java.lang.String type. Group: sign

parentXpath

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder parentXpath(Object parentXpath)

Sets the XPath to find the parent node in the enveloped case. Either you specify the parent node via this method or the local name and namespace of the parent with the methods setParentLocalName(String) and setParentNamespace(String) . Default value is null. The value must be null for enveloping and detached XML signature. If the parameters parentXpath and parentLocalName are specified in the same configuration then an exception is thrown. The option is a: javax.xml.crypto.dsig.spec.XPathFilterParameterSpec type. Group: sign

parentXpath

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder parentXpath(String parentXpath)

Sets the XPath to find the parent node in the enveloped case. Either you specify the parent node via this method or the local name and namespace of the parent with the methods setParentLocalName(String) and setParentNamespace(String) . Default value is null. The value must be null for enveloping and detached XML signature. If the parameters parentXpath and parentLocalName are specified in the same configuration then an exception is thrown. The option will be converted to a javax.xml.crypto.dsig.spec.XPathFilterParameterSpec type. Group: sign

plainText

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder plainText(Boolean plainText)

Indicator whether the message body contains plain text. The default value is false, indicating that the message body contains XML. The value can be overwritten by the header XmlSignatureConstants#HEADER_MESSAGE_IS_PLAIN_TEXT . The option is a: java.lang.Boolean type. Default: false Group: sign

plainText

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder plainText(String plainText)

Indicator whether the message body contains plain text. The default value is false, indicating that the message body contains XML. The value can be overwritten by the header XmlSignatureConstants#HEADER_MESSAGE_IS_PLAIN_TEXT . The option will be converted to a java.lang.Boolean type. Default: false Group: sign

plainTextEncoding

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder plainTextEncoding(String plainTextEncoding)

Encoding of the plain text. Only relevant if the message body is plain text (see parameter plainText . Default value is UTF-8. The option is a: java.lang.String type. Default: UTF-8 Group: sign

prefixForXmlSignatureNamespace

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder prefixForXmlSignatureNamespace(String prefixForXmlSignatureNamespace)

Namespace prefix for the XML signature namespace http://www.w3.org/2000/09/xmldsig#. Default value is ds. If null or an empty value is set then no prefix is used for the XML signature namespace. See best practice http://www.w3.org/TR/xmldsig-bestpractices/#signing-xml- without-namespaces. The option is a: java.lang.String type. Default: ds Group: sign

properties

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder properties(Object properties)

For adding additional References and Objects to the XML signature which contain additional properties, you can provide a bean which implements the XmlSignatureProperties interface. The option is a: org.apache.camel.component.xmlsecurity.api.XmlSignatureProperties type. Group: sign

properties

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder properties(String properties)

For adding additional References and Objects to the XML signature which contain additional properties, you can provide a bean which implements the XmlSignatureProperties interface. The option will be converted to a org.apache.camel.component.xmlsecurity.api.XmlSignatureProperties type. Group: sign

signatureAlgorithm

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder signatureAlgorithm(String signatureAlgorithm)

Signature algorithm. Default value is http://www.w3.org/2000/09/xmldsig#rsa-sha1. The option is a: java.lang.String type. Default: http://www.w3.org/2001/04/xmldsig-more#rsa-sha256 Group: sign

signatureId

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder signatureId(String signatureId)

Sets the signature Id. If this parameter is not set (null value) then a unique ID is generated for the signature ID (default). If this parameter is set to (empty string) then no Id attribute is created in the signature element. The option is a: java.lang.String type. Group: sign

transformMethods

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder transformMethods(List<Object> transformMethods)

Transforms which are executed on the message body before the digest is calculated. By default, C14n is added and in the case of enveloped signature (see option parentLocalName) also http://www.w3.org/2000/09/xmldsig#enveloped-signature is added at position 0 of the list. Use methods in XmlSignatureHelper to create the transform methods. The option is a: java.util.List<javax.xml.crypto.AlgorithmMethod> type. Group: sign

transformMethods

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder transformMethods(String transformMethods)

Transforms which are executed on the message body before the digest is calculated. By default, C14n is added and in the case of enveloped signature (see option parentLocalName) also http://www.w3.org/2000/09/xmldsig#enveloped-signature is added at position 0 of the list. Use methods in XmlSignatureHelper to create the transform methods. The option will be converted to a java.util.List<javax.xml.crypto.AlgorithmMethod> type. Group: sign

xpathsToIdAttributes

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder xpathsToIdAttributes(List<Object> xpathsToIdAttributes)

Define the elements which are signed in the detached case via XPATH expressions to ID attributes (attributes of type ID). For each element found via the XPATH expression a detached signature is created whose reference URI contains the corresponding attribute value (preceded by '#'). The signature becomes the last sibling of the signed element. Elements with deeper hierarchy level are signed first. You can also set the XPATH list dynamically via the header XmlSignatureConstants#HEADER_XPATHS_TO_ID_ATTRIBUTES . The parameter setParentLocalName(String) or setParentXpath(XPathFilterParameterSpec) for enveloped signature and this parameter for detached signature must not be set in the same configuration. The option is a: java.util.List<javax.xml.crypto.dsig.spec.XPathFilterParameterSpec> type. Group: sign

xpathsToIdAttributes

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder xpathsToIdAttributes(String xpathsToIdAttributes)

Define the elements which are signed in the detached case via XPATH expressions to ID attributes (attributes of type ID). For each element found via the XPATH expression a detached signature is created whose reference URI contains the corresponding attribute value (preceded by '#'). The signature becomes the last sibling of the signed element. Elements with deeper hierarchy level are signed first. You can also set the XPATH list dynamically via the header XmlSignatureConstants#HEADER_XPATHS_TO_ID_ATTRIBUTES . The parameter setParentLocalName(String) or setParentXpath(XPathFilterParameterSpec) for enveloped signature and this parameter for detached signature must not be set in the same configuration. The option will be converted to a java.util.List<javax.xml.crypto.dsig.spec.XPathFilterParameterSpec> type. Group: sign

keySelector

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder keySelector(Object keySelector)

Provides the key for validating the XML signature. The option is a: javax.xml.crypto.KeySelector type. Group: verify

keySelector

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder keySelector(String keySelector)

Provides the key for validating the XML signature. The option will be converted to a javax.xml.crypto.KeySelector type. Group: verify

outputNodeSearch

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder outputNodeSearch(Object outputNodeSearch)

Sets the output node search value for determining the node from the XML signature document which shall be set to the output message body. The class of the value depends on the type of the output node search. The output node search is forwarded to XmlSignature2Message . The option is a: java.lang.Object type. Group: verify

outputNodeSearch

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder outputNodeSearch(String outputNodeSearch)

Sets the output node search value for determining the node from the XML signature document which shall be set to the output message body. The class of the value depends on the type of the output node search. The output node search is forwarded to XmlSignature2Message . The option will be converted to a java.lang.Object type. Group: verify

outputNodeSearchType

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder outputNodeSearchType(String outputNodeSearchType)

Determines the search type for determining the output node which is serialized into the output message bodyF. See setOutputNodeSearch(Object) . The supported default search types you can find in DefaultXmlSignature2Message . The option is a: java.lang.String type. Default: Default Group: verify

removeSignatureElements

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder removeSignatureElements(Boolean removeSignatureElements)

Indicator whether the XML signature elements (elements with local name Signature and namesapce http://www.w3.org/2000/09/xmldsig#) shall be removed from the document set to the output message. Normally, this is only necessary, if the XML signature is enveloped. The default value is Boolean#FALSE . This parameter is forwarded to XmlSignature2Message . This indicator has no effect if the output node search is of type DefaultXmlSignature2Message#OUTPUT_NODE_SEARCH_TYPE_DEFAULT .F. The option is a: java.lang.Boolean type. Default: false Group: verify

removeSignatureElements

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder removeSignatureElements(String removeSignatureElements)

Indicator whether the XML signature elements (elements with local name Signature and namesapce http://www.w3.org/2000/09/xmldsig#) shall be removed from the document set to the output message. Normally, this is only necessary, if the XML signature is enveloped. The default value is Boolean#FALSE . This parameter is forwarded to XmlSignature2Message . This indicator has no effect if the output node search is of type DefaultXmlSignature2Message#OUTPUT_NODE_SEARCH_TYPE_DEFAULT .F. The option will be converted to a java.lang.Boolean type. Default: false Group: verify

secureValidation

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder secureValidation(Boolean secureValidation)

Enables secure validation. If true then secure validation is enabled. The option is a: java.lang.Boolean type. Default: true Group: verify

secureValidation

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder secureValidation(String secureValidation)

Enables secure validation. If true then secure validation is enabled. The option will be converted to a java.lang.Boolean type. Default: true Group: verify

validationFailedHandler

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder validationFailedHandler(Object validationFailedHandler)

Handles the different validation failed situations. The default implementation throws specific exceptions for the different situations (All exceptions have the package name org.apache.camel.component.xmlsecurity.api and are a sub-class of XmlSignatureInvalidException. If the signature value validation fails, a XmlSignatureInvalidValueException is thrown. If a reference validation fails, a XmlSignatureInvalidContentHashException is thrown. For more detailed information, see the JavaDoc. The option is a: org.apache.camel.component.xmlsecurity.api.ValidationFailedHandler type. Group: verify

validationFailedHandler

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder validationFailedHandler(String validationFailedHandler)

Handles the different validation failed situations. The default implementation throws specific exceptions for the different situations (All exceptions have the package name org.apache.camel.component.xmlsecurity.api and are a sub-class of XmlSignatureInvalidException. If the signature value validation fails, a XmlSignatureInvalidValueException is thrown. If a reference validation fails, a XmlSignatureInvalidContentHashException is thrown. For more detailed information, see the JavaDoc. The option will be converted to a org.apache.camel.component.xmlsecurity.api.ValidationFailedHandler type. Group: verify

xmlSignature2Message

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder xmlSignature2Message(Object xmlSignature2Message)

Bean which maps the XML signature to the output-message after the validation. How this mapping should be done can be configured by the options outputNodeSearchType, outputNodeSearch, and removeSignatureElements. The default implementation offers three possibilities which are related to the three output node search types Default, ElementName, and XPath. The default implementation determines a node which is then serialized and set to the body of the output message If the search type is ElementName then the output node (which must be in this case an element) is determined by the local name and namespace defined in the search value (see option outputNodeSearch). If the search type is XPath then the output node is determined by the XPath specified in the search value (in this case the output node can be of type Element, TextNode or Document). If the output node search type is Default then the following rules apply: In the enveloped XML signature case (there is a reference with URI= and transform http://www.w3.org/2000/09/xmldsig#enveloped-signature), the incoming XML document without the Signature element is set to the output message body. In the non-enveloped XML signature case, the message body is determined from a referenced Object; this is explained in more detail in chapter Output Node Determination in Enveloping XML Signature Case. The option is a: org.apache.camel.component.xmlsecurity.api.XmlSignature2Message type. Group: verify

xmlSignature2Message

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder xmlSignature2Message(String xmlSignature2Message)

Bean which maps the XML signature to the output-message after the validation. How this mapping should be done can be configured by the options outputNodeSearchType, outputNodeSearch, and removeSignatureElements. The default implementation offers three possibilities which are related to the three output node search types Default, ElementName, and XPath. The default implementation determines a node which is then serialized and set to the body of the output message If the search type is ElementName then the output node (which must be in this case an element) is determined by the local name and namespace defined in the search value (see option outputNodeSearch). If the search type is XPath then the output node is determined by the XPath specified in the search value (in this case the output node can be of type Element, TextNode or Document). If the output node search type is Default then the following rules apply: In the enveloped XML signature case (there is a reference with URI= and transform http://www.w3.org/2000/09/xmldsig#enveloped-signature), the incoming XML document without the Signature element is set to the output message body. In the non-enveloped XML signature case, the message body is determined from a referenced Object; this is explained in more detail in chapter Output Node Determination in Enveloping XML Signature Case. The option will be converted to a org.apache.camel.component.xmlsecurity.api.XmlSignature2Message type. Group: verify

xmlSignatureChecker

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder xmlSignatureChecker(Object xmlSignatureChecker)

This interface allows the application to check the XML signature before the validation is executed. This step is recommended in http://www.w3.org/TR/xmldsig-bestpractices/#check-what-is-signed. The option is a: org.apache.camel.component.xmlsecurity.api.XmlSignatureChecker type. Group: verify

xmlSignatureChecker

default XmlSignatureEndpointBuilderFactory.XmlSignatureEndpointBuilder xmlSignatureChecker(String xmlSignatureChecker)

This interface allows the application to check the XML signature before the validation is executed. This step is recommended in http://www.w3.org/TR/xmldsig-bestpractices/#check-what-is-signed. The option will be converted to a org.apache.camel.component.xmlsecurity.api.XmlSignatureChecker type. Group: verify