org.apache.camel.component.jpa

Class JpaEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.impl.ScheduledPollEndpoint

org.apache.camel.component.jpa.JpaEndpoint

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

@UriEndpoint(scheme="jpa",
             title="JPA",
             syntax="jpa:entityType",
             consumerClass=JpaConsumer.class,
             label="database,sql")
public class JpaEndpoint
extends org.apache.camel.impl.ScheduledPollEndpoint

Field Summary

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
JpaEndpoint()
JpaEndpoint(String endpointUri) Deprecated. use JpaEndpoint(String, JpaComponent) instead
JpaEndpoint(String endpointUri, javax.persistence.EntityManagerFactory entityManagerFactory) Deprecated. use JpaEndpoint(String, JpaComponent) instead
JpaEndpoint(String endpointUri, javax.persistence.EntityManagerFactory entityManagerFactory, org.springframework.transaction.PlatformTransactionManager transactionManager) Deprecated. use JpaEndpoint(String, JpaComponent) instead
JpaEndpoint(String uri, JpaComponent component)

Method Summary

Methods

Modifier and Type	Method and Description
void	configureProperties(Map<String,Object> options)
org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor processor)
protected String	createEndpointUri()
protected javax.persistence.EntityManager	createEntityManager() Deprecated. use getEntityManagerFactory() to get hold of factory and create an entity manager using the factory.
protected javax.persistence.EntityManagerFactory	createEntityManagerFactory()
org.apache.camel.Producer	createProducer()
protected org.apache.camel.Expression	createProducerExpression()
protected org.springframework.transaction.PlatformTransactionManager	createTransactionManager()
protected org.springframework.transaction.support.TransactionTemplate	createTransactionTemplate()
javax.persistence.EntityManagerFactory	getEntityManagerFactory()
Map<String,Object>	getEntityManagerProperties() Additional properties for the entity manager to use.
Class<?>	getEntityType()
int	getMaximumResults()
int	getMaxMessagesPerPoll()
String	getPersistenceUnit()
org.apache.camel.Expression	getProducerExpression()
org.springframework.transaction.PlatformTransactionManager	getTransactionManager()
boolean	isConsumeDelete()
boolean	isConsumeLockEntity()
boolean	isFlushOnSend()
boolean	isJoinTransaction()
boolean	isSingleton()
boolean	isUsePassedInEntityManager()
boolean	isUsePersist()
void	setConsumeDelete(boolean consumeDelete) If true, the entity is deleted after it is consumed; if false, the entity is not deleted.
void	setConsumeLockEntity(boolean consumeLockEntity) Specifies whether or not to set an exclusive lock on each entity bean while processing the results from polling.
void	setEntityManagerFactory(javax.persistence.EntityManagerFactory entityManagerFactory) The EntityManagerFactory to use.
void	setEntityManagerProperties(Map<String,Object> entityManagerProperties)
void	setEntityType(Class<?> entityType) The JPA annotated class to use as entity.
void	setFlushOnSend(boolean flushOnSend) Flushes the EntityManager after the entity bean has been persisted.
void	setJoinTransaction(boolean joinTransaction) The camel-jpa component will join transaction by default.
void	setMaximumResults(int maximumResults) Set the maximum number of results to retrieve on the Query.
void	setMaxMessagesPerPoll(int maxMessagesPerPoll) An integer value to define the maximum number of messages to gather per poll.
void	setPersistenceUnit(String persistenceUnit) The JPA persistence unit used by default.
void	setProducerExpression(org.apache.camel.Expression producerExpression)
void	setTransactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager) To use the PlatformTransactionManager for managing transactions.
void	setUsePassedInEntityManager(boolean usePassedIn) If set to true, then Camel will use the EntityManager from the header JpaConstants.ENTITYMANAGER instead of the configured entity manager on the component/endpoint.
void	setUsePersist(boolean usePersist) Indicates to use entityManager.persist(entity) instead of entityManager.merge(entity).
protected void	validate()

Methods inherited from class org.apache.camel.impl.ScheduledPollEndpoint

configurePollingConsumer, configureScheduledPollConsumerProperties, doStart, doStop, getBackoffErrorThreshold, getBackoffIdleThreshold, getBackoffMultiplier, getDelay, getInitialDelay, getPollStrategy, getRunLoggingLevel, getScheduledExecutorService, getScheduler, getSchedulerProperties, getTimeUnit, initConsumerProperties, isGreedy, isSendEmptyMessageWhenIdle, isStartScheduler, isUseFixedDelay, setBackoffErrorThreshold, setBackoffIdleThreshold, setBackoffMultiplier, setDelay, setGreedy, setInitialDelay, setPollStrategy, setRunLoggingLevel, setScheduledExecutorService, setScheduler, setScheduler, setSchedulerProperties, setSendEmptyMessageWhenIdle, setStartScheduler, setTimeUnit, setUseFixedDelay

Methods inherited from class org.apache.camel.impl.DefaultEndpoint

