XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder (Camel

All Superinterfaces:

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

Enclosing interface:

XmlVerifierEndpointBuilderFactory
```
public static interface XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
```
Builder for endpoint for the XML Security Verify component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default XmlVerifierEndpointBuilderFactory.AdvancedXmlVerifierEndpointBuilder`	`advanced()`
`default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder`	`baseUri(String baseUri)` You can set a base URI which is used in the URI dereferencing.
`default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder`	`clearHeaders(Boolean clearHeaders)` Determines if the XML signature specific headers be cleared after signing and verification.
`default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder`	`clearHeaders(String clearHeaders)` Determines if the XML signature specific headers be cleared after signing and verification.
`default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder`	`cryptoContextProperties(Map<String,Object> cryptoContextProperties)` Sets the crypto context properties.
`default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder`	`cryptoContextProperties(String cryptoContextProperties)` Sets the crypto context properties.
`default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder`	`disallowDoctypeDecl(Boolean disallowDoctypeDecl)` Disallows that the incoming XML document contains DTD DOCTYPE declaration.
`default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder`	`disallowDoctypeDecl(String disallowDoctypeDecl)` Disallows that the incoming XML document contains DTD DOCTYPE declaration.
`default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder`	`keySelector(Object keySelector)` Provides the key for validating the XML signature.
`default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder`	`keySelector(String keySelector)` Provides the key for validating the XML signature.
`default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder`	`lazyStartProducer(String lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder`	`omitXmlDeclaration(Boolean omitXmlDeclaration)` Indicator whether the XML declaration in the outgoing message body should be omitted.
`default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder`	`omitXmlDeclaration(String omitXmlDeclaration)` Indicator whether the XML declaration in the outgoing message body should be omitted.
`default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder`	`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 XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder`	`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 XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder`	`outputNodeSearchType(String outputNodeSearchType)` Determines the search type for determining the output node which is serialized into the output message bodyF.
`default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder`	`outputXmlEncoding(String outputXmlEncoding)` The character encoding of the resulting signed XML document.
`default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder`	`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 XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder`	`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 XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder`	`schemaResourceUri(String schemaResourceUri)` Classpath to the XML Schema.
`default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder`	`secureValidation(Boolean secureValidation)` Enables secure validation.
`default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder`	`secureValidation(String secureValidation)` Enables secure validation.
`default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder`	`validationFailedHandler(Object validationFailedHandler)` Handles the different validation failed situations.
`default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder`	`validationFailedHandler(String validationFailedHandler)` Handles the different validation failed situations.
`default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder`	`xmlSignature2Message(Object xmlSignature2Message)` Bean which maps the XML signature to the output-message after the validation.
`default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder`	`xmlSignature2Message(String xmlSignature2Message)` Bean which maps the XML signature to the output-message after the validation.
`default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder`	`xmlSignatureChecker(Object xmlSignatureChecker)` This interface allows the application to check the XML signature before the validation is executed.
`default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder`	`xmlSignatureChecker(String xmlSignatureChecker)` This interface allows the application to check the XML signature before the validation is executed.

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

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

- Method Detail
  - advanced
```
default XmlVerifierEndpointBuilderFactory.AdvancedXmlVerifierEndpointBuilder advanced()
```
  - baseUri
```
default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder 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
  - clearHeaders
```
default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder 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
  - clearHeaders
```
default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder 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: producer
  - cryptoContextProperties
```
default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder 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<java.lang.String, java.lang.Object> type. Group: producer
  - cryptoContextProperties
```
default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder 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 java.util.Map<java.lang.String, java.lang.Object> type. Group: producer
  - disallowDoctypeDecl
```
default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder 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
  - disallowDoctypeDecl
```
default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder 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: producer
  - keySelector
```
default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder keySelector(Object keySelector)
```
    Provides the key for validating the XML signature. The option is a: javax.xml.crypto.KeySelector type. Group: producer
  - keySelector
```
default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder keySelector(String keySelector)
```
    Provides the key for validating the XML signature. The option will be converted to a javax.xml.crypto.KeySelector type. Group: producer
  - lazyStartProducer
```
default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder 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 XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder 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
  - omitXmlDeclaration
```
default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder 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
  - omitXmlDeclaration
```
default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder 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: producer
  - outputNodeSearch
```
default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder 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: producer
  - outputNodeSearch
```
default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder 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: producer
  - outputNodeSearchType
```
default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder 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: producer
  - outputXmlEncoding
```
default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder 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
  - removeSignatureElements
```
default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder 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: producer
  - removeSignatureElements
```
default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder 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: producer
  - schemaResourceUri
```
default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder 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
  - secureValidation
```
default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder secureValidation(Boolean secureValidation)
```
    Enables secure validation. If true then secure validation is enabled. The option is a: java.lang.Boolean type. Default: true Group: producer
  - secureValidation
```
default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder 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: producer
  - validationFailedHandler
```
default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder 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: producer
  - validationFailedHandler
```
default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder 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: producer
  - xmlSignature2Message
```
default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder 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: producer
  - xmlSignature2Message
```
default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder 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: producer
  - xmlSignatureChecker
```
default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder 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: producer
  - xmlSignatureChecker
```
default XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder 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: producer

Interface XmlVerifierEndpointBuilderFactory.XmlVerifierEndpointBuilder

Method Summary

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

Methods inherited from interface org.apache.camel.EndpointProducerResolver

Method Detail

advanced

baseUri

clearHeaders

clearHeaders

cryptoContextProperties

cryptoContextProperties

disallowDoctypeDecl

disallowDoctypeDecl

keySelector

keySelector

lazyStartProducer

lazyStartProducer

omitXmlDeclaration

omitXmlDeclaration

outputNodeSearch

outputNodeSearch

outputNodeSearchType

outputXmlEncoding

removeSignatureElements

removeSignatureElements

schemaResourceUri

secureValidation

secureValidation

validationFailedHandler

validationFailedHandler

xmlSignature2Message

xmlSignature2Message

xmlSignatureChecker

xmlSignatureChecker