JavaOneSessionV3 1 PDF

EJB 3.2/JPA 2.
1 Best Practices with Real-Life Examples [CON7535]
EJB 3.2/JPA 2.1 Best Practices with

Real-Life Examples
[CON7535]
Ahmad Gohar, Architect

IBM Experienced IT-Specialist
Client Innovation Center (CIC)
© 2015 IBM Corporation

1
Ahmad (Nabil) Gohar
Architect & Technical Team Lead (9Y.)

Client Innovation Center CIC | IBM Egypt
IBM Certified Experienced IT Specialist
M.Sc. in Information System, FCI, Egypt
MIBA in Global Management, ESLSCA, France
OCEJPA, OCPWCD,OCPJP, OCP PL/SQL, MCP(s)
JAVA Community Process (JCP) Member
Blogger Author and Academic Researcher
2 © 2015 IBM Corporation
Entity
ENCRYPT STRING DATA

Data Model
Oracle HR Employees Table

The EncryptorBean
The EncryptorBean handles encryption but does not

know what’s being encrypted.

Encryption Main requirements
Provide a transparent encryption that does not

affect the application,
Develop application and security/encryption by two
different teams/persons.

1- Encryption Using Facade
Facade

1- Encryption Using Facade
Persistence manager quietly handles your

encryption
Architecture demands a tight and unnecessary
binding between your persistence and security
designs.
You can’t touch one without also touching the other.

2- JPA EntityListeners

2- JPA EntityListeners
 A solution is JPA EntityListeners

 These are Listener classes that can provide methods called before or after database object
creation, deletion or modification.
– @PrePersist
– @PreUpdate
– @PreRemove
– @PostLoad
– @PostUpdate
– @PostRemove
 To keep a clean separation between the persistence and security layers the listener does
nothing but call a service that handles the encryption.

3- Converter (AttributeConverter) @JPA 2.1
Attribute Converter provide a nice and easy way to

define a custom mapping between your property on
the entity and the database column.
The only thing that is needed is a class that
–implements the AttributeConverter interface
–annotated with @Converter.

Converter (AttributeConverter)
Converter Class

Converter (AttributeConverter)
JPA
Facade

Entity Listeners or Attribute Converter?
Entity Listener Adv. Entity Listener Drawbacks

 The entity listener can use  Its implementation is
multiple attributes of the specific for an entity
entity during encryption.
 More complex than the
 So we can join multiple implementation of a
attributes, encrypt them Attribute Converter.
and store the encrypted
 If we need to encrypt an
data in one database field.
additional attribute, you
need to change the
implementation.
The Converter Adv. The Converter Drawbacks

 Can be used to encrypt  The encrypted entity
any String attribute of any attribute cannot be marked
entity. as transient.
 By using the XML based  This might result in
configuration to register vulnerabilities if the entity
the converter to the entity gets written to the disk.
attribute, it requires no
change in the source code
of the application.

Both approaches have their pros and cons.
You have to decide which advantages and

disadvantages are more important to you.

Entity
ENCRYPT OBJECT DATA

BigDecimal Converter

Converter Class

JPA

JSR 310
JAVA 8 DATE TIME API

Java 8 Date Time API
 A date without a time-zone in the ISO-8601 calendar system, such as 2007-12-03.
 LocalDate is an immutable date-time object that represents a date.
 Other date fields, such as day-of-year, day-of-week and week-of-year, can also be
accessed.
 The ISO-8601 calendar system is the modern civil calendar system used today in most of
the world.
 However, any application that makes use of historical dates, and requires them to be
accurate will find the ISO-8601 approach unsuitable.

Java 8 Date Time API

Does JPA 2.1 support LocalDate and LocalDateTime?
NO
Why JPA not support LocalDate and LocalDateTime?
The answer is simple,

 JPA 2.1 was released before Java 8 and the Date and
Time API simply didn’t exist at that point in time.
 Therefore the @Temporal annotation can only be applied

to attributes of type java.util.Date and java.util.Calendar.

Entity
HOW TO PERSIST
LOCALDATE AND
LOCALDATETIME WITH JPA
How to persist LocalDate and LocalDateTime with JPA
Converter Class

How to persist LocalDate and LocalDateTime with JPA
JPA

Converting LocalDateTime
 The attribute converter for LocalDateTime is basically the same.
 You need to implement the AttributeConverter<LocalDateTime, Timestamp> interface and

