Package org.apache.camel.component.jpa

Class JpaComponent

java.lang.Object
org.apache.camel.support.service.BaseService
org.apache.camel.support.service.ServiceSupport
org.apache.camel.support.DefaultComponent
org.apache.camel.support.HealthCheckComponent
org.apache.camel.component.jpa.JpaComponent
All Implemented Interfaces:
AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.Component, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasCamelContext, org.apache.camel.StatefulService, org.apache.camel.SuspendableService
@Component("jpa") public class JpaComponent extends org.apache.camel.support.HealthCheckComponent
A JPA Component

  • Field Summary

    Fields inherited from class org.apache.camel.support.service.BaseService

    BUILT, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTING_DOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

  • Constructor Summary

    Constructors
    Constructor
    Description
    JpaComponent()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addAlias(String alias, Class<?> clazz)
     
    protected org.apache.camel.Endpoint
    createEndpoint(String uri, String path, Map<String,Object> options)
     
    protected void
    doInit()
     
    protected void
    doStop()
     
    Map<String,Class<?>>
    getAliases()
     
    jakarta.persistence.EntityManagerFactory
    getEntityManagerFactory()
     
    TransactionStrategy
    getTransactionStrategy()
     
    boolean
    isJoinTransaction()
     
    boolean
    isSharedEntityManager()
     
    void
    setAliases(Map<String,Class<?>> aliases)
    Maps an alias to a JPA entity class.
    void
    setEntityManagerFactory(jakarta.persistence.EntityManagerFactory entityManagerFactory)
    To use the EntityManagerFactory.
    void
    setJoinTransaction(boolean joinTransaction)
    The camel-jpa component will join transaction by default.
    void
    setSharedEntityManager(boolean sharedEntityManager)
    Whether to use Spring's SharedEntityManager for the consumer/producer.
    void
    setTransactionStrategy(TransactionStrategy transactionStrategy)
    To use the TransactionStrategy for running the operations in a transaction.

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

    isHealthCheckConsumerEnabled, isHealthCheckProducerEnabled, setHealthCheckConsumerEnabled, setHealthCheckProducerEnabled

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

    afterConfiguration, createEndpoint, createEndpoint, doBuild, getAndRemoveOrResolveReferenceParameter, getAndRemoveOrResolveReferenceParameter, getAndRemoveParameter, getAndRemoveParameter, getCamelContext, getComponentPropertyConfigurer, getDefaultName, getEndpointPropertyConfigurer, getExtension, getSupportedExtensions, ifStartsWithReturnRemainder, isAutowiredEnabled, isBridgeErrorHandler, isLazyStartProducer, registerExtension, registerExtension, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceParameter, resolveAndRemoveReferenceParameter, resolveRawParameterValues, setAutowiredEnabled, setBridgeErrorHandler, setCamelContext, setLazyStartProducer, setProperties, setProperties, setProperties, useIntrospectionOnEndpoint, useRawUri, validateParameters, validateURI

    Methods inherited from class org.apache.camel.support.service.BaseService

    build, doFail, doLifecycleChange, doResume, doShutdown, doStart, doSuspend, fail, getInternalLock, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.apache.camel.Service

    build, close, init, start, stop

    Methods inherited from interface org.apache.camel.ShutdownableService

    shutdown

    Methods inherited from interface org.apache.camel.StatefulService

    getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending

    Methods inherited from interface org.apache.camel.SuspendableService

    isSuspended, resume, suspend

  • Constructor Details

    • JpaComponent

      public JpaComponent()

  • Method Details

    • getEntityManagerFactory

      public jakarta.persistence.EntityManagerFactory getEntityManagerFactory()

    • setEntityManagerFactory

      public void setEntityManagerFactory(jakarta.persistence.EntityManagerFactory entityManagerFactory)
      To use the EntityManagerFactory. This is strongly recommended to configure.

    • getTransactionStrategy

      public TransactionStrategy getTransactionStrategy()

    • setTransactionStrategy

      public void setTransactionStrategy(TransactionStrategy transactionStrategy)
      To use the TransactionStrategy for running the operations in a transaction.

    • 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.

    • isSharedEntityManager

      public boolean isSharedEntityManager()

    • setSharedEntityManager

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

    • addAlias

      public void addAlias(String alias, Class<?> clazz)

    • setAliases

      public void setAliases(Map<String,Class<?>> 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).

    • getAliases

      public Map<String,Class<?>> getAliases()

    • createEndpoint

      protected org.apache.camel.Endpoint createEndpoint(String uri, String path, Map<String,Object> options) throws Exception
      Specified by:
      createEndpoint in class org.apache.camel.support.DefaultComponent
      Throws:
      Exception

    • doInit

      protected void doInit() throws Exception
      Overrides:
      doInit in class org.apache.camel.support.DefaultComponent
      Throws:
      Exception

    • doStop

      protected void doStop() throws Exception
      Overrides:
      doStop in class org.apache.camel.support.service.BaseService
      Throws:
      Exception