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

Interface CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    All Known Subinterfaces:
    CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder
    Enclosing interface:
    CxfRsEndpointBuilderFactory
    public static interface CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint producers for the CXF-RS component.

    • Method Detail

      • features

        default CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder features​(String features)
        Set the feature list to the CxfRs endpoint. The option will be converted to a <code>java.util.List&lt;org.apache.cxf.feature.Feature&gt;</code> type. Group: common
        Parameters:
        features - the value to set
        Returns:
        the dsl builder

      • loggingFeatureEnabled

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

      • loggingFeatureEnabled

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

      • loggingSizeLimit

        default CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder loggingSizeLimit​(int loggingSizeLimit)
        To limit the total size of number of bytes the logger will output when logging feature has been enabled. The option is a: <code>int</code> type. Group: common
        Parameters:
        loggingSizeLimit - the value to set
        Returns:
        the dsl builder

      • loggingSizeLimit

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

      • modelRef

        default CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder modelRef​(String modelRef)
        This option is used to specify the model file which is useful for the resource class without annotation. When using this option, then the service class can be omitted, to emulate document-only endpoints. The option is a: <code>java.lang.String</code> type. Group: common
        Parameters:
        modelRef - the value to set
        Returns:
        the dsl builder

      • providers

        default CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder providers​(List<Object> providers)
        Set custom JAX-RS provider(s) list to the CxfRs endpoint. You can specify a string with a list of providers to lookup in the registy separated by comma. The option is a: <code>java.util.List&lt;java.lang.Object&gt;</code> type. Group: common
        Parameters:
        providers - the value to set
        Returns:
        the dsl builder

      • providers

        default CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder providers​(String providers)
        Set custom JAX-RS provider(s) list to the CxfRs endpoint. You can specify a string with a list of providers to lookup in the registy separated by comma. The option will be converted to a <code>java.util.List&lt;java.lang.Object&gt;</code> type. Group: common
        Parameters:
        providers - the value to set
        Returns:
        the dsl builder

      • resourceClasses

        default CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder resourceClasses​(List<Class<Object>> resourceClasses)
        The resource classes which you want to export as REST service. Multiple classes can be separated by comma. The option is a: <code>java.util.List&lt;java.lang.Class&lt;java.lang.Object&gt;&gt;</code> type. Group: common
        Parameters:
        resourceClasses - the value to set
        Returns:
        the dsl builder

      • resourceClasses

        default CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder resourceClasses​(String resourceClasses)
        The resource classes which you want to export as REST service. Multiple classes can be separated by comma. The option will be converted to a <code>java.util.List&lt;java.lang.Class&lt;java.lang.Object&gt;&gt;</code> type. Group: common
        Parameters:
        resourceClasses - the value to set
        Returns:
        the dsl builder

      • schemaLocations

        default CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder schemaLocations​(List<String> schemaLocations)
        Sets the locations of the schema(s) which can be used to validate the incoming XML or JAXB-driven JSON. The option is a: <code>java.util.List&lt;java.lang.String&gt;</code> type. Group: common
        Parameters:
        schemaLocations - the value to set
        Returns:
        the dsl builder

      • schemaLocations

        default CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder schemaLocations​(String schemaLocations)
        Sets the locations of the schema(s) which can be used to validate the incoming XML or JAXB-driven JSON. The option will be converted to a <code>java.util.List&lt;java.lang.String&gt;</code> type. Group: common
        Parameters:
        schemaLocations - the value to set
        Returns:
        the dsl builder

      • skipFaultLogging

        default CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder 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: common
        Parameters:
        skipFaultLogging - the value to set
        Returns:
        the dsl builder

      • skipFaultLogging

        default CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder 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: common
        Parameters:
        skipFaultLogging - the value to set
        Returns:
        the dsl builder

      • cookieHandler

        default CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder cookieHandler​(Object 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 CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder 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

      • hostnameVerifier

        default CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder hostnameVerifier​(Object 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 CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder 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 CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder 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 CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder 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 CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder sslContextParameters​(Object 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 CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder 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

      • throwExceptionOnFailure

        default CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder throwExceptionOnFailure​(boolean throwExceptionOnFailure)
        This option tells the CxfRsProducer to inspect return codes and will generate an Exception if the return code is larger than 207. The option is a: <code>boolean</code> type. Default: true Group: producer
        Parameters:
        throwExceptionOnFailure - the value to set
        Returns:
        the dsl builder

      • throwExceptionOnFailure

        default CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder throwExceptionOnFailure​(String throwExceptionOnFailure)
        This option tells the CxfRsProducer to inspect return codes and will generate an Exception if the return code is larger than 207. The option will be converted to a <code>boolean</code> type. Default: true Group: producer
        Parameters:
        throwExceptionOnFailure - the value to set
        Returns:
        the dsl builder