The entity enhancer tool for Java Persistence API (JPA) applications inserts bytecode into an entity class file that supports the JPA provider to manage the state of an entity.
JPA with the application server requires that all entity classes be enhanced if you want to manage their state. In a container-managed environment, automated enhancement is provided by the containers. In a Java SE environment, though, there are no containers to manage persistence and you might use this command frequently before packaging application files for testing. After you have created the JPA entities, you can run the wsenhancer tool to inject bytecode into the entities before packaging the Java archive (JAR) file into the enterprise archive (EAR) file for the application.
The command syntax is as follows:
wsenhancer.sh [parameters][arguments]
wsenhancer [parameters][arguments]
wsenhancer.bat [parameters][arguments]
If the directory does not match the enhanced class package, the package structure is created beneath the directory. By default, the enhancer overwrites the original .class file.
The default is set to false.
This function supports other code to load the enhanced version of the class afterward within the same Java virtual machine (JVM). The default is set to true.
To use the wsenhancer tool you need entities defined to the JPA specifications, and the entities must be compiled. Run the wsenhancer tool against the entities before packaging them into a JAR file. If the entities are already packaged, you extract the entity class files, run the enhancer, and recreate the JAR file.
To enhance all entities on the class path:
$ cd build /home/user/myproject/build $ ${profile_root}/bin/wsenhancer.sh
$ cd build /home/user/myproject/build $ ${profile_root}/bin/wsenhancer
C:\myproject\cd build C:\myproject\build>%profile_root%\bin\wsenhancer.bat
All entities in myproject are enhanced.
To enhance a specific entity when you have the source files:
$ cd build /home/user/myproject/build $ ${profile_root}/bin/wsenhancer.sh Magazine.java
$ cd build /home/user/myproject/build $ ${profile_root}/bin/wsenhancer Magazine.java
C:\myproject\cd build C:\myproject\build>%profile_root%\bin\wsenhancer.bat Magazine.java
To enhance a specific entity when you have the compiled class files:
$ export CLASSPATH=target/classes $ ${profile_root}/bin/wsenhancer.sh /bin/wsenhancer.sh target/classes/jpa/example/MyEntity.class
$ export CLASSPATH=target/classes $ ${profile_root}/bin/wsenhancer target/classes/jpa/example/MyEntity.class
C:> cd build C:\build> SET CLASSPATH=target\classes C:\build>%profile_root%\bin\wsenhancer.bat \bin\wsenhancer.bat target\classes\jpa\example\Magazine.class
The entity, Magazine.java, located in project are enhanced.
For more information about enhancement tools, see the section on persistent classes in the Apache OpenJPA documentation.