the converter needs to be annotated with the @Converter annotation.
 Similar to the LocalDateConverter, the conversion between a LocalDateTime and an

java.sql.Timestamp is done with the conversion methods of Timestamp.

LocalDate/LocalDateTime Conclusion
 JPA 2.1 was released before Java 8 and therefore doesn’t support the new Date and Time
API.
 If you want to use the new classes (in the right way), you need to define the conversion to
java.sql.Date and java.sql.Timestamp yourself.
 This can be easily done by implementing the AttributeConverter<EntityType,

DatabaseType> interface and annotating the class with @Converter(autoApply=true).
 By setting autoApply=true, the converter will be applied to all attributes of the EntityType and
no changes on the entity are required.

Entity
DATA FETCHING STRATEGY

Data fetching strategy
 EAGER – immediate
 LAZY – load only when needed
 Lazy is good for large objects with deep relationship hierarchies

Lazy Loading Best Practices
 Lazy load fields and relationships that are not used frequently
 One-many/many-may relationships are lazy loaded by default
 Lazy load CLOB/BLOB if possible
 Accessing a LAZY relationship from a detached entity

– May get a null
– May get a previously cached value
– May get an exception

Entity | Data Fetching Strategy
WAYS TO INITIALIZE LAZY

RELATIONS

Example
JPA

1. Call a method on the mapped relation
Facade

2. Fetch Join in JPQL
JPA
Facade

3. Fetch Join in Criteria API
Facade

4. Named Entity Graph
JPA
Facade

5. Dynamic Entity Graph
Facade

5. Dynamic Entity Graph
Advantage
 If we need lots of use case specific entity graphs, it might
be better to define the entity graph within the specific Java
code and to not add an additional annotation to the entity.
 Avoids entities with dozens of annotations.
Disadvantage
 The dynamic entity graph requires more code and an
additional method to be reusable.

5 ways to initialize lazy relations and when to use them
 Initializing a lazy relation via calling a method on a mapped relation causes an additional
query. This should be avoided for performance reasons.
 Fetch joins in JPQL statements reduce the number of queries to one but we might need a lot
of different queries.
 The Criteria API also supports fetch joins and we need specific code for each combination of
relations that shall be initialized.
 Named entity graphs are a good solution, if we will reuse the defined graph in our code.
 Dynamic entity graphs can be the better solution, if we need to define a use case specific
graph.

Schemas and Queries
QUERIES

Query
JPQL
JPA Criteria

Query
JPA Criteria with Metamodel

Schemas and Queries
DEFINE NAMED QUERIES AT

RUNTIME

3 steps to define a named query at runtime
1. Create a Query.
– This can be done as a JPQL, native or criteria query.
– You can also define additional hints and settings for the query.
2. Find a name for your query that is unique within your persistence unit.
– If there is already a named query defined for the name, the query will be updated.
3. Use the Query and name to call the addNamedQuery(String name, Query query) method
on the EntityManagerFactory.

Named Query at Runtime
Define the Named Query
Call the Named Query

Schemas and Queries
JPQL ENHANCEMENTS

JPQL enhancements
We can now use the keyword ON to define

additional join parameters
call database functions by using FUNCTION
downcast entities with TREAT.

JPQL enhancement (FUNC)

Schemas and Queries
BULK UPDATES

Bulk Updates

Bulk Updates

Schemas and Queries
STORED PROCEDURES IN JPA

4 different modes of parameters
 IN:
– for input parameters,
 OUT:
– for output parameters,
 INOUT:
– for parameters which are used for input and output and
 REF_CURSOR:
– for cursors on a result set .

Oracle Stored Procedure

Named Stored Procedure

Named Stored Procedure

Stored Procedure Query

Schemas and Queries
GENERATING DB SCHEMA

Generating DB Schema
 javax.persistence.schema-generation.database.action
 javax.persistence.schema-generation.scripts.action
 javax.persistence.schema-generation.create-source
 javax.persistence.schema-generation.drop-source
 javax.persistence.schema-generation.create-database-schemas
 javax.persistence.schema-generation.scripts.create-target
 javax.persistence.schema-generation.scripts.drop-target
 javax.persistence.database-product-name
 javax.persistence.database-major-version
 javax.persistence.database-minor-version
 javax.persistence.schema-generation.create-script-source
 javax.persistence.schema-generation.drop-script-source
 javax.persistence.schema-generation.connection
 javax.persistence.sql-load-script-source

