org.apache.camel.builder.component.dsl

Interface Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.olingo2.Olingo2Component>

All Known Implementing Classes:

Olingo2ComponentBuilderFactory.Olingo2ComponentBuilderImpl

Enclosing interface:

Olingo2ComponentBuilderFactory

public static interface Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder
extends ComponentBuilder<org.apache.camel.component.olingo2.Olingo2Component>

Builder for the Olingo2 component.

Method Summary

Modifier and Type	Method and Description
default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder	autowiredEnabled(boolean autowiredEnabled) Whether autowiring is enabled.
default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder	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.
default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder	configuration(org.apache.camel.component.olingo2.Olingo2Configuration configuration) To use the shared configuration.
default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder	connectTimeout(int connectTimeout) HTTP connection creation timeout in milliseconds, defaults to 30,000 (30 seconds).
default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder	contentType(String contentType) Content-Type header value can be used to specify JSON or XML message format, defaults to application/json;charset=utf-8.
default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder	entityProviderReadProperties(org.apache.olingo.odata2.api.ep.EntityProviderReadProperties entityProviderReadProperties) Custom entity provider read properties applied to all read operations.
default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder	entityProviderWriteProperties(org.apache.olingo.odata2.api.ep.EntityProviderWriteProperties entityProviderWriteProperties) Custom entity provider write properties applied to create, update, patch, batch and merge operations.
default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder	filterAlreadySeen(boolean filterAlreadySeen) Set this to true to filter out results that have already been communicated by this component.
default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder	httpAsyncClientBuilder(org.apache.http.impl.nio.client.HttpAsyncClientBuilder httpAsyncClientBuilder) Custom HTTP async client builder for more complex HTTP client configuration, overrides connectionTimeout, socketTimeout, proxy and sslContext.
default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder	httpClientBuilder(org.apache.http.impl.client.HttpClientBuilder httpClientBuilder) Custom HTTP client builder for more complex HTTP client configuration, overrides connectionTimeout, socketTimeout, proxy and sslContext.
default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder	httpHeaders(Map<String,String> httpHeaders) Custom HTTP headers to inject into every request, this could include OAuth tokens, etc.
default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder	proxy(org.apache.http.HttpHost proxy) HTTP proxy server configuration.
default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder	serviceUri(String serviceUri) Target OData service base URI, e.g.
default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder	socketTimeout(int socketTimeout) HTTP request timeout in milliseconds, defaults to 30,000 (30 seconds).
default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder	splitResult(boolean splitResult) For endpoints that return an array or collection, a consumer endpoint will map every element to distinct messages, unless splitResult is set to false.
default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder	sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters) To configure security using SSLContextParameters.
default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder	useGlobalSslContextParameters(boolean useGlobalSslContextParameters) Enable usage of global SSL context parameters.

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

build, build, doSetProperty, register

Method Detail

configuration

default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder configuration(org.apache.camel.component.olingo2.Olingo2Configuration configuration)

To use the shared configuration. The option is a: <code>org.apache.camel.component.olingo2.Olingo2Configuration</code> type. Group: common

Parameters:

configuration - the value to set

Returns:

the dsl builder

connectTimeout

default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder connectTimeout(int connectTimeout)

HTTP connection creation timeout in milliseconds, defaults to 30,000 (30 seconds). The option is a: <code>int</code> type. Default: 30000 Group: common

Parameters:

connectTimeout - the value to set

Returns:

the dsl builder

contentType

default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder contentType(String contentType)

Content-Type header value can be used to specify JSON or XML message format, defaults to application/json;charset=utf-8. The option is a: <code>java.lang.String</code> type. Default: application/json;charset=utf-8 Group: common

Parameters:

contentType - the value to set

Returns:

the dsl builder

entityProviderReadProperties

default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder entityProviderReadProperties(org.apache.olingo.odata2.api.ep.EntityProviderReadProperties entityProviderReadProperties)

Custom entity provider read properties applied to all read operations. The option is a: <code>org.apache.olingo.odata2.api.ep.EntityProviderReadProperties</code> type. Group: common

Parameters:

entityProviderReadProperties - the value to set

Returns:

the dsl builder

entityProviderWriteProperties

