io.katharsis.jpa

Class JpaModule

java.lang.Object

io.katharsis.jpa.JpaModule

All Implemented Interfaces:

Module

public class JpaModule
extends Object
implements Module

Katharsis 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 katharsis 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.katharsis.module.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 repository to this module.
javax.persistence.EntityManager	getEntityManager()
javax.persistence.EntityManagerFactory	getEntityManagerFactory()
List<JpaRepositoryFilter>	getFilters()
MetaLookup	getJpaMetaLookup()
String	getModuleName()
JpaQueryFactory	getQueryFactory()
<T> JpaRepositoryConfig<T>	getRepositoryConfig(Class<T> resourceClass)
Set<Class<?>>	getResourceClasses()
ResourceInformationBuilder	getResourceInformationBuilder()
MetaLookup	getResourceMetaLookup()
static JpaModule	newClientModule() Creates a new JpaModule for a Katharsis client.
static JpaModule	newClientModule(String resourceSearchPackage) Deprecated.
static JpaModule	newServerModule(javax.persistence.EntityManagerFactory emFactory, javax.persistence.EntityManager em, TransactionRunner transactionRunner) Creates a new JpaModule for a Katharsis server.
static JpaModule	newServerModule(javax.persistence.EntityManager em, TransactionRunner transactionRunner) Creates a new JpaModule for a Katharsis server.
void	removeFilter(JpaRepositoryFilter filter) Removes the given filter to this module.
void	removeRepositories() Removes all entity classes registered by default.
<T> void	removeRepository(Class<T> resourceClass) Removes the repository with the given type from this module.
void	setQueryFactory(JpaQueryFactory queryFactory)
void	setRepositoryFactory(JpaRepositoryFactory repositoryFactory)
void	setupModule(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 Katharsis client.

Returns:

module

newClientModule

@Deprecated
public static JpaModule newClientModule(String resourceSearchPackage)

Deprecated.

Creates a new JpaModule for a Katharsis client.

Parameters:

resourceSearchPackage - where to find the entity classes. Has no impact anymore.

Returns:

module

newServerModule

public static JpaModule newServerModule(javax.persistence.EntityManager em,
                                        TransactionRunner transactionRunner)

Creates a new JpaModule for a Katharsis 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,
                                        TransactionRunner transactionRunner)

Creates a new JpaModule for a Katharsis 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 List<JpaRepositoryFilter> getFilters()

Returns:

all filters

setRepositoryFactory

public void setRepositoryFactory(JpaRepositoryFactory repositoryFactory)

getResourceClasses

public Set<Class<?>> getResourceClasses()

Returns:

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

addRepository

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

Adds the repository to this module.

Parameters:

configuration - to use

removeRepository

public <T> void removeRepository(Class<T> resourceClass)

Removes the repository 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 String getModuleName()

Specified by:

getModuleName in interface Module

setupModule

public void setupModule(Module.ModuleContext context)

Specified by:

setupModule in interface Module

setupTransactionMgmt

protected void setupTransactionMgmt()

getResourceInformationBuilder

public ResourceInformationBuilder getResourceInformationBuilder()

Returns:

ResourceInformationBuilder used to describe JPA entity classes.

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(Class<T> resourceClass)

Parameters:

resourceClass -

Returns:

config

getJpaMetaLookup

public MetaLookup getJpaMetaLookup()

getResourceMetaLookup

public MetaLookup getResourceMetaLookup()