Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Creating a Descriptor (ELUG)
This section describes how to create EclipseLink descriptors. For information on creating different types of descriptors, see:
After you create a descriptor, you must configure its various options and use it to define mappings.
For complete information on the various types of descriptor that EclipseLink supports, see Descriptor Types.
You can validate descriptors in the following ways:
- Run the project in a test environment and watch for and interpret any exceptions that occur.
- Run the EclipseLink integrity checker.
- Review the project status report.
Generating Java Code for Descriptors
Typically, you capture descriptor configuration in the project.xml file and the EclipseLink runtime reads this information, and then creates and configures all necessary descriptor objects.
Alternatively, for relational projects only, you can export an EclipseLink project as a Java class (org.eclipse.persistence.sessions.Project) that contains all descriptor configuration in Java. This lets you use Workbench to quickly create and configure descriptors, and then, manually code features that Workbench does not support. This gives you the best of both Workbench and Java access to your descriptors. After configuring your Java project class, compile it and include it in your application's JAR file.
For more information, see How to Export Project Java Source Using Workbench.