play.db.jpa

Class JPAPlugin

java.lang.Object

play.PlayPlugin

play.db.jpa.JPAPlugin

All Implemented Interfaces:

java.lang.Comparable<PlayPlugin>

public class JPAPlugin
extends PlayPlugin

JPA Plugin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JPAPlugin.JPAModelLoader
class	JPAPlugin.TransactionalFilter

Nested classes/interfaces inherited from class play.PlayPlugin

PlayPlugin.Filter<T>

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	autoTxs

Fields inherited from class play.PlayPlugin

index

Constructor Summary

Constructors

Constructor and Description
JPAPlugin()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterFixtureLoad()
void	afterInvocation() Called after an invocation.
java.lang.Object	bind(RootParamNode rootParamNode, java.lang.String name, java.lang.Class clazz, java.lang.reflect.Type type, java.lang.annotation.Annotation[] annotations) Called when play need to bind a Java object from HTTP params.
java.lang.Object	bindBean(RootParamNode rootParamNode, java.lang.String name, java.lang.Object bean) Called when play need to bind an existing Java object from HTTP params.
static void	closeTx(boolean rollback) clear current JPA context and transaction
static EntityManager	createEntityManager()
EntityManager	em(java.lang.String key)
void	enhance(ApplicationClasses.ApplicationClass applicationClass) Enhance this class
static java.lang.String	getDefaultDialect(java.util.Properties p, java.lang.String dbName, java.lang.String driver)
static java.lang.String	getDefaultDialect(java.lang.String driver)
PlayPlugin.Filter	getFilter() Return the filter implementation for this plugin.
Model.Factory	modelFactory(java.lang.Class<? extends Model> modelClass)
void	onApplicationStart() Reads the configuration file and initialises required JPA EntityManagerFactories.
void	onApplicationStop() Called at application stop (and before each reloading) Time to shutdown stateful things.
void	onConfigurationRead() Called when the application.conf has been read.
static void	startTx(boolean readonly) initialize the JPA context and starts a JPA transaction

Methods inherited from class play.PlayPlugin

addMimeTypes, addTemplateExtensions, afterActionInvocation, afterApplicationStart, beforeActionInvocation, beforeDetectingChanges, beforeInvocation, bind, bind, compareTo, compileAll, compileSources, detectChange, detectClassesChange, getFunctionalTests, getJsonStatus, getMessage, getStatus, getUnitTests, invocationFinally, loadTemplate, onActionInvocationResult, onApplicationReady, onClassesChange, onEvent, onInvocationException, onInvocationSuccess, onLoad, onRequestRouting, onRoutesLoaded, onTemplateCompilation, overrideTemplateSource, postEvent, rawInvocation, routeRequest, runTest, serveStatic, unBind, willBeValidated

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

autoTxs

public static boolean autoTxs

Constructor Detail

JPAPlugin

public JPAPlugin()

Method Detail

bind

public java.lang.Object bind(RootParamNode rootParamNode,
                    java.lang.String name,
                    java.lang.Class clazz,
                    java.lang.reflect.Type type,
                    java.lang.annotation.Annotation[] annotations)

Description copied from class: PlayPlugin

Called when play need to bind a Java object from HTTP params. When overriding this method, do not call super impl.. super impl is calling old bind method to be backward compatible.

Overrides:

bind in class PlayPlugin

bindBean

public java.lang.Object bindBean(RootParamNode rootParamNode,
                        java.lang.String name,
                        java.lang.Object bean)

Description copied from class: PlayPlugin

Called when play need to bind an existing Java object from HTTP params. When overriding this method, DO NOT call the super method, since its default impl is to call the old bind method to be backward compatible.

Overrides:

bindBean in class PlayPlugin

enhance

public void enhance(ApplicationClasses.ApplicationClass applicationClass)
             throws java.lang.Exception

Description copied from class: PlayPlugin

Enhance this class

Overrides:

enhance in class PlayPlugin

Throws:

java.lang.Exception

onConfigurationRead

public void onConfigurationRead()

Description copied from class: PlayPlugin

Called when the application.conf has been read.

Overrides:

onConfigurationRead in class PlayPlugin

em

public EntityManager em(java.lang.String key)

onApplicationStart

public void onApplicationStart()

Reads the configuration file and initialises required JPA EntityManagerFactories.

Overrides:

onApplicationStart in class PlayPlugin

getDefaultDialect

public static java.lang.String getDefaultDialect(java.lang.String driver)

getDefaultDialect

public static java.lang.String getDefaultDialect(java.util.Properties p,
                                 java.lang.String dbName,
                                 java.lang.String driver)

onApplicationStop

public void onApplicationStop()

Description copied from class: PlayPlugin

Called at application stop (and before each reloading) Time to shutdown stateful things.

Overrides:

onApplicationStop in class PlayPlugin

afterFixtureLoad

public void afterFixtureLoad()

Overrides:

afterFixtureLoad in class PlayPlugin

afterInvocation

public void afterInvocation()

Description copied from class: PlayPlugin

Called after an invocation. (unless an excetion has been thrown). Time to close request specific things.

Overrides:

afterInvocation in class PlayPlugin

getFilter

public PlayPlugin.Filter getFilter()

Description copied from class: PlayPlugin

Return the filter implementation for this plugin.

Overrides:

getFilter in class PlayPlugin

createEntityManager

public static EntityManager createEntityManager()

startTx

public static void startTx(boolean readonly)

initialize the JPA context and starts a JPA transaction

Parameters:

readonly - true for a readonly transaction

autoCommit - true to automatically commit the DB transaction after each JPA statement

closeTx

public static void closeTx(boolean rollback)

clear current JPA context and transaction

Parameters:

rollback - shall current transaction be committed (false) or cancelled (true)

modelFactory

public Model.Factory modelFactory(java.lang.Class<? extends Model> modelClass)

Overrides:

modelFactory in class PlayPlugin