Interface JpaEndpointBuilderFactory.JpaEndpointBuilder
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
,org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
,JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
,JpaEndpointBuilderFactory.JpaEndpointProducerBuilder
- Enclosing interface:
- JpaEndpointBuilderFactory
public static interface JpaEndpointBuilderFactory.JpaEndpointBuilder
extends JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder, JpaEndpointBuilderFactory.JpaEndpointProducerBuilder
Builder for endpoint for the JPA component.
-
Method Summary
Modifier and TypeMethodDescriptionadvanced()
joinTransaction
(boolean joinTransaction) The camel-jpa component will join transaction by default.joinTransaction
(String joinTransaction) The camel-jpa component will join transaction by default.maximumResults
(int maximumResults) Set the maximum number of results to retrieve on the Query.maximumResults
(String maximumResults) Set the maximum number of results to retrieve on the Query.namedQuery
(String namedQuery) To use a named query.nativeQuery
(String nativeQuery) To use a custom native query.persistenceUnit
(String persistenceUnit) The JPA persistence unit used by default.To use a custom query.resultClass
(Class<Object> resultClass) Defines the type of the returned payload (we will call entityManager.createNativeQuery(nativeQuery, resultClass) instead of entityManager.createNativeQuery(nativeQuery)).resultClass
(String resultClass) Defines the type of the returned payload (we will call entityManager.createNativeQuery(nativeQuery, resultClass) instead of entityManager.createNativeQuery(nativeQuery)).Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve
Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointProducerResolver
resolve, resolve
Methods inherited from interface org.apache.camel.builder.endpoint.dsl.JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
backoffErrorThreshold, backoffErrorThreshold, backoffIdleThreshold, backoffIdleThreshold, backoffMultiplier, backoffMultiplier, consumeDelete, consumeDelete, consumeLockEntity, consumeLockEntity, delay, delay, deleteHandler, deleteHandler, greedy, greedy, initialDelay, initialDelay, lockModeType, lockModeType, maxMessagesPerPoll, maxMessagesPerPoll, preDeleteHandler, preDeleteHandler, repeatCount, repeatCount, runLoggingLevel, runLoggingLevel, scheduledExecutorService, scheduledExecutorService, scheduler, scheduler, schedulerProperties, schedulerProperties, sendEmptyMessageWhenIdle, sendEmptyMessageWhenIdle, skipLockedEntity, skipLockedEntity, startScheduler, startScheduler, timeUnit, timeUnit, transacted, transacted, useFixedDelay, useFixedDelay
Methods inherited from interface org.apache.camel.builder.endpoint.dsl.JpaEndpointBuilderFactory.JpaEndpointProducerBuilder
findEntity, findEntity, firstResult, firstResult, flushOnSend, flushOnSend, outputTarget, remove, remove, singleResult, singleResult, useExecuteUpdate, useExecuteUpdate, usePersist, usePersist
-
Method Details
-
advanced
- Specified by:
advanced
in interfaceJpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
- Specified by:
advanced
in interfaceJpaEndpointBuilderFactory.JpaEndpointProducerBuilder
-
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- Specified by:
joinTransaction
in interfaceJpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
- Specified by:
joinTransaction
in interfaceJpaEndpointBuilderFactory.JpaEndpointProducerBuilder
- Parameters:
joinTransaction
- the value to set- Returns:
- the dsl builder
-
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 <code>boolean</code> type. Default: true Group: common- Specified by:
joinTransaction
in interfaceJpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
- Specified by:
joinTransaction
in interfaceJpaEndpointBuilderFactory.JpaEndpointProducerBuilder
- Parameters:
joinTransaction
- the value to set- Returns:
- the dsl builder
-
maximumResults
Set the maximum number of results to retrieve on the Query. The option is a: <code>int</code> type. Default: -1 Group: common- Specified by:
maximumResults
in interfaceJpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
- Specified by:
maximumResults
in interfaceJpaEndpointBuilderFactory.JpaEndpointProducerBuilder
- Parameters:
maximumResults
- the value to set- Returns:
- the dsl builder
-
maximumResults
Set the maximum number of results to retrieve on the Query. The option will be converted to a <code>int</code> type. Default: -1 Group: common- Specified by:
maximumResults
in interfaceJpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
- Specified by:
maximumResults
in interfaceJpaEndpointBuilderFactory.JpaEndpointProducerBuilder
- Parameters:
maximumResults
- the value to set- Returns:
- the dsl builder
-
namedQuery
To use a named query. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
namedQuery
in interfaceJpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
- Specified by:
namedQuery
in interfaceJpaEndpointBuilderFactory.JpaEndpointProducerBuilder
- Parameters:
namedQuery
- the value to set- Returns:
- the dsl builder
-
nativeQuery
To use a custom native query. You may want to use the option resultClass also when using native queries. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
nativeQuery
in interfaceJpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
- Specified by:
nativeQuery
in interfaceJpaEndpointBuilderFactory.JpaEndpointProducerBuilder
- Parameters:
nativeQuery
- the value to set- Returns:
- the dsl builder
-
persistenceUnit
The JPA persistence unit used by default. The option is a: <code>java.lang.String</code> type. Required: true Default: camel Group: common- Specified by:
persistenceUnit
in interfaceJpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
- Specified by:
persistenceUnit
in interfaceJpaEndpointBuilderFactory.JpaEndpointProducerBuilder
- Parameters:
persistenceUnit
- the value to set- Returns:
- the dsl builder
-
query
To use a custom query. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
query
in interfaceJpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
- Specified by:
query
in interfaceJpaEndpointBuilderFactory.JpaEndpointProducerBuilder
- Parameters:
query
- the value to set- Returns:
- the dsl builder
-
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: <code>java.lang.Class<java.lang.Object></code> type. Group: common- Specified by:
resultClass
in interfaceJpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
- Specified by:
resultClass
in interfaceJpaEndpointBuilderFactory.JpaEndpointProducerBuilder
- Parameters:
resultClass
- the value to set- Returns:
- the dsl builder
-
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 <code>java.lang.Class<java.lang.Object></code> type. Group: common- Specified by:
resultClass
in interfaceJpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
- Specified by:
resultClass
in interfaceJpaEndpointBuilderFactory.JpaEndpointProducerBuilder
- Parameters:
resultClass
- the value to set- Returns:
- the dsl builder
-