JpaEndpointBuilderFactory.JpaEndpointProducerBuilder (Camel

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

All Known Subinterfaces:

JpaEndpointBuilderFactory.JpaEndpointBuilder

Enclosing interface:

JpaEndpointBuilderFactory
```
public static interface JpaEndpointBuilderFactory.JpaEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
```
Builder for endpoint producers for the JPA component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default JpaEndpointBuilderFactory.AdvancedJpaEndpointProducerBuilder`	`advanced()`
`default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder`	`findEntity(boolean findEntity)` If enabled then the producer will find a single entity by using the message body as key and entityType as the class type.
`default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder`	`findEntity(String findEntity)` If enabled then the producer will find a single entity by using the message body as key and entityType as the class type.
`default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder`	`flushOnSend(boolean flushOnSend)` Flushes the EntityManager after the entity bean has been persisted.
`default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder`	`flushOnSend(String flushOnSend)` Flushes the EntityManager after the entity bean has been persisted.
`default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder`	`joinTransaction(boolean joinTransaction)` The camel-jpa component will join transaction by default.
`default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder`	`joinTransaction(String joinTransaction)` The camel-jpa component will join transaction by default.
`default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder`	`lazyStartProducer(String lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder`	`maximumResults(int maximumResults)` Set the maximum number of results to retrieve on the Query.
`default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder`	`maximumResults(String maximumResults)` Set the maximum number of results to retrieve on the Query.
`default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder`	`namedQuery(String namedQuery)` To use a named query.
`default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder`	`nativeQuery(String nativeQuery)` To use a custom native query.
`default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder`	`persistenceUnit(String persistenceUnit)` The JPA persistence unit used by default.
`default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder`	`query(String query)` To use a custom query.
`default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder`	`remove(boolean remove)` Indicates to use entityManager.remove(entity).
`default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder`	`remove(String remove)` Indicates to use entityManager.remove(entity).
`default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder`	`resultClass(Class<Object> resultClass)` Defines the type of the returned payload (we will call entityManager.createNativeQuery(nativeQuery, resultClass) instead of entityManager.createNativeQuery(nativeQuery)).
`default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder`	`resultClass(String resultClass)` Defines the type of the returned payload (we will call entityManager.createNativeQuery(nativeQuery, resultClass) instead of entityManager.createNativeQuery(nativeQuery)).
`default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder`	`useExecuteUpdate(Boolean useExecuteUpdate)` To configure whether to use executeUpdate() when producer executes a query.
`default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder`	`useExecuteUpdate(String useExecuteUpdate)` To configure whether to use executeUpdate() when producer executes a query.
`default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder`	`usePersist(boolean usePersist)` Indicates to use entityManager.persist(entity) instead of entityManager.merge(entity).
`default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder`	`usePersist(String usePersist)` Indicates to use entityManager.persist(entity) instead of entityManager.merge(entity).

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 JpaEndpointBuilderFactory.AdvancedJpaEndpointProducerBuilder advanced()
```
  - joinTransaction
```
default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder 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.JpaEndpointProducerBuilder 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
  - maximumResults
```
default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder maximumResults(int maximumResults)
```
    Set the maximum number of results to retrieve on the Query. The option is a: int type. Default: -1 Group: common
  - maximumResults
```
default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder maximumResults(String maximumResults)
```
    Set the maximum number of results to retrieve on the Query. The option will be converted to a int type. Default: -1 Group: common
  - namedQuery
```
default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder namedQuery(String namedQuery)
```
    To use a named query. The option is a: java.lang.String type. Group: common
  - nativeQuery
```
default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder nativeQuery(String nativeQuery)
```
    To use a custom native query. You may want to use the option resultClass also when using native queries. The option is a: java.lang.String type. Group: common
  - persistenceUnit
```
default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder persistenceUnit(String persistenceUnit)
```
    The JPA persistence unit used by default. The option is a: java.lang.String type. Required: true Default: camel Group: common
  - query
```
default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder query(String query)
```
    To use a custom query. The option is a: java.lang.String type. Group: common
  - resultClass
```
default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder 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.JpaEndpointProducerBuilder 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
  - findEntity
```
default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder findEntity(boolean findEntity)
```
    If enabled then the producer will find a single entity by using the message body as key and entityType as the class type. This can be used instead of a query to find a single entity. The option is a: boolean type. Default: false Group: producer
  - findEntity
```
default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder findEntity(String findEntity)
```
    If enabled then the producer will find a single entity by using the message body as key and entityType as the class type. This can be used instead of a query to find a single entity. The option will be converted to a boolean type. Default: false Group: producer
  - flushOnSend
```
default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder flushOnSend(boolean flushOnSend)
```
    Flushes the EntityManager after the entity bean has been persisted. The option is a: boolean type. Default: true Group: producer
  - flushOnSend
```
default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder flushOnSend(String flushOnSend)
```
    Flushes the EntityManager after the entity bean has been persisted. The option will be converted to a boolean type. Default: true Group: producer
  - lazyStartProducer
```
default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder 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: boolean type. Default: false Group: producer
  - lazyStartProducer
```
default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder lazyStartProducer(String 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 will be converted to a boolean type. Default: false Group: producer
  - remove
```
default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder remove(boolean remove)
```
    Indicates to use entityManager.remove(entity). The option is a: boolean type. Default: false Group: producer
  - remove
```
default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder remove(String remove)
```
    Indicates to use entityManager.remove(entity). The option will be converted to a boolean type. Default: false Group: producer
  - useExecuteUpdate
```
default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder useExecuteUpdate(Boolean useExecuteUpdate)
```
    To configure whether to use executeUpdate() when producer executes a query. When you use INSERT, UPDATE or DELETE statement as a named query, you need to specify this option to 'true'. The option is a: java.lang.Boolean type. Group: producer
  - useExecuteUpdate
```
default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder useExecuteUpdate(String useExecuteUpdate)
```
    To configure whether to use executeUpdate() when producer executes a query. When you use INSERT, UPDATE or DELETE statement as a named query, you need to specify this option to 'true'. The option will be converted to a java.lang.Boolean type. Group: producer
  - usePersist
```
default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder usePersist(boolean usePersist)
```
    Indicates to use entityManager.persist(entity) instead of entityManager.merge(entity). Note: entityManager.persist(entity) doesn't work for detached entities (where the EntityManager has to execute an UPDATE instead of an INSERT query)!. The option is a: boolean type. Default: false Group: producer
  - usePersist
```
default JpaEndpointBuilderFactory.JpaEndpointProducerBuilder usePersist(String usePersist)
```
    Indicates to use entityManager.persist(entity) instead of entityManager.merge(entity). Note: entityManager.persist(entity) doesn't work for detached entities (where the EntityManager has to execute an UPDATE instead of an INSERT query)!. The option will be converted to a boolean type. Default: false Group: producer

Interface JpaEndpointBuilderFactory.JpaEndpointProducerBuilder

Method Summary

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

Methods inherited from interface org.apache.camel.EndpointProducerResolver

Method Detail

advanced

joinTransaction

joinTransaction

maximumResults

maximumResults

namedQuery

nativeQuery

persistenceUnit

query

resultClass

resultClass

findEntity

findEntity

flushOnSend

flushOnSend

lazyStartProducer

lazyStartProducer

remove

remove

useExecuteUpdate

useExecuteUpdate

usePersist

usePersist