Package org.apache.camel.builder.component.dsl

Interface JpaComponentBuilderFactory.JpaComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.jpa.JpaComponent>
All Known Implementing Classes:
JpaComponentBuilderFactory.JpaComponentBuilderImpl
Enclosing interface:
JpaComponentBuilderFactory
public static interface JpaComponentBuilderFactory.JpaComponentBuilder extends ComponentBuilder<org.apache.camel.component.jpa.JpaComponent>
Builder for the JPA component.

  • Method Details

    • aliases

      default JpaComponentBuilderFactory.JpaComponentBuilder aliases(Map<String,Class<Object>> aliases)
      Maps an alias to a JPA entity class. The alias can then be used in the endpoint URI (instead of the fully qualified class name). The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Class&lt;java.lang.Object&gt;&gt;</code> type. Group: common
      Parameters:
      aliases - the value to set
      Returns:
      the dsl builder

    • entityManagerFactory

      default JpaComponentBuilderFactory.JpaComponentBuilder entityManagerFactory(jakarta.persistence.EntityManagerFactory entityManagerFactory)
      To use the EntityManagerFactory. This is strongly recommended to configure. The option is a: <code>jakarta.persistence.EntityManagerFactory</code> type. Group: common
      Parameters:
      entityManagerFactory - the value to set
      Returns:
      the dsl builder

    • joinTransaction

      default JpaComponentBuilderFactory.JpaComponentBuilder 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: <code>boolean</code> type. Default: true Group: common
      Parameters:
      joinTransaction - the value to set
      Returns:
      the dsl builder

    • sharedEntityManager

      default JpaComponentBuilderFactory.JpaComponentBuilder sharedEntityManager(boolean sharedEntityManager)
      Whether to use Spring's SharedEntityManager for the consumer/producer. Note in most cases joinTransaction should be set to false as this is not an EXTENDED EntityManager. The option is a: <code>boolean</code> type. Default: false Group: common
      Parameters:
      sharedEntityManager - the value to set
      Returns:
      the dsl builder

    • transactionStrategy

      default JpaComponentBuilderFactory.JpaComponentBuilder transactionStrategy(org.apache.camel.component.jpa.TransactionStrategy transactionStrategy)
      To use the TransactionStrategy for running the operations in a transaction. The option is a: <code>org.apache.camel.component.jpa.TransactionStrategy</code> type. Group: common
      Parameters:
      transactionStrategy - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default JpaComponentBuilderFactory.JpaComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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

    • lazyStartProducer

      default JpaComponentBuilderFactory.JpaComponentBuilder 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 JpaComponentBuilderFactory.JpaComponentBuilder 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

    • healthCheckConsumerEnabled

      default JpaComponentBuilderFactory.JpaComponentBuilder healthCheckConsumerEnabled(boolean healthCheckConsumerEnabled)
      Used for enabling or disabling all consumer based health checks from this component. The option is a: <code>boolean</code> type. Default: true Group: health
      Parameters:
      healthCheckConsumerEnabled - the value to set
      Returns:
      the dsl builder

    • healthCheckProducerEnabled

      default JpaComponentBuilderFactory.JpaComponentBuilder healthCheckProducerEnabled(boolean healthCheckProducerEnabled)
      Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true. The option is a: <code>boolean</code> type. Default: true Group: health
      Parameters:
      healthCheckProducerEnabled - the value to set
      Returns:
      the dsl builder