Package org.apache.camel.builder.endpoint.dsl

Interface CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder
Enclosing interface:
CxfEndpointBuilderFactory
public static interface CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Advanced builder for endpoint consumers for the CXF component.

  • Method Details

    • basic

      default CxfEndpointBuilderFactory.CxfEndpointConsumerBuilder basic()

    • bridgeErrorHandler

      default CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: boolean type. Default: false Group: consumer (advanced)
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder bridgeErrorHandler(String bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a boolean type. Default: false Group: consumer (advanced)
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • exceptionHandler

      default CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler)
      To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)
      Parameters:
      exceptionHandler - the value to set
      Returns:
      the dsl builder

    • exceptionHandler

      default CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder exceptionHandler(String exceptionHandler)
      To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)
      Parameters:
      exceptionHandler - the value to set
      Returns:
      the dsl builder

    • exchangePattern

      default CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder exchangePattern(org.apache.camel.ExchangePattern exchangePattern)
      Sets the exchange pattern when the consumer creates an exchange. The option is a: org.apache.camel.ExchangePattern type. Group: consumer (advanced)
      Parameters:
      exchangePattern - the value to set
      Returns:
      the dsl builder

    • exchangePattern

      default CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder exchangePattern(String exchangePattern)
      Sets the exchange pattern when the consumer creates an exchange. The option will be converted to a org.apache.camel.ExchangePattern type. Group: consumer (advanced)
      Parameters:
      exchangePattern - the value to set
      Returns:
      the dsl builder

    • allowStreaming

      default CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder allowStreaming(Boolean allowStreaming)
      This option controls whether the CXF component, when running in PAYLOAD mode, will DOM parse the incoming messages into DOM Elements or keep the payload as a javax.xml.transform.Source object that would allow streaming in some cases. The option is a: java.lang.Boolean type. Group: advanced
      Parameters:
      allowStreaming - the value to set
      Returns:
      the dsl builder

    • allowStreaming

      default CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder allowStreaming(String allowStreaming)
      This option controls whether the CXF component, when running in PAYLOAD mode, will DOM parse the incoming messages into DOM Elements or keep the payload as a javax.xml.transform.Source object that would allow streaming in some cases. The option will be converted to a java.lang.Boolean type. Group: advanced
      Parameters:
      allowStreaming - the value to set
      Returns:
      the dsl builder

    • bus

      default CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder bus(org.apache.cxf.Bus bus)
      To use a custom configured CXF Bus. The option is a: org.apache.cxf.Bus type. Group: advanced
      Parameters:
      bus - the value to set
      Returns:
      the dsl builder

    • bus

      default CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder bus(String bus)
      To use a custom configured CXF Bus. The option will be converted to a org.apache.cxf.Bus type. Group: advanced
      Parameters:
      bus - the value to set
      Returns:
      the dsl builder

    • continuationTimeout

      default CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder continuationTimeout(long continuationTimeout)
      This option is used to set the CXF continuation timeout which could be used in CxfConsumer by default when the CXF server is using Jetty or Servlet transport. The option is a: long type. Default: 30000 Group: advanced
      Parameters:
      continuationTimeout - the value to set
      Returns:
      the dsl builder

    • continuationTimeout

      default CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder continuationTimeout(String continuationTimeout)
      This option is used to set the CXF continuation timeout which could be used in CxfConsumer by default when the CXF server is using Jetty or Servlet transport. The option will be converted to a long type. Default: 30000 Group: advanced
      Parameters:
      continuationTimeout - the value to set
      Returns:
      the dsl builder

    • cxfBinding

      default CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder cxfBinding(org.apache.camel.component.cxf.common.CxfBinding cxfBinding)
      To use a custom CxfBinding to control the binding between Camel Message and CXF Message. The option is a: org.apache.camel.component.cxf.common.CxfBinding type. Group: advanced
      Parameters:
      cxfBinding - the value to set
      Returns:
      the dsl builder

    • cxfBinding

      default CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder cxfBinding(String cxfBinding)
      To use a custom CxfBinding to control the binding between Camel Message and CXF Message. The option will be converted to a org.apache.camel.component.cxf.common.CxfBinding type. Group: advanced
      Parameters:
      cxfBinding - the value to set
      Returns:
      the dsl builder

    • cxfConfigurer

      default CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder cxfConfigurer(org.apache.camel.component.cxf.jaxws.CxfConfigurer cxfConfigurer)
      This option could apply the implementation of org.apache.camel.component.cxf.CxfEndpointConfigurer which supports to configure the CXF endpoint in programmatic way. User can configure the CXF server and client by implementing configure{ServerClient} method of CxfEndpointConfigurer. The option is a: org.apache.camel.component.cxf.jaxws.CxfConfigurer type. Group: advanced
      Parameters:
      cxfConfigurer - the value to set
      Returns:
      the dsl builder

    • cxfConfigurer

      default CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder cxfConfigurer(String cxfConfigurer)
      This option could apply the implementation of org.apache.camel.component.cxf.CxfEndpointConfigurer which supports to configure the CXF endpoint in programmatic way. User can configure the CXF server and client by implementing configure{ServerClient} method of CxfEndpointConfigurer. The option will be converted to a org.apache.camel.component.cxf.jaxws.CxfConfigurer type. Group: advanced
      Parameters:
      cxfConfigurer - the value to set
      Returns:
      the dsl builder

    • defaultBus

      default CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder defaultBus(boolean defaultBus)
      Will set the default bus when CXF endpoint create a bus by itself. The option is a: boolean type. Default: false Group: advanced
      Parameters:
      defaultBus - the value to set
      Returns:
      the dsl builder

    • defaultBus

      default CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder defaultBus(String defaultBus)
      Will set the default bus when CXF endpoint create a bus by itself. The option will be converted to a boolean type. Default: false Group: advanced
      Parameters:
      defaultBus - the value to set
      Returns:
      the dsl builder

    • headerFilterStrategy

      default CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
      To use a custom HeaderFilterStrategy to filter header to and from Camel message. The option is a: org.apache.camel.spi.HeaderFilterStrategy type. Group: advanced
      Parameters:
      headerFilterStrategy - the value to set
      Returns:
      the dsl builder

    • headerFilterStrategy

      default CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder headerFilterStrategy(String headerFilterStrategy)
      To use a custom HeaderFilterStrategy to filter header to and from Camel message. The option will be converted to a org.apache.camel.spi.HeaderFilterStrategy type. Group: advanced
      Parameters:
      headerFilterStrategy - the value to set
      Returns:
      the dsl builder

    • mergeProtocolHeaders

      default CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder mergeProtocolHeaders(boolean mergeProtocolHeaders)
      Whether to merge protocol headers. If enabled then propagating headers between Camel and CXF becomes more consistent and similar. For more details see CAMEL-6393. The option is a: boolean type. Default: false Group: advanced
      Parameters:
      mergeProtocolHeaders - the value to set
      Returns:
      the dsl builder

    • mergeProtocolHeaders

      default CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder mergeProtocolHeaders(String mergeProtocolHeaders)
      Whether to merge protocol headers. If enabled then propagating headers between Camel and CXF becomes more consistent and similar. For more details see CAMEL-6393. The option will be converted to a boolean type. Default: false Group: advanced
      Parameters:
      mergeProtocolHeaders - the value to set
      Returns:
      the dsl builder

    • mtomEnabled

      default CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder mtomEnabled(boolean mtomEnabled)
      To enable MTOM (attachments). This requires to use POJO or PAYLOAD data format mode. The option is a: boolean type. Default: false Group: advanced
      Parameters:
      mtomEnabled - the value to set
      Returns:
      the dsl builder

    • mtomEnabled

      default CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder mtomEnabled(String mtomEnabled)
      To enable MTOM (attachments). This requires to use POJO or PAYLOAD data format mode. The option will be converted to a boolean type. Default: false Group: advanced
      Parameters:
      mtomEnabled - the value to set
      Returns:
      the dsl builder

    • properties

      default CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder properties(String key, Object value)
      To set additional CXF options using the key/value pairs from the Map. For example to turn on stacktraces in SOAP faults, properties.faultStackTraceEnabled=true. The option is a: java.util.Map<java.lang.String, java.lang.Object> type. The option is multivalued, and you can use the properties(String, Object) method to add a value (call the method multiple times to set more values). Group: advanced
      Parameters:
      key - the option key
      value - the option value
      Returns:
      the dsl builder

    • properties

      default CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder properties(Map values)
      To set additional CXF options using the key/value pairs from the Map. For example to turn on stacktraces in SOAP faults, properties.faultStackTraceEnabled=true. The option is a: java.util.Map<java.lang.String, java.lang.Object> type. The option is multivalued, and you can use the properties(String, Object) method to add a value (call the method multiple times to set more values). Group: advanced
      Parameters:
      values - the values
      Returns:
      the dsl builder

    • schemaValidationEnabled

      default CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder schemaValidationEnabled(Boolean schemaValidationEnabled)
      Enable schema validation for request and response. Disabled by default for performance reason. The option is a: java.lang.Boolean type. Default: false Group: advanced
      Parameters:
      schemaValidationEnabled - the value to set
      Returns:
      the dsl builder

    • schemaValidationEnabled

      default CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder schemaValidationEnabled(String schemaValidationEnabled)
      Enable schema validation for request and response. Disabled by default for performance reason. The option will be converted to a java.lang.Boolean type. Default: false Group: advanced
      Parameters:
      schemaValidationEnabled - the value to set
      Returns:
      the dsl builder

    • skipPayloadMessagePartCheck

      default CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder skipPayloadMessagePartCheck(boolean skipPayloadMessagePartCheck)
      Sets whether SOAP message validation should be disabled. The option is a: boolean type. Default: false Group: advanced
      Parameters:
      skipPayloadMessagePartCheck - the value to set
      Returns:
      the dsl builder

    • skipPayloadMessagePartCheck

      default CxfEndpointBuilderFactory.AdvancedCxfEndpointConsumerBuilder skipPayloadMessagePartCheck(String skipPayloadMessagePartCheck)
      Sets whether SOAP message validation should be disabled. The option will be converted to a boolean type. Default: false Group: advanced
      Parameters:
      skipPayloadMessagePartCheck - the value to set
      Returns:
      the dsl builder