Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Fixed typo.


Since
since5.3
 

Starting with Tapestry 5.3, Tapestry provides a built-in integration with the Java Persistence API (JPA) through the Tapestry-jpa module. This module supersedes the 3rd-party Tynamo JPA module.

Contents

...

Info

Note that the TapestryPersistenceUnitInfo instance passed to the PersistenceUnitConfigurer is either empty or my may contain the persistence unit metadata read from the persistence.xml file. What happens if you contribute a PersistenceUnitConfigurer for a persistence unit that has not been defined in the persistence.xml file? In this case Tapestry assumes that you want to configure the persistence unit programmatically and just creates a fresh TapestryPersistenceUnitInfo object and passes it to the PersistenceUnitConfigurer.

...

As you can see, you may add as many packages as you wish.

Configuration Settings

The following Several aspects of Tapestry-jpa can be configured customized in your application module (usually AppModule.java), just like other Tapestry configuration symbols.

SymbolDefaultDescription
JpaSymbols.PROVIDE_ENTITY_VALUE_ENCODERStrue
 
Whether entity value encoders will be provided automatically. See Using Select with a List.
JpaSymbols.EARLY_START_UPtrue
 
Whether JPA will be started up at application launch, rather than lazily.
JpaSymbols.ENTITY_SESSION_STATE_PERSISTENCE_STRATEGY_ENABLEDtrue
 

Whether the "entity" persistence strategy is used to store JPA entities as Session State Objects.

JpaSymbols.PERSISTENCE_DESCRIPTOR/META-INF/persistence.xml
 

...

The location of the persistence configuration file, located on the classpath

Injecting the EntityManager

...

Alternatively, you can use the @Inject annotation to get the EntityManager injected into a page or component, as shown in the following example.

Code Block
languagejava
titleCreateAddress.java
public class CreateAddress {

   @Inject
   private EntityManager entityManager;

   @Property
   private Address address;

   @CommitAfter
   void onSuccess() {
      entityManager.persist(address);
   }
}

However, if you have multiple instances of persistence-unit defined in the same application, you need to explicitly tell Tapestry which persistence unit you want to get injected. This is what the @PersistenceContext annotation’s name attribute is used for? . The following example demonstrates how to inject the persistence unit named DemoUnit.

...

Code Block
languagejava
titleUserDaoImpl
public class UserDaoImpl implements UserDao {
   @Inject
   @PersistenceContext(unitName = "DemoUnit")
   private EntityManager entityManager;

   ...
}

Value Encoders

...

The Tapestry-jpa module automatically provides value encoders to make it easy to work with entities (especially lists of entities) in your Tapestry pages and components. This is modeled on the similar functionality from the Tapestry-hibernate-core module. See the Hibernate User Guide for all the details.

Transaction Management

As you may already know from the Hibernate integration library, Tapestry automatically manages transactions for you. The JPA integration library defines the @CommitAfter annotation, which acts as the correspondent annotation from the Hibernate integration library. Let’s explore the UserDao interface to see the annotation in action.

...