org.apache.camel.builder.endpoint.dsl

Interface CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder

All Superinterfaces:

CxfRsEndpointBuilderFactory.CxfRsEndpointConsumerBuilder, CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder, org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

Enclosing interface:

CxfRsEndpointBuilderFactory

public static interface CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder
extends CxfRsEndpointBuilderFactory.CxfRsEndpointConsumerBuilder, CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder

Builder for endpoint for the CXF-RS component.

Method Summary

Modifier and Type	Method and Description
default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointBuilder	advanced()
default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder	features(List<Object> features) Set the feature list to the CxfRs endpoint.
default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder	features(String features) Set the feature list to the CxfRs endpoint.
default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder	loggingFeatureEnabled(boolean loggingFeatureEnabled) This option enables CXF Logging Feature which writes inbound and outbound REST messages to log.
default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder	loggingFeatureEnabled(String loggingFeatureEnabled) This option enables CXF Logging Feature which writes inbound and outbound REST messages to log.
default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder	loggingSizeLimit(int loggingSizeLimit) To limit the total size of number of bytes the logger will output when logging feature has been enabled.
default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder	loggingSizeLimit(String loggingSizeLimit) To limit the total size of number of bytes the logger will output when logging feature has been enabled.
default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder	modelRef(String modelRef) This option is used to specify the model file which is useful for the resource class without annotation.
default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder	providers(List<Object> providers) Set custom JAX-RS provider(s) list to the CxfRs endpoint.
default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder	providers(String providers) Set custom JAX-RS provider(s) list to the CxfRs endpoint.
default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder	resourceClasses(List<Class<Object>> resourceClasses) The resource classes which you want to export as REST service.
default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder	resourceClasses(String resourceClasses) The resource classes which you want to export as REST service.
default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder	schemaLocations(List<String> schemaLocations) Sets the locations of the schema(s) which can be used to validate the incoming XML or JAXB-driven JSON.
default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder	schemaLocations(String schemaLocations) Sets the locations of the schema(s) which can be used to validate the incoming XML or JAXB-driven JSON.
default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder	skipFaultLogging(boolean skipFaultLogging) This option controls whether the PhaseInterceptorChain skips logging the Fault that it catches.
default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder	skipFaultLogging(String skipFaultLogging) This option controls whether the PhaseInterceptorChain skips logging the Fault that it catches.

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.CxfRsEndpointBuilderFactory.CxfRsEndpointConsumerBuilder

bindingStyle, bindingStyle, bridgeErrorHandler, bridgeErrorHandler, publishedEndpointUrl

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder

cookieHandler, cookieHandler, hostnameVerifier, hostnameVerifier, lazyStartProducer, lazyStartProducer, sslContextParameters, sslContextParameters, throwExceptionOnFailure, throwExceptionOnFailure

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default CxfRsEndpointBuilderFactory.AdvancedCxfRsEndpointBuilder advanced()

Specified by:

advanced in interface CxfRsEndpointBuilderFactory.CxfRsEndpointConsumerBuilder

Specified by:

advanced in interface CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder

features

default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder features(List<Object> features)

Set the feature list to the CxfRs endpoint. The option is a: <code>java.util.List&lt;org.apache.cxf.feature.Feature&gt;</code> type. Group: common

Specified by:

features in interface CxfRsEndpointBuilderFactory.CxfRsEndpointConsumerBuilder

Specified by:

features in interface CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder

Parameters:

features - the value to set

Returns:

the dsl builder

features

default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder 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

Specified by:

features in interface CxfRsEndpointBuilderFactory.CxfRsEndpointConsumerBuilder

Specified by:

features in interface CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder

Parameters:

features - the value to set

Returns:

the dsl builder

loggingFeatureEnabled

default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder 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

Specified by:

loggingFeatureEnabled in interface CxfRsEndpointBuilderFactory.CxfRsEndpointConsumerBuilder

Specified by:

loggingFeatureEnabled in interface CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder

Parameters:

loggingFeatureEnabled - the value to set

Returns:

the dsl builder

loggingFeatureEnabled

default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder 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

Specified by:

loggingFeatureEnabled in interface CxfRsEndpointBuilderFactory.CxfRsEndpointConsumerBuilder

Specified by:

loggingFeatureEnabled in interface CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder

Parameters:

loggingFeatureEnabled - the value to set

Returns:

the dsl builder

loggingSizeLimit

default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder 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

Specified by:

loggingSizeLimit in interface CxfRsEndpointBuilderFactory.CxfRsEndpointConsumerBuilder

Specified by:

loggingSizeLimit in interface CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder

Parameters:

loggingSizeLimit - the value to set

Returns:

the dsl builder

loggingSizeLimit

default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder 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

Specified by:

loggingSizeLimit in interface CxfRsEndpointBuilderFactory.CxfRsEndpointConsumerBuilder

Specified by:

loggingSizeLimit in interface CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder

Parameters:

loggingSizeLimit - the value to set

Returns:

the dsl builder

modelRef

default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder 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

Specified by:

modelRef in interface CxfRsEndpointBuilderFactory.CxfRsEndpointConsumerBuilder

Specified by:

modelRef in interface CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder

Parameters:

modelRef - the value to set

Returns:

the dsl builder

providers

default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder 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

Specified by:

providers in interface CxfRsEndpointBuilderFactory.CxfRsEndpointConsumerBuilder

Specified by:

providers in interface CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder

Parameters:

providers - the value to set

Returns:

the dsl builder

providers

default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder 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

Specified by:

providers in interface CxfRsEndpointBuilderFactory.CxfRsEndpointConsumerBuilder

Specified by:

providers in interface CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder

Parameters:

providers - the value to set

Returns:

the dsl builder

resourceClasses

default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder 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

Specified by:

resourceClasses in interface CxfRsEndpointBuilderFactory.CxfRsEndpointConsumerBuilder

Specified by:

resourceClasses in interface CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder

Parameters:

resourceClasses - the value to set

Returns:

the dsl builder

resourceClasses

default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder 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

Specified by:

resourceClasses in interface CxfRsEndpointBuilderFactory.CxfRsEndpointConsumerBuilder

Specified by:

resourceClasses in interface CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder

Parameters:

resourceClasses - the value to set

Returns:

the dsl builder

schemaLocations

default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder 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

Specified by:

schemaLocations in interface CxfRsEndpointBuilderFactory.CxfRsEndpointConsumerBuilder

Specified by:

schemaLocations in interface CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder

Parameters:

schemaLocations - the value to set

Returns:

the dsl builder

schemaLocations

default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder 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

Specified by:

schemaLocations in interface CxfRsEndpointBuilderFactory.CxfRsEndpointConsumerBuilder

Specified by:

schemaLocations in interface CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder

Parameters:

schemaLocations - the value to set

Returns:

the dsl builder

skipFaultLogging

default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder 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

Specified by:

skipFaultLogging in interface CxfRsEndpointBuilderFactory.CxfRsEndpointConsumerBuilder

Specified by:

skipFaultLogging in interface CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder

Parameters:

skipFaultLogging - the value to set

Returns:

the dsl builder

skipFaultLogging

default CxfRsEndpointBuilderFactory.CxfRsEndpointBuilder 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

Specified by:

skipFaultLogging in interface CxfRsEndpointBuilderFactory.CxfRsEndpointConsumerBuilder

Specified by:

skipFaultLogging in interface CxfRsEndpointBuilderFactory.CxfRsEndpointProducerBuilder

Parameters:

skipFaultLogging - the value to set

Returns:

the dsl builder