EJB
EJB LITE

More features in EJB.Lite
Asynchronous session bean
Non-persistent EJB Timer service

EJB
STATEFUL SESSION BEAN

Stateful Session Bean Life Cycle

Opt-out of passivation for stateful session bean

EJB
TIMERSERVICE

TimerService
 TimerService.getAllTimers
– a newly added convenience API that returns all timers in the same bean.
– This is only for displaying the list of timers as the timer can only be cancelled by its
owner.

Painless Persistence
Invest in some JPA skills

Design your persistent objects
Create a services layer (DAOs are not sufficient)
Avoid cool but expensive features (e.g. Cascade)
and always work with the DBAs
Don't blindly do anything – always think before you
code!

Wrap up

Wrap up
Encrypt String Data (AttributeConverter)

Encrypt Object Data (AttributeConverter)
Java 8 Date Time API (AttributeConverter)
Data fetching strategy
ways to initialize lazy relations(Named Entity Graph, Dynamic Entity
Graph)
Bulk Updates (Criteria Update)
stored procedures in JPA (Named Stored Procedure, Stored Procedure
Query)
define named queries at runtime
JPQL Enhancements
Q. & A.
ansgohar
https://about.me/ansgohar
http://ansgohar.blogspot.co.uk
https://eg.linkedin.com/in/ansgohar
https://www.facebook.com/ansgohar
https://twitter.com/ansgohar

76
78

JavaOneSessionV3 1 PDF

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

JavaOneSessionV3 1 PDF

Uploaded by

Copyright:

Available Formats

EJB 3.2/JPA 2.

1 Best Practices with Real-Life Examples [CON7535]

EJB 3.2/JPA 2.1 Best Practices with

Ahmad Gohar, Architect

© 2015 IBM Corporation

Architect & Technical Team Lead (9Y.)

ENCRYPT STRING DATA

7 © 2015 IBM Corporation

8 © 2015 IBM Corporation

The EncryptorBean handles encryption but does not

9 © 2015 IBM Corporation

Provide a transparent encryption that does not

10 © 2015 IBM Corporation

11 © 2015 IBM Corporation

Persistence manager quietly handles your

12 © 2015 IBM Corporation

13 © 2015 IBM Corporation

 A solution is JPA EntityListeners

14 © 2015 IBM Corporation

Attribute Converter provide a nice and easy way to

15 © 2015 IBM Corporation

16 © 2015 IBM Corporation

17 © 2015 IBM Corporation

Entity Listener Adv. Entity Listener Drawbacks

The Converter Adv. The Converter Drawbacks

19 © 2015 IBM Corporation

Both approaches have their pros and cons.

You have to decide which advantages and

20 © 2015 IBM Corporation

ENCRYPT OBJECT DATA

21 © 2015 IBM Corporation

22 © 2015 IBM Corporation

23 © 2015 IBM Corporation

24 © 2015 IBM Corporation

JAVA 8 DATE TIME API

25 © 2015 IBM Corporation

 A date without a time-zone in the ISO-8601 calendar system, such as 2007-12-03.

 LocalDate is an immutable date-time object that represents a date.

26 © 2015 IBM Corporation

27 © 2015 IBM Corporation

Why JPA not support LocalDate and LocalDateTime?

The answer is simple,

 Therefore the @Temporal annotation can only be applied

28 © 2015 IBM Corporation

30 © 2015 IBM Corporation

31 © 2015 IBM Corporation

 The attribute converter for LocalDateTime is basically the same.

 You need to implement the AttributeConverter<LocalDateTime, Timestamp> interface and

 Similar to the LocalDateConverter, the conversion between a LocalDateTime and an

32 © 2015 IBM Corporation

 This can be easily done by implementing the AttributeConverter<EntityType,

33 © 2015 IBM Corporation

DATA FETCHING STRATEGY

34 © 2015 IBM Corporation

 LAZY – load only when needed

 Lazy is good for large objects with deep relationship hierarchies

35 © 2015 IBM Corporation

 One-many/many-may relationships are lazy loaded by default

 Lazy load CLOB/BLOB if possible

 Accessing a LAZY relationship from a detached entity

36 © 2015 IBM Corporation

WAYS TO INITIALIZE LAZY

37 © 2015 IBM Corporation