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

Interface CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    All Known Subinterfaces:
    CxfEndpointBuilderFactory.AdvancedCxfEndpointBuilder
    Enclosing interface:
    CxfEndpointBuilderFactory
    public static interface CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Advanced builder for endpoint producers for the CXF component.

    • Method Detail

      • lazyStartProducer

        default CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder 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 (advanced)
        Parameters:
        lazyStartProducer - the value to set
        Returns:
        the dsl builder

      • lazyStartProducer

        default CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder 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 (advanced)
        Parameters:
        lazyStartProducer - the value to set
        Returns:
        the dsl builder

      • synchronous

        default CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder synchronous​(boolean synchronous)
        Sets whether synchronous processing should be strictly used. The option is a: <code>boolean</code> type. Default: false Group: producer (advanced)
        Parameters:
        synchronous - the value to set
        Returns:
        the dsl builder

      • synchronous

        default CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder synchronous​(String synchronous)
        Sets whether synchronous processing should be strictly used. The option will be converted to a <code>boolean</code> type. Default: false Group: producer (advanced)
        Parameters:
        synchronous - the value to set
        Returns:
        the dsl builder

      • allowStreaming

        default CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder 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: <code>java.lang.Boolean</code> type. Group: advanced
        Parameters:
        allowStreaming - the value to set
        Returns:
        the dsl builder

      • allowStreaming

        default CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder 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 <code>java.lang.Boolean</code> type. Group: advanced
        Parameters:
        allowStreaming - the value to set
        Returns:
        the dsl builder

      • continuationTimeout

        default CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder 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: <code>long</code> type. Default: 30000 Group: advanced
        Parameters:
        continuationTimeout - the value to set
        Returns:
        the dsl builder

      • continuationTimeout

        default CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder 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 <code>long</code> type. Default: 30000 Group: advanced
        Parameters:
        continuationTimeout - the value to set
        Returns:
        the dsl builder

      • cxfBinding

        default CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder 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: <code>org.apache.camel.component.cxf.common.CxfBinding</code> type. Group: advanced
        Parameters:
        cxfBinding - the value to set
        Returns:
        the dsl builder

      • cxfBinding

        default CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder 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 <code>org.apache.camel.component.cxf.common.CxfBinding</code> type. Group: advanced
        Parameters:
        cxfBinding - the value to set
        Returns:
        the dsl builder

      • cxfConfigurer

        default CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder 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: <code>org.apache.camel.component.cxf.jaxws.CxfConfigurer</code> type. Group: advanced
        Parameters:
        cxfConfigurer - the value to set
        Returns:
        the dsl builder

      • cxfConfigurer

        default CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder 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 <code>org.apache.camel.component.cxf.jaxws.CxfConfigurer</code> type. Group: advanced
        Parameters:
        cxfConfigurer - the value to set
        Returns:
        the dsl builder

      • defaultBus

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

      • defaultBus

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

      • headerFilterStrategy

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

      • headerFilterStrategy

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

      • mergeProtocolHeaders

        default CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder 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: <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        mergeProtocolHeaders - the value to set
        Returns:
        the dsl builder

      • mergeProtocolHeaders

        default CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder 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 <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        mergeProtocolHeaders - the value to set
        Returns:
        the dsl builder

      • mtomEnabled

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

      • mtomEnabled

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

      • properties

        default CxfEndpointBuilderFactory.AdvancedCxfEndpointProducerBuilder 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: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> 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.AdvancedCxfEndpointProducerBuilder 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: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> 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.AdvancedCxfEndpointProducerBuilder schemaValidationEnabled​(Boolean schemaValidationEnabled)
        Enable schema validation for request and response. Disabled by default for performance reason. The option is a: <code>java.lang.Boolean</code> type. Default: false Group: advanced
        Parameters:
        schemaValidationEnabled - the value to set
        Returns:
        the dsl builder

      • schemaValidationEnabled

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

      • skipPayloadMessagePartCheck

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

      • skipPayloadMessagePartCheck

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