io.crnk.jpa

Class JpaModule

java.lang.Object

io.crnk.jpa.JpaModule

All Implemented Interfaces:

io.crnk.core.module.Module

public class JpaModule
extends java.lang.Object
implements io.crnk.core.module.Module

Crnk module that adds support to expose JPA entities as repositories. It supports:

• Sorting
• Filtering
• Access to relationships for any operation (sorting, filtering, etc.)
• Includes for relationships
• Paging
• Mapping to DTOs
• Criteria API and QueryDSL support
• Computed attributes that map JPA Criteria/QueryDSL expressions to DTO attributes
• JpaRepositoryFilter to customize the repositories
• Client and server support
• No need for crnk annotations by default. Reads the entity annotations.

Not supported so far:

• Selection of fields, always all fields are returned.
• Sorting and filtering on related resources. Consider doing separate requests on the relations where necessary.

Nested Class Summary

Nested classes/interfaces inherited from interface io.crnk.core.module.Module

io.crnk.core.module.Module.ModuleContext

Method Summary

Modifier and Type	Method and Description
void	addFilter(JpaRepositoryFilter filter) Adds the given filter to this module.
<T> void	addRepository(JpaRepositoryConfig<T> config) Adds the resource to this module.
javax.persistence.EntityManager	getEntityManager()
javax.persistence.EntityManagerFactory	getEntityManagerFactory()
java.util.List<JpaRepositoryFilter>	getFilters()
io.crnk.meta.MetaLookup	getJpaMetaLookup()
java.lang.String	getModuleName()
JpaQueryFactory	getQueryFactory()
<T> JpaRepositoryConfig<T>	getRepositoryConfig(java.lang.Class<T> resourceClass)
java.util.Set<java.lang.Class<?>>	getResourceClasses()
io.crnk.core.engine.information.resource.ResourceInformationBuilder	getResourceInformationBuilder()
io.crnk.meta.MetaLookup	getResourceMetaLookup()
boolean	hasRepository(java.lang.Class<?> resourceClass)
static JpaModule	newClientModule() Creates a new JpaModule for a Crnk client.
static JpaModule	newServerModule(javax.persistence.EntityManagerFactory emFactory, javax.persistence.EntityManager em, io.crnk.core.engine.transaction.TransactionRunner transactionRunner) Creates a new JpaModule for a Crnk server.
static JpaModule	newServerModule(javax.persistence.EntityManager em, io.crnk.core.engine.transaction.TransactionRunner transactionRunner) Creates a new JpaModule for a Crnk server.
void	removeFilter(JpaRepositoryFilter filter) Removes the given filter to this module.
void	removeRepositories() Removes all entity classes registered by default.
<T> void	removeRepository(java.lang.Class<T> resourceClass) Removes the resource with the given type from this module.
void	setQueryFactory(JpaQueryFactory queryFactory)
void	setRepositoryFactory(JpaRepositoryFactory repositoryFactory)
void	setResourceInformationBuilder(io.crnk.core.engine.information.resource.ResourceInformationBuilder resourceInformationBuilder) Sets the information builder to use to read JPA classes.
void	setupModule(io.crnk.core.module.Module.ModuleContext context)
protected void	setupTransactionMgmt()

Methods inherited from class java.lang.Object

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

Method Detail

newClientModule

public static JpaModule newClientModule()

Creates a new JpaModule for a Crnk client.

Returns:

module

newServerModule

public static JpaModule newServerModule(javax.persistence.EntityManager em,
                                        io.crnk.core.engine.transaction.TransactionRunner transactionRunner)

Creates a new JpaModule for a Crnk server. No entities are by default exposed as JSON API resources. Make use of #addEntityClass(Class) andd #addMappedEntityClass(Class, Class, JpaMapper) to add resources.

Parameters:

em - to use

transactionRunner - to use

Returns:

created module

newServerModule

public static JpaModule newServerModule(javax.persistence.EntityManagerFactory emFactory,
                                        javax.persistence.EntityManager em,
                                        io.crnk.core.engine.transaction.TransactionRunner transactionRunner)

Creates a new JpaModule for a Crnk server. All entities managed by the provided EntityManagerFactory are registered to the module and exposed as JSON API resources if not later configured otherwise.

Parameters:

emFactory - to retrieve the managed entities.

em - to use

transactionRunner - to use

Returns:

created module

addFilter

public void addFilter(JpaRepositoryFilter filter)

Adds the given filter to this module. Filter will be used by all repositories managed by this module.

Parameters:

filter - to add

removeFilter

public void removeFilter(JpaRepositoryFilter filter)

Removes the given filter to this module.

Parameters:

filter - to remove

getFilters

public java.util.List<JpaRepositoryFilter> getFilters()

Returns:

all filters

setRepositoryFactory

public void setRepositoryFactory(JpaRepositoryFactory repositoryFactory)

getResourceClasses

public java.util.Set<java.lang.Class<?>> getResourceClasses()

Returns:

set of resource classes made available as resource (entity or dto).

addRepository

public <T> void addRepository(JpaRepositoryConfig<T> config)

Adds the resource to this module.

Parameters:

configuration - to use

removeRepository

public <T> void removeRepository(java.lang.Class<T> resourceClass)

Removes the resource with the given type from this module.

Type Parameters:

D - resourse class (entity or mapped dto)

Parameters:

resourceClass - to remove

removeRepositories

public void removeRepositories()

Removes all entity classes registered by default. Use #addEntityClass(Class) or #addMappedEntityClass(Class, Class, JpaMapper) to register classes manually.

getModuleName

public java.lang.String getModuleName()

Specified by:

getModuleName in interface io.crnk.core.module.Module

setupModule

public void setupModule(io.crnk.core.module.Module.ModuleContext context)

Specified by:

setupModule in interface io.crnk.core.module.Module

setupTransactionMgmt

protected void setupTransactionMgmt()

getResourceInformationBuilder

public io.crnk.core.engine.information.resource.ResourceInformationBuilder getResourceInformationBuilder()

Returns:

ResourceInformationBuilder used to describe JPA classes.

setResourceInformationBuilder

public void setResourceInformationBuilder(io.crnk.core.engine.information.resource.ResourceInformationBuilder resourceInformationBuilder)

Sets the information builder to use to read JPA classes. See JpaResourceInformationBuilder}

Parameters:

resourceInformationBuilder -

getQueryFactory

public JpaQueryFactory getQueryFactory()

Returns:

JpaQueryFactory} implementation used to create JPA queries.

setQueryFactory

public void setQueryFactory(JpaQueryFactory queryFactory)

getEntityManager

public javax.persistence.EntityManager getEntityManager()

Returns:

EntityManager} in use.

getEntityManagerFactory

public javax.persistence.EntityManagerFactory getEntityManagerFactory()

Returns:

EntityManagerFactory} in use.

getRepositoryConfig

public <T> JpaRepositoryConfig<T> getRepositoryConfig(java.lang.Class<T> resourceClass)

Parameters:

resourceClass -

Returns:

config

getJpaMetaLookup

public io.crnk.meta.MetaLookup getJpaMetaLookup()

getResourceMetaLookup

public io.crnk.meta.MetaLookup getResourceMetaLookup()

hasRepository

public boolean hasRepository(java.lang.Class<?> resourceClass)

Parameters:

resourceClass -

Returns:

true if a resource for the given resourceClass is managed by this module.