Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

EclipseLink JPA

EclipseLink
Website
Download
Community
Mailing List • Forums • IRC • mattermost
Issues
Open • Help Wanted • Bug Day
Contribute
Browse Source

Key API

@Version

Examples

Locking

Optimistic Locking

We recommend using EclipseLink optimistic locking. With optimistic locking, all users have read access to the data. When a user attempts to write a change, the application checks to ensure the data has not changed since the user read the data.

Optimistic locking in a stateless environmentIn a stateless environment, take care to avoid processing out-of-date (stale) data A common strategy for avoiding stale data is to implement optimistic locking, and store the optimistic lock values in the object. This solution requires careful implementation if the stateless application serializes the objects, or sends the contents of the object to the client in an alternative format. In this case, transport the optimistic lock values to the client in the HTTP contents of an edit page. You must then use the returned values in any write transaction to ensure that the data did not change while the client was performing its work.

You can use optimistic version locking or optimistic field Locking policies locking policies. We recommend using version locking policies.

Optimistic Version Locking

Use the @Version annotation to enable the JPA-managed optimistic locking by specifying the version field or property of an entity class that serves as its optimistic lock value (recommended).

When choosing a version field or property, ensure that the following is true:

there is only one version field or property per entity;
you choose a property or field persisted to the primary table;

For more information, see Section 11.1.45 "Table Annotation" in the JPA Specification.

your application does not modify the version property or field.

Note: The field or property type must either be a numeric type (such as Number, long, int, BigDecimal, and so on), or a java.sql.Timestamp. We recommend using a numeric type.

The @Version annotation does not have attributes.

The following example shows how to use this annotation to specify property getVersionNum as the optimistic lock value. In this example, the column name for this property is set to OPTLOCK instead of the default column name for the property..

For more information, see Section 11.1.9 "Column Annotation" in the JPA Specification.

Example: @Version Annotation

 @Entity
 public class Employee implements Serializable {
     ...
     @Version
     @Column(name="OPTLOCK")
     protected int getVersionNum() {
         return versionNum;
     }
     ...
 }