default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder entityProviderWriteProperties(org.apache.olingo.odata2.api.ep.EntityProviderWriteProperties entityProviderWriteProperties)

Custom entity provider write properties applied to create, update, patch, batch and merge operations. For instance users can skip the Json object wrapper or enable content only mode when sending request data. A service URI set in the properties will always be overwritten by the serviceUri configuration parameter. Please consider to using the serviceUri configuration parameter instead of setting the respective write property here. The option is a: <code>org.apache.olingo.odata2.api.ep.EntityProviderWriteProperties</code> type. Group: common

Parameters:

entityProviderWriteProperties - the value to set

Returns:

the dsl builder

filterAlreadySeen

default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder filterAlreadySeen(boolean filterAlreadySeen)

Set this to true to filter out results that have already been communicated by this component. The option is a: <code>boolean</code> type. Default: false Group: common

Parameters:

filterAlreadySeen - the value to set

Returns:

the dsl builder

httpHeaders

default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder httpHeaders(Map<String,String> httpHeaders)

Custom HTTP headers to inject into every request, this could include OAuth tokens, etc. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.String&gt;</code> type. Group: common

Parameters:

httpHeaders - the value to set

Returns:

the dsl builder

proxy

default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder proxy(org.apache.http.HttpHost proxy)

HTTP proxy server configuration. The option is a: <code>org.apache.http.HttpHost</code> type. Group: common

Parameters:

proxy - the value to set

Returns:

the dsl builder

serviceUri

default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder serviceUri(String serviceUri)

Target OData service base URI, e.g. http://services.odata.org/OData/OData.svc. The option is a: <code>java.lang.String</code> type. Group: common

Parameters:

serviceUri - the value to set

Returns:

the dsl builder

socketTimeout

default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder socketTimeout(int socketTimeout)

HTTP request timeout in milliseconds, defaults to 30,000 (30 seconds). The option is a: <code>int</code> type. Default: 30000 Group: common

Parameters:

socketTimeout - the value to set

Returns:

the dsl builder

bridgeErrorHandler

default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder 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

splitResult

default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder splitResult(boolean splitResult)

For endpoints that return an array or collection, a consumer endpoint will map every element to distinct messages, unless splitResult is set to false. The option is a: <code>boolean</code> type. Default: true Group: consumer

Parameters:

splitResult - the value to set

Returns:

the dsl builder

lazyStartProducer

default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder 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

autowiredEnabled

default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder autowiredEnabled(boolean autowiredEnabled)

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced

Parameters:

autowiredEnabled - the value to set

Returns:

the dsl builder

httpAsyncClientBuilder

default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder httpAsyncClientBuilder(org.apache.http.impl.nio.client.HttpAsyncClientBuilder httpAsyncClientBuilder)

Custom HTTP async client builder for more complex HTTP client configuration, overrides connectionTimeout, socketTimeout, proxy and sslContext. Note that a socketTimeout MUST be specified in the builder, otherwise OData requests could block indefinitely. The option is a: <code>org.apache.http.impl.nio.client.HttpAsyncClientBuilder</code> type. Group: advanced

Parameters:

httpAsyncClientBuilder - the value to set

Returns:

the dsl builder

httpClientBuilder

default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder httpClientBuilder(org.apache.http.impl.client.HttpClientBuilder httpClientBuilder)

Custom HTTP client builder for more complex HTTP client configuration, overrides connectionTimeout, socketTimeout, proxy and sslContext. Note that a socketTimeout MUST be specified in the builder, otherwise OData requests could block indefinitely. The option is a: <code>org.apache.http.impl.client.HttpClientBuilder</code> type. Group: advanced

Parameters:

httpClientBuilder - the value to set

Returns:

the dsl builder

sslContextParameters

default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)

To configure security using SSLContextParameters. The option is a: <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security

Parameters:

sslContextParameters - the value to set

Returns:

the dsl builder

useGlobalSslContextParameters

default Olingo2ComponentBuilderFactory.Olingo2ComponentBuilder useGlobalSslContextParameters(boolean useGlobalSslContextParameters)

Enable usage of global SSL context parameters. The option is a: <code>boolean</code> type. Default: false Group: security

Parameters:

useGlobalSslContextParameters - the value to set

Returns:

the dsl builder