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

Interface CxfEndpointBuilderFactory.CxfEndpointConsumerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    All Known Subinterfaces:
    CxfEndpointBuilderFactory.CxfEndpointBuilder
    Enclosing interface:
    CxfEndpointBuilderFactory
    public static interface CxfEndpointBuilderFactory.CxfEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
    Builder for endpoint consumers for the CXF component.

    • Method Detail

      • dataFormat

        default CxfEndpointBuilderFactory.CxfEndpointConsumerBuilder dataFormat​(String dataFormat)
        The data type messages supported by the CXF endpoint. The option will be converted to a <code>org.apache.camel.component.cxf.DataFormat</code> type. Default: POJO Group: common
        Parameters:
        dataFormat - the value to set
        Returns:
        the dsl builder

      • wrappedStyle

        default CxfEndpointBuilderFactory.CxfEndpointConsumerBuilder wrappedStyle​(Boolean wrappedStyle)
        The WSDL style that describes how parameters are represented in the SOAP body. If the value is false, CXF will chose the document-literal unwrapped style, If the value is true, CXF will chose the document-literal wrapped style. The option is a: <code>java.lang.Boolean</code> type. Group: common
        Parameters:
        wrappedStyle - the value to set
        Returns:
        the dsl builder

      • wrappedStyle

        default CxfEndpointBuilderFactory.CxfEndpointConsumerBuilder wrappedStyle​(String wrappedStyle)
        The WSDL style that describes how parameters are represented in the SOAP body. If the value is false, CXF will chose the document-literal unwrapped style, If the value is true, CXF will chose the document-literal wrapped style. The option will be converted to a <code>java.lang.Boolean</code> type. Group: common
        Parameters:
        wrappedStyle - the value to set
        Returns:
        the dsl builder

      • bridgeErrorHandler

        default CxfEndpointBuilderFactory.CxfEndpointConsumerBuilder bridgeErrorHandler​(boolean bridgeErrorHandler)
        Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        bridgeErrorHandler - the value to set
        Returns:
        the dsl builder

      • bridgeErrorHandler

        default CxfEndpointBuilderFactory.CxfEndpointConsumerBuilder bridgeErrorHandler​(String bridgeErrorHandler)
        Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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 <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        bridgeErrorHandler - the value to set
        Returns:
        the dsl builder

      • loggingFeatureEnabled

        default CxfEndpointBuilderFactory.CxfEndpointConsumerBuilder loggingFeatureEnabled​(boolean loggingFeatureEnabled)
        This option enables CXF Logging Feature which writes inbound and outbound SOAP messages to log. The option is a: <code>boolean</code> type. Default: false Group: logging
        Parameters:
        loggingFeatureEnabled - the value to set
        Returns:
        the dsl builder

      • loggingFeatureEnabled

        default CxfEndpointBuilderFactory.CxfEndpointConsumerBuilder loggingFeatureEnabled​(String loggingFeatureEnabled)
        This option enables CXF Logging Feature which writes inbound and outbound SOAP messages to log. The option will be converted to a <code>boolean</code> type. Default: false Group: logging
        Parameters:
        loggingFeatureEnabled - the value to set
        Returns:
        the dsl builder

      • loggingSizeLimit

        default CxfEndpointBuilderFactory.CxfEndpointConsumerBuilder loggingSizeLimit​(int loggingSizeLimit)
        To limit the total size of number of bytes the logger will output when logging feature has been enabled and -1 for no limit. The option is a: <code>int</code> type. Default: 49152 Group: logging
        Parameters:
        loggingSizeLimit - the value to set
        Returns:
        the dsl builder

      • loggingSizeLimit

        default CxfEndpointBuilderFactory.CxfEndpointConsumerBuilder loggingSizeLimit​(String loggingSizeLimit)
        To limit the total size of number of bytes the logger will output when logging feature has been enabled and -1 for no limit. The option will be converted to a <code>int</code> type. Default: 49152 Group: logging
        Parameters:
        loggingSizeLimit - the value to set
        Returns:
        the dsl builder

      • skipFaultLogging

        default CxfEndpointBuilderFactory.CxfEndpointConsumerBuilder skipFaultLogging​(boolean skipFaultLogging)
        This option controls whether the PhaseInterceptorChain skips logging the Fault that it catches. The option is a: <code>boolean</code> type. Default: false Group: logging
        Parameters:
        skipFaultLogging - the value to set
        Returns:
        the dsl builder

      • skipFaultLogging

        default CxfEndpointBuilderFactory.CxfEndpointConsumerBuilder skipFaultLogging​(String skipFaultLogging)
        This option controls whether the PhaseInterceptorChain skips logging the Fault that it catches. The option will be converted to a <code>boolean</code> type. Default: false Group: logging
        Parameters:
        skipFaultLogging - the value to set
        Returns:
        the dsl builder

      • password

        default CxfEndpointBuilderFactory.CxfEndpointConsumerBuilder password​(String password)
        This option is used to set the basic authentication information of password for the CXF client. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        password - the value to set
        Returns:
        the dsl builder

      • username

        default CxfEndpointBuilderFactory.CxfEndpointConsumerBuilder username​(String username)
        This option is used to set the basic authentication information of username for the CXF client. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        username - the value to set
        Returns:
        the dsl builder

      • portName

        default CxfEndpointBuilderFactory.CxfEndpointConsumerBuilder portName​(String portName)
        The endpoint name this service is implementing, it maps to the wsdl:portname. In the format of ns:PORT_NAME where ns is a namespace prefix valid at this scope. The option is a: <code>java.lang.String</code> type. Group: service
        Parameters:
        portName - the value to set
        Returns:
        the dsl builder

      • publishedEndpointUrl

        default CxfEndpointBuilderFactory.CxfEndpointConsumerBuilder publishedEndpointUrl​(String publishedEndpointUrl)
        This option can override the endpointUrl that published from the WSDL which can be accessed with service address url plus wsd. The option is a: <code>java.lang.String</code> type. Group: service
        Parameters:
        publishedEndpointUrl - the value to set
        Returns:
        the dsl builder

      • serviceClass

        default CxfEndpointBuilderFactory.CxfEndpointConsumerBuilder serviceClass​(Class<Object> serviceClass)
        The class name of the SEI (Service Endpoint Interface) class which could have JSR181 annotation or not. The option is a: <code>java.lang.Class&lt;java.lang.Object&gt;</code> type. Group: service
        Parameters:
        serviceClass - the value to set
        Returns:
        the dsl builder

      • serviceClass

        default CxfEndpointBuilderFactory.CxfEndpointConsumerBuilder serviceClass​(String serviceClass)
        The class name of the SEI (Service Endpoint Interface) class which could have JSR181 annotation or not. The option will be converted to a <code>java.lang.Class&lt;java.lang.Object&gt;</code> type. Group: service
        Parameters:
        serviceClass - the value to set
        Returns:
        the dsl builder

      • serviceName

        default CxfEndpointBuilderFactory.CxfEndpointConsumerBuilder serviceName​(String serviceName)
        The service name this service is implementing, it maps to the wsdl:servicename. The option is a: <code>java.lang.String</code> type. Group: service
        Parameters:
        serviceName - the value to set
        Returns:
        the dsl builder

      • wsdlURL

        default CxfEndpointBuilderFactory.CxfEndpointConsumerBuilder wsdlURL​(String wsdlURL)
        The location of the WSDL. Can be on the classpath, file system, or be hosted remotely. The option is a: <code>java.lang.String</code> type. Group: service
        Parameters:
        wsdlURL - the value to set
        Returns:
        the dsl builder