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

Interface CxfEndpointBuilderFactory.CxfEndpointProducerBuilder

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

    • Method Detail

      • dataFormat

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

      • dataFormat

        default CxfEndpointBuilderFactory.CxfEndpointProducerBuilder 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.CxfEndpointProducerBuilder 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.CxfEndpointProducerBuilder 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

      • cookieHandler

        default CxfEndpointBuilderFactory.CxfEndpointProducerBuilder cookieHandler​(org.apache.camel.http.base.cookie.CookieHandler cookieHandler)
        Configure a cookie handler to maintain a HTTP session. The option is a: <code>org.apache.camel.http.base.cookie.CookieHandler</code> type. Group: producer
        Parameters:
        cookieHandler - the value to set
        Returns:
        the dsl builder

      • cookieHandler

        default CxfEndpointBuilderFactory.CxfEndpointProducerBuilder cookieHandler​(String cookieHandler)
        Configure a cookie handler to maintain a HTTP session. The option will be converted to a <code>org.apache.camel.http.base.cookie.CookieHandler</code> type. Group: producer
        Parameters:
        cookieHandler - the value to set
        Returns:
        the dsl builder

      • defaultOperationName

        default CxfEndpointBuilderFactory.CxfEndpointProducerBuilder defaultOperationName​(String defaultOperationName)
        This option will set the default operationName that will be used by the CxfProducer which invokes the remote service. The option is a: <code>java.lang.String</code> type. Group: producer
        Parameters:
        defaultOperationName - the value to set
        Returns:
        the dsl builder

      • defaultOperationNamespace

        default CxfEndpointBuilderFactory.CxfEndpointProducerBuilder defaultOperationNamespace​(String defaultOperationNamespace)
        This option will set the default operationNamespace that will be used by the CxfProducer which invokes the remote service. The option is a: <code>java.lang.String</code> type. Group: producer
        Parameters:
        defaultOperationNamespace - the value to set
        Returns:
        the dsl builder

      • hostnameVerifier

        default CxfEndpointBuilderFactory.CxfEndpointProducerBuilder hostnameVerifier​(HostnameVerifier hostnameVerifier)
        The hostname verifier to be used. Use the # notation to reference a HostnameVerifier from the registry. The option is a: <code>javax.net.ssl.HostnameVerifier</code> type. Group: producer
        Parameters:
        hostnameVerifier - the value to set
        Returns:
        the dsl builder

      • hostnameVerifier

        default CxfEndpointBuilderFactory.CxfEndpointProducerBuilder hostnameVerifier​(String hostnameVerifier)
        The hostname verifier to be used. Use the # notation to reference a HostnameVerifier from the registry. The option will be converted to a <code>javax.net.ssl.HostnameVerifier</code> type. Group: producer
        Parameters:
        hostnameVerifier - the value to set
        Returns:
        the dsl builder

      • lazyStartProducer

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

      • lazyStartProducer

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

      • sslContextParameters

        default CxfEndpointBuilderFactory.CxfEndpointProducerBuilder sslContextParameters​(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
        The Camel SSL setting reference. Use the # notation to reference the SSL Context. The option is a: <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: producer
        Parameters:
        sslContextParameters - the value to set
        Returns:
        the dsl builder

      • sslContextParameters

        default CxfEndpointBuilderFactory.CxfEndpointProducerBuilder sslContextParameters​(String sslContextParameters)
        The Camel SSL setting reference. Use the # notation to reference the SSL Context. The option will be converted to a <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: producer
        Parameters:
        sslContextParameters - the value to set
        Returns:
        the dsl builder

      • wrapped

        default CxfEndpointBuilderFactory.CxfEndpointProducerBuilder wrapped​(boolean wrapped)
        Which kind of operation that CXF endpoint producer will invoke. The option is a: <code>boolean</code> type. Default: false Group: producer
        Parameters:
        wrapped - the value to set
        Returns:
        the dsl builder

      • wrapped

        default CxfEndpointBuilderFactory.CxfEndpointProducerBuilder wrapped​(String wrapped)
        Which kind of operation that CXF endpoint producer will invoke. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        wrapped - the value to set
        Returns:
        the dsl builder

      • loggingFeatureEnabled

        default CxfEndpointBuilderFactory.CxfEndpointProducerBuilder 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.CxfEndpointProducerBuilder 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.CxfEndpointProducerBuilder 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.CxfEndpointProducerBuilder 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.CxfEndpointProducerBuilder 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.CxfEndpointProducerBuilder 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.CxfEndpointProducerBuilder 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.CxfEndpointProducerBuilder 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.CxfEndpointProducerBuilder 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.CxfEndpointProducerBuilder 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.CxfEndpointProducerBuilder 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.CxfEndpointProducerBuilder 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.CxfEndpointProducerBuilder 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.CxfEndpointProducerBuilder 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