configureConsumer, createEndpointConfiguration, createExchange, createExchange, createExchange, createPollingConsumer, equals, getCamelContext, getComponent, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExchangePattern, getId, getPollingConsumerQueueSize, hashCode, isLenientProperties, isPollingConsumerBlockWhenFull, isSynchronous, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExchangePattern, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Service

start, stop

Constructor Detail

JpaEndpoint

public JpaEndpoint()

JpaEndpoint

@Deprecated
public JpaEndpoint(String endpointUri)

Deprecated. use JpaEndpoint(String, JpaComponent) instead

JpaEndpoint

public JpaEndpoint(String uri,
           JpaComponent component)

JpaEndpoint

@Deprecated
public JpaEndpoint(String endpointUri,
                      javax.persistence.EntityManagerFactory entityManagerFactory)

Deprecated. use JpaEndpoint(String, JpaComponent) instead

JpaEndpoint

@Deprecated
public JpaEndpoint(String endpointUri,
                      javax.persistence.EntityManagerFactory entityManagerFactory,
                      org.springframework.transaction.PlatformTransactionManager transactionManager)

Deprecated. use JpaEndpoint(String, JpaComponent) instead

Method Detail

createProducer

public org.apache.camel.Producer createProducer()
                                         throws Exception

Throws:

Exception

createConsumer

public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor)
                                         throws Exception

Throws:

Exception

configureProperties

public void configureProperties(Map<String,Object> options)

Specified by:

configureProperties in interface org.apache.camel.Endpoint

Overrides:

configureProperties in class org.apache.camel.impl.ScheduledPollEndpoint

isSingleton

public boolean isSingleton()

createEndpointUri

protected String createEndpointUri()

Overrides:

createEndpointUri in class org.apache.camel.impl.DefaultEndpoint

getProducerExpression

public org.apache.camel.Expression getProducerExpression()

setProducerExpression

public void setProducerExpression(org.apache.camel.Expression producerExpression)

getMaximumResults

public int getMaximumResults()

setMaximumResults

public void setMaximumResults(int maximumResults)

Set the maximum number of results to retrieve on the Query.

getEntityType

public Class<?> getEntityType()

setEntityType

public void setEntityType(Class<?> entityType)

The JPA annotated class to use as entity.

getEntityManagerFactory

public javax.persistence.EntityManagerFactory getEntityManagerFactory()

setEntityManagerFactory

public void setEntityManagerFactory(javax.persistence.EntityManagerFactory entityManagerFactory)

The EntityManagerFactory to use.

getTransactionManager

public org.springframework.transaction.PlatformTransactionManager getTransactionManager()

setTransactionManager

public void setTransactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager)

To use the PlatformTransactionManager for managing transactions.

getEntityManagerProperties

public Map<String,Object> getEntityManagerProperties()

Additional properties for the entity manager to use.

setEntityManagerProperties

public void setEntityManagerProperties(Map<String,Object> entityManagerProperties)

getPersistenceUnit

public String getPersistenceUnit()

setPersistenceUnit

public void setPersistenceUnit(String persistenceUnit)

The JPA persistence unit used by default.

isConsumeDelete

public boolean isConsumeDelete()

setConsumeDelete

public void setConsumeDelete(boolean consumeDelete)

If true, the entity is deleted after it is consumed; if false, the entity is not deleted.

isConsumeLockEntity

public boolean isConsumeLockEntity()

setConsumeLockEntity

public void setConsumeLockEntity(boolean consumeLockEntity)

Specifies whether or not to set an exclusive lock on each entity bean while processing the results from polling.

isFlushOnSend

public boolean isFlushOnSend()

setFlushOnSend

public void setFlushOnSend(boolean flushOnSend)

Flushes the EntityManager after the entity bean has been persisted.

getMaxMessagesPerPoll

public int getMaxMessagesPerPoll()

setMaxMessagesPerPoll

public void setMaxMessagesPerPoll(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.

isUsePersist

public boolean isUsePersist()

setUsePersist

public void setUsePersist(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)!

isJoinTransaction

public boolean isJoinTransaction()

setJoinTransaction

public void setJoinTransaction(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.

isUsePassedInEntityManager

public boolean isUsePassedInEntityManager()

setUsePassedInEntityManager

public void setUsePassedInEntityManager(boolean usePassedIn)

If set to true, then Camel will use the EntityManager from the header JpaConstants.ENTITYMANAGER instead of the configured entity manager on the component/endpoint. This allows end users to control which entity manager will be in use.

validate

protected void validate()

createEntityManagerFactory

protected javax.persistence.EntityManagerFactory createEntityManagerFactory()

createTransactionManager

protected org.springframework.transaction.PlatformTransactionManager createTransactionManager()

createEntityManager

@Deprecated
protected javax.persistence.EntityManager createEntityManager()

Deprecated. use getEntityManagerFactory() to get hold of factory and create an entity manager using the factory.

createTransactionTemplate

protected org.springframework.transaction.support.TransactionTemplate createTransactionTemplate()

createProducerExpression

protected org.apache.camel.Expression createProducerExpression()