XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder (Camel

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.xmlsecurity.XmlSignerComponent>

All Known Implementing Classes:

XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilderImpl

Enclosing interface:

XmlsecuritySignComponentBuilderFactory
```
public static interface XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder
extends ComponentBuilder<org.apache.camel.component.xmlsecurity.XmlSignerComponent>
```
Builder for the XML Security Sign component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder`	`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 XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder`	`baseUri(String baseUri)` You can set a base URI which is used in the URI dereferencing.
`default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder`	`basicPropertyBinding(boolean basicPropertyBinding)` Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities.
`default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder`	`canonicalizationMethod(AlgorithmMethod canonicalizationMethod)` Canonicalization method used to canonicalize the SignedInfo element before the digest is calculated.
`default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder`	`clearHeaders(Boolean clearHeaders)` Determines if the XML signature specific headers be cleared after signing and verification.
`default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder`	`contentObjectId(String contentObjectId)` Sets the content object Id attribute value.
`default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder`	`contentReferenceType(String contentReferenceType)` Type of the content reference.
`default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder`	`contentReferenceUri(String contentReferenceUri)` Reference URI for the content to be signed.
`default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder`	`cryptoContextProperties(Map<String,Object> cryptoContextProperties)` Sets the crypto context properties.
`default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder`	`digestAlgorithm(String digestAlgorithm)` Digest algorithm URI.
`default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder`	`disallowDoctypeDecl(Boolean disallowDoctypeDecl)` Disallows that the incoming XML document contains DTD DOCTYPE declaration.
`default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder`	`keyAccessor(org.apache.camel.component.xmlsecurity.api.KeyAccessor keyAccessor)` For the signing process, a private key is necessary.
`default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder`	`omitXmlDeclaration(Boolean omitXmlDeclaration)` Indicator whether the XML declaration in the outgoing message body should be omitted.
`default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder`	`outputXmlEncoding(String outputXmlEncoding)` The character encoding of the resulting signed XML document.
`default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder`	`parentLocalName(String parentLocalName)` Local name of the parent element to which the XML signature element will be added.
`default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder`	`parentNamespace(String parentNamespace)` Namespace of the parent element to which the XML signature element will be added.
`default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder`	`parentXpath(XPathFilterParameterSpec parentXpath)` Sets the XPath to find the parent node in the enveloped case.
`default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder`	`plainText(Boolean plainText)` Indicator whether the message body contains plain text.
`default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder`	`plainTextEncoding(String plainTextEncoding)` Encoding of the plain text.
`default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder`	`prefixForXmlSignatureNamespace(String prefixForXmlSignatureNamespace)` Namespace prefix for the XML signature namespace http://www.w3.org/2000/09/xmldsig#.
`default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder`	`properties(org.apache.camel.component.xmlsecurity.api.XmlSignatureProperties 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 XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder`	`schemaResourceUri(String schemaResourceUri)` Classpath to the XML Schema.
`default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder`	`signatureAlgorithm(String signatureAlgorithm)` Signature algorithm.
`default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder`	`signatureId(String signatureId)` Sets the signature Id.
`default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder`	`signerConfiguration(org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration signerConfiguration)` To use a shared XmlSignerConfiguration configuration to use as base for configuring endpoints.
`default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder`	`transformMethods(List<AlgorithmMethod> transformMethods)` Transforms which are executed on the message body before the digest is calculated.
`default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder`	`uriDereferencer(URIDereferencer uriDereferencer)` If you want to restrict the remote access via reference URIs, you can set an own dereferencer.
`default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder`	`xpathsToIdAttributes(List<XPathFilterParameterSpec> 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.component.ComponentBuilder
build, build, doSetProperty, register

- Method Detail
  - addKeyInfoReference
```
default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder 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: producer
  - baseUri
```
default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder 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: producer
  - canonicalizationMethod
```
default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder canonicalizationMethod(AlgorithmMethod 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: producer
  - clearHeaders
```
default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder 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: producer
  - contentObjectId
```
default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder 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: producer
  - contentReferenceType
```
default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder 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: producer
  - contentReferenceUri
```
default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder 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: producer
  - cryptoContextProperties
```
default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder 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: java.util.Map type. Group: producer
  - digestAlgorithm
```
default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder 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: producer
  - disallowDoctypeDecl
```
default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder 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: producer
  - keyAccessor
```
default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder keyAccessor(org.apache.camel.component.xmlsecurity.api.KeyAccessor 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: producer
  - lazyStartProducer
```
default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder 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
  - omitXmlDeclaration
```
default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder 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: producer
  - outputXmlEncoding
```
default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder 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: producer
  - parentLocalName
```
default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder 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: producer
  - parentNamespace
```
default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder 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: producer
  - parentXpath
```
default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder parentXpath(XPathFilterParameterSpec 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: producer
  - plainText
```
default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder 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: producer
  - plainTextEncoding
```
default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder 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: producer
  - prefixForXmlSignatureNamespace
```
default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder 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: producer
  - properties
```
default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder properties(org.apache.camel.component.xmlsecurity.api.XmlSignatureProperties 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: producer
  - schemaResourceUri
```
default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder 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: producer
  - signatureAlgorithm
```
default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder 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: producer
  - signatureId
```
default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder 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: producer
  - transformMethods
```
default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder transformMethods(List<AlgorithmMethod> 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 type. Group: producer
  - xpathsToIdAttributes
```
default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder xpathsToIdAttributes(List<XPathFilterParameterSpec> 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 type. Group: producer
  - basicPropertyBinding
```
default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder basicPropertyBinding(boolean basicPropertyBinding)
```
    Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities. The option is a: boolean type. Default: false Group: advanced
  - signerConfiguration
```
default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder signerConfiguration(org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration signerConfiguration)
```
    To use a shared XmlSignerConfiguration configuration to use as base for configuring endpoints. The option is a: org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration type. Group: advanced
  - uriDereferencer
```
default XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder uriDereferencer(URIDereferencer uriDereferencer)
```
    If you want to restrict the remote access via reference URIs, you can set an own dereferencer. Optional parameter. If not set the provider default dereferencer is used which can resolve URI fragments, HTTP, file and XPpointer URIs. Attention: The implementation is provider dependent!. The option is a: javax.xml.crypto.URIDereferencer type. Group: advanced

Interface XmlsecuritySignComponentBuilderFactory.XmlsecuritySignComponentBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

Method Detail

addKeyInfoReference

baseUri

canonicalizationMethod

clearHeaders

contentObjectId

contentReferenceType

contentReferenceUri

cryptoContextProperties

digestAlgorithm

disallowDoctypeDecl

keyAccessor

lazyStartProducer

omitXmlDeclaration

outputXmlEncoding

parentLocalName

parentNamespace

parentXpath

plainText

plainTextEncoding

prefixForXmlSignatureNamespace

properties

schemaResourceUri

signatureAlgorithm

signatureId

transformMethods

xpathsToIdAttributes

basicPropertyBinding

signerConfiguration

uriDereferencer