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

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 Type	Method	Description
default JpaEndpointBuilderFactory.AdvancedJpaEndpointBuilder	advanced()
default JpaEndpointBuilderFactory.JpaEndpointBuilder	joinTransaction(boolean joinTransaction)	The camel-jpa component will join transaction by default.
default JpaEndpointBuilderFactory.JpaEndpointBuilder	joinTransaction(String joinTransaction)	The camel-jpa component will join transaction by default.
default JpaEndpointBuilderFactory.JpaEndpointBuilder	maximumResults(int maximumResults)	Set the maximum number of results to retrieve on the Query.
default JpaEndpointBuilderFactory.JpaEndpointBuilder	maximumResults(String maximumResults)	Set the maximum number of results to retrieve on the Query.
default JpaEndpointBuilderFactory.JpaEndpointBuilder	namedQuery(String namedQuery)	To use a named query.
default JpaEndpointBuilderFactory.JpaEndpointBuilder	nativeQuery(String nativeQuery)	To use a custom native query.
default JpaEndpointBuilderFactory.JpaEndpointBuilder	persistenceUnit(String persistenceUnit)	The JPA persistence unit used by default.
default JpaEndpointBuilderFactory.JpaEndpointBuilder	query(String query)	To use a custom query.
default JpaEndpointBuilderFactory.JpaEndpointBuilder	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.JpaEndpointBuilder	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

default JpaEndpointBuilderFactory.AdvancedJpaEndpointBuilder advanced()

Specified by:

advanced in interface JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder

Specified by:

advanced in interface JpaEndpointBuilderFactory.JpaEndpointProducerBuilder

joinTransaction

default JpaEndpointBuilderFactory.JpaEndpointBuilder 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

Specified by:

joinTransaction in interface JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder

Specified by:

joinTransaction in interface JpaEndpointBuilderFactory.JpaEndpointProducerBuilder

Parameters:

joinTransaction - the value to set

Returns:

the dsl builder

joinTransaction

default JpaEndpointBuilderFactory.JpaEndpointBuilder 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 <code>boolean</code> type. Default: true Group: common

Specified by:

joinTransaction in interface JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder

Specified by:

joinTransaction in interface JpaEndpointBuilderFactory.JpaEndpointProducerBuilder

Parameters:

joinTransaction - the value to set

Returns:

the dsl builder

maximumResults

default JpaEndpointBuilderFactory.JpaEndpointBuilder maximumResults(int 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 interface JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder

Specified by:

maximumResults in interface JpaEndpointBuilderFactory.JpaEndpointProducerBuilder

Parameters:

maximumResults - the value to set

Returns:

the dsl builder

maximumResults

default JpaEndpointBuilderFactory.JpaEndpointBuilder maximumResults(String 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 interface JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder

Specified by:

maximumResults in interface JpaEndpointBuilderFactory.JpaEndpointProducerBuilder

Parameters:

maximumResults - the value to set

Returns:

the dsl builder

namedQuery

default JpaEndpointBuilderFactory.JpaEndpointBuilder namedQuery(String namedQuery)

To use a named query. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

namedQuery in interface JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder

Specified by:

namedQuery in interface JpaEndpointBuilderFactory.JpaEndpointProducerBuilder

Parameters:

namedQuery - the value to set

Returns:

the dsl builder

nativeQuery

default JpaEndpointBuilderFactory.JpaEndpointBuilder 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: <code>java.lang.String</code> type. Group: common

Specified by:

nativeQuery in interface JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder

Specified by:

nativeQuery in interface JpaEndpointBuilderFactory.JpaEndpointProducerBuilder

Parameters:

nativeQuery - the value to set

Returns:

the dsl builder

persistenceUnit

default JpaEndpointBuilderFactory.JpaEndpointBuilder persistenceUnit(String 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 interface JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder

Specified by:

persistenceUnit in interface JpaEndpointBuilderFactory.JpaEndpointProducerBuilder

Parameters:

persistenceUnit - the value to set

Returns:

the dsl builder

query

default JpaEndpointBuilderFactory.JpaEndpointBuilder query(String query)

To use a custom query. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

query in interface JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder

Specified by:

query in interface JpaEndpointBuilderFactory.JpaEndpointProducerBuilder

Parameters:

query - the value to set

Returns:

the dsl builder

resultClass

default JpaEndpointBuilderFactory.JpaEndpointBuilder 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: <code>java.lang.Class&lt;java.lang.Object&gt;</code> type. Group: common

Specified by:

resultClass in interface JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder

Specified by:

resultClass in interface JpaEndpointBuilderFactory.JpaEndpointProducerBuilder

Parameters:

resultClass - the value to set

Returns:

the dsl builder

resultClass

default JpaEndpointBuilderFactory.JpaEndpointBuilder 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 <code>java.lang.Class&lt;java.lang.Object&gt;</code> type. Group: common

Specified by:

resultClass in interface JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder

Specified by:

resultClass in interface JpaEndpointBuilderFactory.JpaEndpointProducerBuilder

Parameters:

resultClass - the value to set

Returns:

the dsl builder