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

Interface Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    All Known Subinterfaces:
    Olingo2EndpointBuilderFactory.Olingo2EndpointBuilder
    Enclosing interface:
    Olingo2EndpointBuilderFactory
    public static interface Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
    Builder for endpoint consumers for the Olingo2 component.

    • Method Detail

      • connectTimeout

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder 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

      • connectTimeout

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder connectTimeout​(String connectTimeout)
        HTTP connection creation timeout in milliseconds, defaults to 30,000 (30 seconds). The option will be converted to a <code>int</code> type. Default: 30000 Group: common
        Parameters:
        connectTimeout - the value to set
        Returns:
        the dsl builder

      • contentType

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder 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 Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder 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

      • entityProviderReadProperties

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder entityProviderReadProperties​(String entityProviderReadProperties)
        Custom entity provider read properties applied to all read operations. The option will be converted to 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 Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder 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

      • entityProviderWriteProperties

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder entityProviderWriteProperties​(String 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 will be converted to 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 Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder 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

      • filterAlreadySeen

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder filterAlreadySeen​(String filterAlreadySeen)
        Set this to true to filter out results that have already been communicated by this component. The option will be converted to a <code>boolean</code> type. Default: false Group: common
        Parameters:
        filterAlreadySeen - the value to set
        Returns:
        the dsl builder

      • httpHeaders

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder 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

      • httpHeaders

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder httpHeaders​(String httpHeaders)
        Custom HTTP headers to inject into every request, this could include OAuth tokens, etc. The option will be converted to 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

      • serviceUri

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder 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 Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder 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

      • socketTimeout

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder socketTimeout​(String socketTimeout)
        HTTP request timeout in milliseconds, defaults to 30,000 (30 seconds). The option will be converted to a <code>int</code> type. Default: 30000 Group: common
        Parameters:
        socketTimeout - the value to set
        Returns:
        the dsl builder

      • sendEmptyMessageWhenIdle

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder sendEmptyMessageWhenIdle​(boolean sendEmptyMessageWhenIdle)
        If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option is a: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        sendEmptyMessageWhenIdle - the value to set
        Returns:
        the dsl builder

      • sendEmptyMessageWhenIdle

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder sendEmptyMessageWhenIdle​(String sendEmptyMessageWhenIdle)
        If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        sendEmptyMessageWhenIdle - the value to set
        Returns:
        the dsl builder

      • splitResult

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder 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

      • splitResult

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder splitResult​(String 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 will be converted to a <code>boolean</code> type. Default: true Group: consumer
        Parameters:
        splitResult - the value to set
        Returns:
        the dsl builder

      • backoffErrorThreshold

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder backoffErrorThreshold​(int backoffErrorThreshold)
        The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler
        Parameters:
        backoffErrorThreshold - the value to set
        Returns:
        the dsl builder

      • backoffErrorThreshold

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder backoffErrorThreshold​(String backoffErrorThreshold)
        The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler
        Parameters:
        backoffErrorThreshold - the value to set
        Returns:
        the dsl builder

      • backoffIdleThreshold

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder backoffIdleThreshold​(int backoffIdleThreshold)
        The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler
        Parameters:
        backoffIdleThreshold - the value to set
        Returns:
        the dsl builder

      • backoffIdleThreshold

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder backoffIdleThreshold​(String backoffIdleThreshold)
        The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler
        Parameters:
        backoffIdleThreshold - the value to set
        Returns:
        the dsl builder

      • backoffMultiplier

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder backoffMultiplier​(int backoffMultiplier)
        To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option is a: <code>int</code> type. Group: scheduler
        Parameters:
        backoffMultiplier - the value to set
        Returns:
        the dsl builder

      • backoffMultiplier

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder backoffMultiplier​(String backoffMultiplier)
        To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option will be converted to a <code>int</code> type. Group: scheduler
        Parameters:
        backoffMultiplier - the value to set
        Returns:
        the dsl builder

      • greedy

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder greedy​(boolean greedy)
        If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option is a: <code>boolean</code> type. Default: false Group: scheduler
        Parameters:
        greedy - the value to set
        Returns:
        the dsl builder

      • greedy

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder greedy​(String greedy)
        If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option will be converted to a <code>boolean</code> type. Default: false Group: scheduler
        Parameters:
        greedy - the value to set
        Returns:
        the dsl builder

      • initialDelay

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder initialDelay​(long initialDelay)
        Milliseconds before the first poll starts. The option is a: <code>long</code> type. Default: 1000 Group: scheduler
        Parameters:
        initialDelay - the value to set
        Returns:
        the dsl builder

      • repeatCount

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder repeatCount​(long repeatCount)
        Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option is a: <code>long</code> type. Default: 0 Group: scheduler
        Parameters:
        repeatCount - the value to set
        Returns:
        the dsl builder

      • repeatCount

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder repeatCount​(String repeatCount)
        Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option will be converted to a <code>long</code> type. Default: 0 Group: scheduler
        Parameters:
        repeatCount - the value to set
        Returns:
        the dsl builder

      • runLoggingLevel

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder runLoggingLevel​(org.apache.camel.LoggingLevel runLoggingLevel)
        The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option is a: <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler
        Parameters:
        runLoggingLevel - the value to set
        Returns:
        the dsl builder

      • runLoggingLevel

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder runLoggingLevel​(String runLoggingLevel)
        The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option will be converted to a <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler
        Parameters:
        runLoggingLevel - the value to set
        Returns:
        the dsl builder

      • scheduledExecutorService

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder scheduledExecutorService​(ScheduledExecutorService scheduledExecutorService)
        Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option is a: <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler
        Parameters:
        scheduledExecutorService - the value to set
        Returns:
        the dsl builder

      • scheduledExecutorService

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder scheduledExecutorService​(String scheduledExecutorService)
        Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option will be converted to a <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler
        Parameters:
        scheduledExecutorService - the value to set
        Returns:
        the dsl builder

      • scheduler

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder scheduler​(Object scheduler)
        To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option is a: <code>java.lang.Object</code> type. Default: none Group: scheduler
        Parameters:
        scheduler - the value to set
        Returns:
        the dsl builder

      • scheduler

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder scheduler​(String scheduler)
        To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option will be converted to a <code>java.lang.Object</code> type. Default: none Group: scheduler
        Parameters:
        scheduler - the value to set
        Returns:
        the dsl builder

      • schedulerProperties

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder schedulerProperties​(String key,
                                                                                         Object value)
        To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler
        Parameters:
        key - the option key
        value - the option value
        Returns:
        the dsl builder

      • schedulerProperties

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder schedulerProperties​(Map values)
        To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler
        Parameters:
        values - the values
        Returns:
        the dsl builder

      • startScheduler

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder startScheduler​(boolean startScheduler)
        Whether the scheduler should be auto started. The option is a: <code>boolean</code> type. Default: true Group: scheduler
        Parameters:
        startScheduler - the value to set
        Returns:
        the dsl builder

      • startScheduler

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder startScheduler​(String startScheduler)
        Whether the scheduler should be auto started. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler
        Parameters:
        startScheduler - the value to set
        Returns:
        the dsl builder

      • timeUnit

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder timeUnit​(String timeUnit)
        Time unit for initialDelay and delay options. The option will be converted to a <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler
        Parameters:
        timeUnit - the value to set
        Returns:
        the dsl builder

      • useFixedDelay

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder useFixedDelay​(boolean useFixedDelay)
        Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option is a: <code>boolean</code> type. Default: true Group: scheduler
        Parameters:
        useFixedDelay - the value to set
        Returns:
        the dsl builder

      • useFixedDelay

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder useFixedDelay​(String useFixedDelay)
        Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler
        Parameters:
        useFixedDelay - the value to set
        Returns:
        the dsl builder

      • sslContextParameters

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder 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

      • sslContextParameters

        default Olingo2EndpointBuilderFactory.Olingo2EndpointConsumerBuilder sslContextParameters​(String sslContextParameters)
        To configure security using SSLContextParameters. The option will be converted to a <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security
        Parameters:
        sslContextParameters - the value to set
        Returns:
        the dsl builder