XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder (Camel

All Superinterfaces:

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

Enclosing interface:

XmlSignerEndpointBuilderFactory
```
public static interface XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
```
Builder for endpoint for the XML Security Sign component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`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 XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`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 XmlSignerEndpointBuilderFactory.AdvancedXmlSignerEndpointBuilder`	`advanced()`
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`baseUri(String baseUri)` You can set a base URI which is used in the URI dereferencing.
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`canonicalizationMethod(Object canonicalizationMethod)` Canonicalization method used to canonicalize the SignedInfo element before the digest is calculated.
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`canonicalizationMethod(String canonicalizationMethod)` Canonicalization method used to canonicalize the SignedInfo element before the digest is calculated.
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`clearHeaders(Boolean clearHeaders)` Determines if the XML signature specific headers be cleared after signing and verification.
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`clearHeaders(String clearHeaders)` Determines if the XML signature specific headers be cleared after signing and verification.
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`contentObjectId(String contentObjectId)` Sets the content object Id attribute value.
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`contentReferenceType(String contentReferenceType)` Type of the content reference.
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`contentReferenceUri(String contentReferenceUri)` Reference URI for the content to be signed.
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`cryptoContextProperties(Map<String,Object> cryptoContextProperties)` Sets the crypto context properties.
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`cryptoContextProperties(String cryptoContextProperties)` Sets the crypto context properties.
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`digestAlgorithm(String digestAlgorithm)` Digest algorithm URI.
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`disallowDoctypeDecl(Boolean disallowDoctypeDecl)` Disallows that the incoming XML document contains DTD DOCTYPE declaration.
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`disallowDoctypeDecl(String disallowDoctypeDecl)` Disallows that the incoming XML document contains DTD DOCTYPE declaration.
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`keyAccessor(Object keyAccessor)` For the signing process, a private key is necessary.
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`keyAccessor(String keyAccessor)` For the signing process, a private key is necessary.
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`lazyStartProducer(String lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`omitXmlDeclaration(Boolean omitXmlDeclaration)` Indicator whether the XML declaration in the outgoing message body should be omitted.
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`omitXmlDeclaration(String omitXmlDeclaration)` Indicator whether the XML declaration in the outgoing message body should be omitted.
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`outputXmlEncoding(String outputXmlEncoding)` The character encoding of the resulting signed XML document.
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`parentLocalName(String parentLocalName)` Local name of the parent element to which the XML signature element will be added.
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`parentNamespace(String parentNamespace)` Namespace of the parent element to which the XML signature element will be added.
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`parentXpath(Object parentXpath)` Sets the XPath to find the parent node in the enveloped case.
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`parentXpath(String parentXpath)` Sets the XPath to find the parent node in the enveloped case.
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`plainText(Boolean plainText)` Indicator whether the message body contains plain text.
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`plainText(String plainText)` Indicator whether the message body contains plain text.
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`plainTextEncoding(String plainTextEncoding)` Encoding of the plain text.
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`prefixForXmlSignatureNamespace(String prefixForXmlSignatureNamespace)` Namespace prefix for the XML signature namespace http://www.w3.org/2000/09/xmldsig#.
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`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 XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`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 XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`schemaResourceUri(String schemaResourceUri)` Classpath to the XML Schema.
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`signatureAlgorithm(String signatureAlgorithm)` Signature algorithm.
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`signatureId(String signatureId)` Sets the signature Id.
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`transformMethods(List<Object> transformMethods)` Transforms which are executed on the message body before the digest is calculated.
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`transformMethods(String transformMethods)` Transforms which are executed on the message body before the digest is calculated.
`default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`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 XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder`	`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
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver
resolve, resolve

- Method Detail
  - advanced
```
default XmlSignerEndpointBuilderFactory.AdvancedXmlSignerEndpointBuilder advanced()
```
  - addKeyInfoReference
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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: <code>java.lang.Boolean</code> type. Default: true Group: producer
    
    Parameters:
    
    addKeyInfoReference - the value to set
    
    Returns:
    
    the dsl builder
  - addKeyInfoReference
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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 <code>java.lang.Boolean</code> type. Default: true Group: producer
    
    Parameters:
    
    addKeyInfoReference - the value to set
    
    Returns:
    
    the dsl builder
  - baseUri
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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: <code>java.lang.String</code> type. Group: producer
    
    Parameters:
    
    baseUri - the value to set
    
    Returns:
    
    the dsl builder
  - canonicalizationMethod
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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: <code>javax.xml.crypto.AlgorithmMethod</code> type. Default: http://www.w3.org/TR/2001/REC-xml-c14n-20010315 Group: producer
    
    Parameters:
    
    canonicalizationMethod - the value to set
    
    Returns:
    
    the dsl builder
  - canonicalizationMethod
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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 <code>javax.xml.crypto.AlgorithmMethod</code> type. Default: http://www.w3.org/TR/2001/REC-xml-c14n-20010315 Group: producer
    
    Parameters:
    
    canonicalizationMethod - the value to set
    
    Returns:
    
    the dsl builder
  - clearHeaders
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder clearHeaders(Boolean clearHeaders)
```
    Determines if the XML signature specific headers be cleared after signing and verification. Defaults to true. The option is a: <code>java.lang.Boolean</code> type. Default: true Group: producer
    
    Parameters:
    
    clearHeaders - the value to set
    
    Returns:
    
    the dsl builder
  - clearHeaders
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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 <code>java.lang.Boolean</code> type. Default: true Group: producer
    
    Parameters:
    
    clearHeaders - the value to set
    
    Returns:
    
    the dsl builder
  - contentObjectId
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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: <code>java.lang.String</code> type. Group: producer
    
    Parameters:
    
    contentObjectId - the value to set
    
    Returns:
    
    the dsl builder
  - contentReferenceType
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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: <code>java.lang.String</code> type. Group: producer
    
    Parameters:
    
    contentReferenceType - the value to set
    
    Returns:
    
    the dsl builder
  - contentReferenceUri
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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: <code>java.lang.String</code> type. Group: producer
    
    Parameters:
    
    contentReferenceUri - the value to set
    
    Returns:
    
    the dsl builder
  - cryptoContextProperties
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder cryptoContextProperties(Map<String,Object> cryptoContextProperties)
```
    Sets the crypto context properties. See {link 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: <code>java.util.Map<java.lang.String, java.lang.Object></code> type. Group: producer
    
    Parameters:
    
    cryptoContextProperties - the value to set
    
    Returns:
    
    the dsl builder
  - cryptoContextProperties
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder cryptoContextProperties(String cryptoContextProperties)
```
    Sets the crypto context properties. See {link 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 <code>java.util.Map<java.lang.String, java.lang.Object></code> type. Group: producer
    
    Parameters:
    
    cryptoContextProperties - the value to set
    
    Returns:
    
    the dsl builder
  - digestAlgorithm
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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: <code>java.lang.String</code> type. Group: producer
    
    Parameters:
    
    digestAlgorithm - the value to set
    
    Returns:
    
    the dsl builder
  - disallowDoctypeDecl
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder disallowDoctypeDecl(Boolean disallowDoctypeDecl)
```
    Disallows that the incoming XML document contains DTD DOCTYPE declaration. The default value is Boolean#TRUE. The option is a: <code>java.lang.Boolean</code> type. Default: true Group: producer
    
    Parameters:
    
    disallowDoctypeDecl - the value to set
    
    Returns:
    
    the dsl builder
  - disallowDoctypeDecl
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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 <code>java.lang.Boolean</code> type. Default: true Group: producer
    
    Parameters:
    
    disallowDoctypeDecl - the value to set
    
    Returns:
    
    the dsl builder
  - keyAccessor
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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: <code>org.apache.camel.component.xmlsecurity.api.KeyAccessor</code> type. Group: producer
    
    Parameters:
    
    keyAccessor - the value to set
    
    Returns:
    
    the dsl builder
  - keyAccessor
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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 <code>org.apache.camel.component.xmlsecurity.api.KeyAccessor</code> type. Group: producer
    
    Parameters:
    
    keyAccessor - the value to set
    
    Returns:
    
    the dsl builder
  - lazyStartProducer
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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 XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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
  - omitXmlDeclaration
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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: <code>java.lang.Boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    omitXmlDeclaration - the value to set
    
    Returns:
    
    the dsl builder
  - omitXmlDeclaration
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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 <code>java.lang.Boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    omitXmlDeclaration - the value to set
    
    Returns:
    
    the dsl builder
  - outputXmlEncoding
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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: <code>java.lang.String</code> type. Group: producer
    
    Parameters:
    
    outputXmlEncoding - the value to set
    
    Returns:
    
    the dsl builder
  - parentLocalName
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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: <code>java.lang.String</code> type. Group: producer
    
    Parameters:
    
    parentLocalName - the value to set
    
    Returns:
    
    the dsl builder
  - parentNamespace
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder parentNamespace(String parentNamespace)
```
    Namespace of the parent element to which the XML signature element will be added. The option is a: <code>java.lang.String</code> type. Group: producer
    
    Parameters:
    
    parentNamespace - the value to set
    
    Returns:
    
    the dsl builder
  - parentXpath
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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: <code>javax.xml.crypto.dsig.spec.XPathFilterParameterSpec</code> type. Group: producer
    
    Parameters:
    
    parentXpath - the value to set
    
    Returns:
    
    the dsl builder
  - parentXpath
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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 <code>javax.xml.crypto.dsig.spec.XPathFilterParameterSpec</code> type. Group: producer
    
    Parameters:
    
    parentXpath - the value to set
    
    Returns:
    
    the dsl builder
  - plainText
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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: <code>java.lang.Boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    plainText - the value to set
    
    Returns:
    
    the dsl builder
  - plainText
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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 <code>java.lang.Boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    plainText - the value to set
    
    Returns:
    
    the dsl builder
  - plainTextEncoding
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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: <code>java.lang.String</code> type. Default: UTF-8 Group: producer
    
    Parameters:
    
    plainTextEncoding - the value to set
    
    Returns:
    
    the dsl builder
  - prefixForXmlSignatureNamespace
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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: <code>java.lang.String</code> type. Default: ds Group: producer
    
    Parameters:
    
    prefixForXmlSignatureNamespace - the value to set
    
    Returns:
    
    the dsl builder
  - properties
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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: <code>org.apache.camel.component.xmlsecurity.api.XmlSignatureProperties</code> type. Group: producer
    
    Parameters:
    
    properties - the value to set
    
    Returns:
    
    the dsl builder
  - properties
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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 <code>org.apache.camel.component.xmlsecurity.api.XmlSignatureProperties</code> type. Group: producer
    
    Parameters:
    
    properties - the value to set
    
    Returns:
    
    the dsl builder
  - schemaResourceUri
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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: <code>java.lang.String</code> type. Group: producer
    
    Parameters:
    
    schemaResourceUri - the value to set
    
    Returns:
    
    the dsl builder
  - signatureAlgorithm
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder signatureAlgorithm(String signatureAlgorithm)
```
    Signature algorithm. Default value is http://www.w3.org/2000/09/xmldsig#rsa-sha1. The option is a: <code>java.lang.String</code> type. Default: http://www.w3.org/2001/04/xmldsig-more#rsa-sha256 Group: producer
    
    Parameters:
    
    signatureAlgorithm - the value to set
    
    Returns:
    
    the dsl builder
  - signatureId
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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: <code>java.lang.String</code> type. Group: producer
    
    Parameters:
    
    signatureId - the value to set
    
    Returns:
    
    the dsl builder
  - transformMethods
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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: <code>java.util.List<javax.xml.crypto.AlgorithmMethod></code> type. Group: producer
    
    Parameters:
    
    transformMethods - the value to set
    
    Returns:
    
    the dsl builder
  - transformMethods
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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 <code>java.util.List<javax.xml.crypto.AlgorithmMethod></code> type. Group: producer
    
    Parameters:
    
    transformMethods - the value to set
    
    Returns:
    
    the dsl builder
  - xpathsToIdAttributes
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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: <code>java.util.List<javax.xml.crypto.dsig.spec.XPathFilterParameterSpec></code> type. Group: producer
    
    Parameters:
    
    xpathsToIdAttributes - the value to set
    
    Returns:
    
    the dsl builder
  - xpathsToIdAttributes
```
default XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder 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 <code>java.util.List<javax.xml.crypto.dsig.spec.XPathFilterParameterSpec></code> type. Group: producer
    
    Parameters:
    
    xpathsToIdAttributes - the value to set
    
    Returns:
    
    the dsl builder

Interface XmlSignerEndpointBuilderFactory.XmlSignerEndpointBuilder

Method Summary

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

Methods inherited from interface org.apache.camel.EndpointProducerResolver

Method Detail

advanced

addKeyInfoReference

addKeyInfoReference

baseUri

canonicalizationMethod

canonicalizationMethod

clearHeaders

clearHeaders

contentObjectId

contentReferenceType

contentReferenceUri

cryptoContextProperties

cryptoContextProperties

digestAlgorithm

disallowDoctypeDecl

disallowDoctypeDecl

keyAccessor

keyAccessor

lazyStartProducer

lazyStartProducer

omitXmlDeclaration

omitXmlDeclaration

outputXmlEncoding

parentLocalName

parentNamespace

parentXpath

parentXpath

plainText

plainText

plainTextEncoding

prefixForXmlSignatureNamespace

properties

properties

schemaResourceUri

signatureAlgorithm

signatureId

transformMethods

transformMethods

xpathsToIdAttributes

xpathsToIdAttributes