Interface JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    All Known Subinterfaces:
    JpaEndpointBuilderFactory.JpaEndpointBuilder
    Enclosing interface:
    JpaEndpointBuilderFactory

    public static interface JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
    extends org.apache.camel.builder.EndpointConsumerBuilder
    Builder for endpoint consumers for the JPA component.
    • Method Detail

      • joinTransaction

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder joinTransaction​(boolean joinTransaction)
        The camel-jpa component will join transaction by default. You can use this option to turn this off, for example if you use LOCAL_RESOURCE and join transaction doesn't work with your JPA provider. This option can also be set globally on the JpaComponent, instead of having to set it on all endpoints. The option is a: boolean type. Default: true Group: common
      • joinTransaction

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder joinTransaction​(String joinTransaction)
        The camel-jpa component will join transaction by default. You can use this option to turn this off, for example if you use LOCAL_RESOURCE and join transaction doesn't work with your JPA provider. This option can also be set globally on the JpaComponent, instead of having to set it on all endpoints. The option will be converted to a boolean type. Default: true Group: common
      • resultClass

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder resultClass​(Class<Object> resultClass)
        Defines the type of the returned payload (we will call entityManager.createNativeQuery(nativeQuery, resultClass) instead of entityManager.createNativeQuery(nativeQuery)). Without this option, we will return an object array. Only has an affect when using in conjunction with native query when consuming data. The option is a: java.lang.Class<java.lang.Object> type. Group: common
      • resultClass

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder resultClass​(String resultClass)
        Defines the type of the returned payload (we will call entityManager.createNativeQuery(nativeQuery, resultClass) instead of entityManager.createNativeQuery(nativeQuery)). Without this option, we will return an object array. Only has an affect when using in conjunction with native query when consuming data. The option will be converted to a java.lang.Class<java.lang.Object> type. Group: common
      • bridgeErrorHandler

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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: boolean type. Default: false Group: consumer
      • bridgeErrorHandler

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder bridgeErrorHandler​(String 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 will be converted to a boolean type. Default: false Group: consumer
      • consumeDelete

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder consumeDelete​(boolean consumeDelete)
        If true, the entity is deleted after it is consumed; if false, the entity is not deleted. The option is a: boolean type. Default: true Group: consumer
      • consumeLockEntity

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder consumeLockEntity​(boolean consumeLockEntity)
        Specifies whether or not to set an exclusive lock on each entity bean while processing the results from polling. The option is a: boolean type. Default: true Group: consumer
      • consumeLockEntity

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder consumeLockEntity​(String consumeLockEntity)
        Specifies whether or not to set an exclusive lock on each entity bean while processing the results from polling. The option will be converted to a boolean type. Default: true Group: consumer
      • deleteHandler

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder deleteHandler​(Object deleteHandler)
        To use a custom DeleteHandler to delete the row after the consumer is done processing the exchange. The option is a: org.apache.camel.component.jpa.DeleteHandler<java.lang.Object> type. Group: consumer
      • deleteHandler

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder deleteHandler​(String deleteHandler)
        To use a custom DeleteHandler to delete the row after the consumer is done processing the exchange. The option will be converted to a org.apache.camel.component.jpa.DeleteHandler<java.lang.Object> type. Group: consumer
      • maxMessagesPerPoll

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder maxMessagesPerPoll​(int maxMessagesPerPoll)
        An integer value to define the maximum number of messages to gather per poll. By default, no maximum is set. Can be used to avoid polling many thousands of messages when starting up the server. Set a value of 0 or negative to disable. The option is a: int type. Group: consumer
      • maxMessagesPerPoll

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder maxMessagesPerPoll​(String maxMessagesPerPoll)
        An integer value to define the maximum number of messages to gather per poll. By default, no maximum is set. Can be used to avoid polling many thousands of messages when starting up the server. Set a value of 0 or negative to disable. The option will be converted to a int type. Group: consumer
      • preDeleteHandler

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder preDeleteHandler​(Object preDeleteHandler)
        To use a custom Pre-DeleteHandler to delete the row after the consumer has read the entity. The option is a: org.apache.camel.component.jpa.DeleteHandler<java.lang.Object> type. Group: consumer
      • preDeleteHandler

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder preDeleteHandler​(String preDeleteHandler)
        To use a custom Pre-DeleteHandler to delete the row after the consumer has read the entity. The option will be converted to a org.apache.camel.component.jpa.DeleteHandler<java.lang.Object> type. Group: consumer
      • sendEmptyMessageWhenIdle

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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: boolean type. Default: false Group: consumer
      • sendEmptyMessageWhenIdle

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 boolean type. Default: false Group: consumer
      • skipLockedEntity

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder skipLockedEntity​(boolean skipLockedEntity)
        To configure whether to use NOWAIT on lock and silently skip the entity. The option is a: boolean type. Default: false Group: consumer
      • transacted

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder transacted​(boolean transacted)
        Whether to run the consumer in transacted mode, by which all messages will either commit or rollback, when the entire batch has been processed. The default behavior (false) is to commit all the previously successfully processed messages, and only rollback the last failed message. The option is a: boolean type. Default: false Group: consumer
      • transacted

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder transacted​(String transacted)
        Whether to run the consumer in transacted mode, by which all messages will either commit or rollback, when the entire batch has been processed. The default behavior (false) is to commit all the previously successfully processed messages, and only rollback the last failed message. The option will be converted to a boolean type. Default: false Group: consumer
      • backoffErrorThreshold

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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: int type. Group: scheduler
      • backoffErrorThreshold

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 int type. Group: scheduler
      • backoffIdleThreshold

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder backoffIdleThreshold​(int backoffIdleThreshold)
        The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option is a: int type. Group: scheduler
      • backoffIdleThreshold

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 int type. Group: scheduler
      • backoffMultiplier

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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: int type. Group: scheduler
      • backoffMultiplier

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 int type. Group: scheduler
      • greedy

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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: boolean type. Default: false Group: scheduler
      • greedy

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 boolean type. Default: false Group: scheduler
      • repeatCount

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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: long type. Default: 0 Group: scheduler
      • repeatCount

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 long type. Default: 0 Group: scheduler
      • runLoggingLevel

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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: org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler
      • runLoggingLevel

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler
      • scheduledExecutorService

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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: java.util.concurrent.ScheduledExecutorService type. Group: scheduler
      • scheduledExecutorService

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 java.util.concurrent.ScheduledExecutorService type. Group: scheduler
      • scheduler

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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: java.lang.Object type. Default: none Group: scheduler
      • scheduler

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 java.lang.Object type. Default: none Group: scheduler
      • schedulerProperties

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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: java.util.Map<java.lang.String, java.lang.Object> 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
      • schedulerProperties

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder schedulerProperties​(Map values)
        To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: java.util.Map<java.lang.String, java.lang.Object> 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
      • useFixedDelay

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder useFixedDelay​(boolean useFixedDelay)
        Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option is a: boolean type. Default: true Group: scheduler
      • useFixedDelay

        default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 boolean type. Default: true Group: scheduler