BaseEntityService (OmniPersistence 0.7 API)

java.lang.Object
- org.omnifaces.persistence.service.BaseEntityService<I,E>

Type Parameters:

I - The generic ID type.

E - The generic base entity type.
```
public abstract class BaseEntityService & Serializable,E extends BaseEntity>
extends Object
```
Base entity service. Let your Stateless service classes extend from this. Ideally, you would not anymore have the need to inject the EntityManager in your service class and it would suffice to just delegate all persistence actions to methods of this abstract class.
You only need to let your entities extend from one of the following mapped super classes:
Logging

BaseEntityService uses JULI Logger for logging.
- Level.FINER will log the getPage(Page, boolean) arguments, the set parameter values and the full query result.
- Level.FINE will log computed type mapping (the actual values of I and E type paramters), and whether the ID is generated, and whether the entity is soft deletable, and any discovered ElementCollection, ManyToOne, OneToOne and OneToMany mappings of the entity. This is internally used in order to be able to build proper queries to perform a search inside those fields.
- Level.WARNING will log unparseable or illegal criteria values. The BaseEntityService will skip them and continue.
- Level.SEVERE will log constraint violations wrapped in any ConstraintViolationException during persist(BaseEntity) and update(BaseEntity). Due to technical limitations, it will during update() only happen when javax.persistence.validation.mode property in persistence.xml is explicitly set to CALLBACK (and thus not to its default of AUTO).
See Also:

BaseEntity, Page, Criteria

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static interface`	`BaseEntityService.MappedQueryBuilder<T>` Functional interface to fine-grain a JPA criteria query for any of `getPage(Page, boolean)` methods taking a specific result type, such as an entity subclass (DTO).
`protected static interface`	`BaseEntityService.QueryBuilder<E>` Functional interface to fine-grain a JPA criteria query for any of `getPage(Page, boolean)` methods.

Constructor Summary

Constructors
Constructor and Description

BaseEntityService()
The constructor initializes the type mapping.

Constructors
Constructor and Description
`BaseEntityService()` The constructor initializes the type mapping.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Consumer<EntityManager>`	`afterPage()` Here you can in your `BaseEntityService` subclass define the callback method which needs to be invoked after any of `getPage(Page, boolean)` methods is called.
`protected Consumer<EntityManager>`	`beforePage()` Here you can in your `BaseEntityService` subclass define the callback method which needs to be invoked before any of `getPage(Page, boolean)` methods is called.
`protected long`	`countForeignKeyReferencesTo(E entity)` Returns count of all foreign key references to given entity.
`protected Query`	`createNamedQuery(String name)` Create an instance of `Query` for executing a Java Persistence Query Language statement identified by the given name, usually to perform an INSERT, UPDATE or DELETE.
`protected TypedQuery<E>`	`createNamedTypedQuery(String name)` Create an instance of `TypedQuery` for executing a Java Persistence Query Language statement identified by the given name, usually to perform a SELECT.
`void`	`delete(E entity)` Delete given entity.
`void`	`delete(Iterable<E> entities)` Delete given entities.
`protected boolean`	`exists(E entity)` Check whether given entity exists.
`protected E`	`fetchLazyBlobs(E entity)` Fetch all lazy blobs of given entity.
`protected Optional<E>`	`fetchLazyBlobs(Optional<E> entity)` Fetch all lazy blobs of given optional entity.
`protected E`	`fetchLazyCollections(E entity, Function<E,Collection<?>>... getters)` Fetch lazy collections of given entity on given getters.
`protected Optional<E>`	`fetchLazyCollections(Optional<E> entity, Function<E,Collection<?>>... getters)` Fetch lazy collections of given optional entity on given getters.
`protected E`	`fetchLazyMaps(E entity, Function<E,Map<?,?>>... getters)` Fetch lazy maps of given entity on given getters.
`protected Optional<E>`	`fetchLazyMaps(Optional<E> entity, Function<E,Map<?,?>>... getters)` Fetch lazy maps of given optional entity on given getters.
`protected Optional<E>`	`find(String jpql, Consumer<Map<String,Object>> parameters)` Find entity by given query and parameters.
`Optional<E>`	`findById(I id)` Find entity by given ID.
`protected Optional<E>`	`findById(I id, boolean includeSoftDeleted)` Find entity by given ID and set whether it may return a soft deleted one.
`Optional<E>`	`findSoftDeletedById(I id)` Find soft deleted entity by given ID.
`List<E>`	`getAll()` Get all entities.
`protected List<E>`	`getAll(boolean includeSoftDeleted)` Get all entities and set whether it may include soft deleted ones.
`List<E>`	`getAllSoftDeleted()` Get all entities that have been soft deleted.
`E`	`getById(I id)` Get entity by given ID.
`protected E`	`getById(I id, boolean includeSoftDeleted)` Get entity by given ID and set whether it may return a soft deleted one.
`static BaseEntityService<?,?>`	`getCurrentInstance()` Returns the currently active `BaseEntityService` from the `SessionContext`.
`Database`	`getDatabase()` Returns the SQL database being used.
`protected EntityManager`	`getEntityManager()` Returns the entity manager being used.
`protected Class<E>`	`getEntityType()` Returns the actual type of the generic base entity type `E`.
`protected Class<I>`	`getIdentifierType()` Returns the actual type of the generic ID type `I`.
`protected List<E>`	`getList(String jpql, Consumer<Map<String,Object>> parameters)` Get all entities matching the given query and query parameters.
`protected EntityType<E>`	`getMetamodel()` Returns the metamodel of current base entity.
`<I extends Comparable<I> & Serializable,E extends BaseEntity<I>> EntityType<E>`	`getMetamodel(E entity)` Returns the metamodel of given base entity.
`org.omnifaces.utils.collection.PartialResultList<E>`	`getPage(Page page, boolean count)` Returns a partial result list based on given `Page`.
`protected org.omnifaces.utils.collection.PartialResultList<E>`	`getPage(Page page, boolean count, BaseEntityService.QueryBuilder<E> queryBuilder)` Returns a partial result list based on given `Page` and `BaseEntityService.QueryBuilder`.
`protected org.omnifaces.utils.collection.PartialResultList<E>`	`getPage(Page page, boolean count, boolean cacheable, BaseEntityService.QueryBuilder<E> queryBuilder)` Returns a partial result list based on given `Page`, entity type and `BaseEntityService.QueryBuilder`.
`protected <T extends E> org.omnifaces.utils.collection.PartialResultList<T>`	`getPage(Page page, boolean count, boolean cacheable, Class<T> resultType, BaseEntityService.MappedQueryBuilder<T> queryBuilder)` Returns a partial result list based on given `Page`, entity type and `BaseEntityService.QueryBuilder`.
`protected org.omnifaces.utils.collection.PartialResultList<E>`	`getPage(Page page, boolean count, boolean cacheable, String... fetchFields)` Returns a partial result list based on given `Page`.
`protected <T extends E> org.omnifaces.utils.collection.PartialResultList<T>`	`getPage(Page page, boolean count, Class<T> resultType, BaseEntityService.MappedQueryBuilder<T> mappedQueryBuilder)` Returns a partial result list based on given `Page`, result type and `BaseEntityService.MappedQueryBuilder`.
`org.omnifaces.utils.collection.PartialResultList<E>`	`getPage(Page page, boolean count, String... fetchFields)` Returns a partial result list based on given `Page` and fetch fields.
`Provider`	`getProvider()` Returns the JPA provider being used.
`E`	`getSoftDeletedById(I id)` Get soft deleted entity by given ID.
`protected boolean`	`isGeneratedId()` Returns whether the ID is generated.
`protected E`	`manage(E entity)` Make given entity managed.
`protected Consumer<TypedQuery<?>>`	`onPage(Page page, boolean cacheable)` Here you can in your `BaseEntityService` subclass define the callback method which needs to be invoked when any query involved in `getPage(Page, boolean)` is about to be executed.
`I`	`persist(E entity)` Persist given entity.
`void`	`reset(E entity)` Reset given entity.
`E`	`save(E entity)` Save given entity.
`void`	`softDelete(E entity)` Soft delete given entity.
`void`	`softDelete(Iterable<E> entities)` Soft delete given entities.
`void`	`softUndelete(E entity)` Soft undelete given entity.
`void`	`softUndelete(Iterable<E> entities)` Soft undelete given entities.
`E`	`update(E entity)` Update given entity.
`List<E>`	`update(Iterable<E> entities)` Update given entities.
`protected int`	`update(String jpql, Consumer<Map<String,Object>> parameters)` Update or delete all entities matching the given query and query parameters.
`protected E`	`updateAndFlush(E entity)` Update given entity via `update(BaseEntity)` and immediately perform a flush so that all changes in managed entities so far in the current transaction are persisted.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
 - BaseEntityService
```
public BaseEntityService()
```
 The constructor initializes the type mapping. The I and E will be resolved to a concrete Class<?>.
- Method Detail
 - getProvider
```
public Provider getProvider()
```
 Returns the JPA provider being used. This is immutable (you can't override the method to change the value).
 
 Returns:
 
 The JPA provider being used.
 - getDatabase
```
public Database getDatabase()
```
 Returns the SQL database being used. This is immutable (you can't override the method to change the value).
 
 Returns:
 
 The SQL database being used.
 - getIdentifierType
```
protected Class getIdentifierType()
```
 Returns the actual type of the generic ID type I. This is immutable (you can't override the method to change the value).
 
 Returns:
 
 The actual type of the generic ID type I.
 - getEntityType
```
protected Class<E> getEntityType()
```
 Returns the actual type of the generic base entity type E. This is immutable (you can't override the method to change the value).
 
 Returns:
 
 The actual type of the generic base entity type E.
 - isGeneratedId
```
protected boolean isGeneratedId()
```
 Returns whether the ID is generated. This is immutable (you can't override the method to change the value).
 
 Returns:
 
 Whether the ID is generated.
 - getMetamodel
```
protected EntityType<E> getMetamodel()
```
 Returns the metamodel of current base entity.
 
 Returns:
 
 The metamodel of current base entity.
 - getMetamodel
```
public  & Serializable,E extends BaseEntity> EntityType<E> getMetamodel(E entity)
```
 Returns the metamodel of given base entity.
 
 Type Parameters:
 
 I - The generic ID type of the given base entity.
 
 E - The generic base entity type of the given base entity.
 
 Parameters:
 
 entity - Base entity to obtain metamodel for.
 
 Returns:
 
 The metamodel of given base entity.
 - getEntityManager
```
protected EntityManager getEntityManager()
```
 Returns the entity manager being used. When you have only one persistence unit, then you don't need to override this. When you have multiple persistence units, then you need to extend the BaseEntityService like below wherein you supply the persistence unit specific entity manager and then let all your service classes extend from it instead.
```
 public abstract class YourBaseEntityService<E extends BaseEntity<Long>> extends BaseEntityService<Long, E> {

 @PersistenceContext(unitName = "yourPersistenceUnitName")
 private EntityManager entityManager;

 @Override
 public EntityManager getEntityManager() {
 return entityManager;
 }

 }
 
```
 Returns:
 
 The entity manager being used.
 - createNamedTypedQuery
```
protected TypedQuery<E> createNamedTypedQuery(String name)
```
 Create an instance of TypedQuery for executing a Java Persistence Query Language statement identified by the given name, usually to perform a SELECT.
 
 Parameters:
 
 name - The name of the Java Persistence Query Language statement defined in metadata, which can be either a NamedQuery or a <persistence-unit><mapping-file>.
 
 Returns:
 
 An instance of TypedQuery for executing a Java Persistence Query Language statement identified by the given name, usually to perform a SELECT.
 - createNamedQuery
```
protected Query createNamedQuery(String name)
```
 Create an instance of Query for executing a Java Persistence Query Language statement identified by the given name, usually to perform an INSERT, UPDATE or DELETE.
 
 Parameters:
 
 name - The name of the Java Persistence Query Language statement defined in metadata, which can be either a NamedQuery or a <persistence-unit><mapping-file>.
 
 Returns:
 
 An instance of Query for executing a Java Persistence Query Language statement identified by the given name, usually to perform an INSERT, UPDATE or DELETE.
 - find
```
protected Optional<E> find(String jpql,
 Consumer<Map<String,Object>> parameters)
```
 Find entity by given query and parameters.
 
 Parameters:
 
 jpql - The Java Persistence Query Language statement.
 
 parameters - To put the query parameters in.
 
 Returns:
 
 Found entity matching given query and parameters, if any.
 
 Throws:
 
 IllegalArgumentException - When more than one entity is found matching given query and parameters.
 - findById
```
public Optional<E> findById(I id)
```
 Find entity by given ID. This does not include soft deleted one.
 
 Parameters:
 
 id - Entity ID to find entity for.
 
 Returns:
 
 Found entity, if any.
 - findById
```
protected Optional<E> findById(I id,
 boolean includeSoftDeleted)
```
 Find entity by given ID and set whether it may return a soft deleted one.
 
 Parameters:
 
 id - Entity ID to find entity for.
 
 includeSoftDeleted - Whether to include soft deleted ones in the search.
 
 Returns:
 
 Found entity, if any.
 - findSoftDeletedById
```
public Optional<E> findSoftDeletedById(I id)
```
 Find soft deleted entity by given ID.
 
 Parameters:
 
 id - Entity ID to find soft deleted entity for.
 
 Returns:
 
 Found soft deleted entity, if any.
 
 Throws:
 
 NonSoftDeletableEntityException - When entity doesn't have SoftDeletable annotation set on any of its fields.
 - getById
```
public E getById(I id)
```
 Get entity by given ID. This does not include soft deleted one.
 
 Parameters:
 
 id - Entity ID to get entity by.
 
 Returns:
 
 Found entity, or null if there is none.
 - getById
```
protected E getById(I id,
 boolean includeSoftDeleted)
```
 Get entity by given ID and set whether it may return a soft deleted one.
 
 Parameters:
 
 id - Entity ID to get entity by.
 
 includeSoftDeleted - Whether to include soft deleted ones in the search.
 
 Returns:
 
 Found entity, or null if there is none.
 - getSoftDeletedById
```
public E getSoftDeletedById(I id)
```
 Get soft deleted entity by given ID.
 
 Parameters:
 
 id - Entity ID to get soft deleted entity by.
 
 Returns:
 
 Found soft deleted entity, or null if there is none.
 
 Throws:
 
 NonSoftDeletableEntityException - When entity doesn't have SoftDeletable annotation set on any of its fields.
 - exists
```
protected boolean exists(E entity)
```
 Check whether given entity exists.
 
 Parameters:
 
 entity - Entity to check.
 
 Returns:
 
 Whether entity with given entity exists.
 - getList
```
protected List<E> getList(String jpql,
 Consumer<Map<String,Object>> parameters)
```
 Get all entities matching the given query and query parameters.
 
 Parameters:
 
 jpql - The Java Persistence Query Language statement.
 
 parameters - To put the query parameters in.
 
 Returns:
 
 All entities matching the given query and query parameters.
 - getAll
```
public List<E> getAll()
```
 Get all entities. The default ordering is by ID, descending. This does not include soft deleted entities.
 
 Returns:
 
 All entities.
 - getAll
```
protected List<E> getAll(boolean includeSoftDeleted)
```
 Get all entities and set whether it may include soft deleted ones. The default ordering is by ID, descending.
 
 Parameters:
 
 includeSoftDeleted - Whether to include soft deleted ones in the search.
 
 Returns:
 
 All entities, optionally including soft deleted ones.
 
 Throws:
 
 NonSoftDeletableEntityException - When entity doesn't have SoftDeletable annotation set on any of its fields.
 - getAllSoftDeleted
```
public List<E> getAllSoftDeleted()
```
 Get all entities that have been soft deleted. The default ordering is by ID, descending.
 
 Returns:
 
 All soft deleted entities.
 
 Throws:
 
 NonSoftDeletableEntityException - When entity doesn't have SoftDeletable annotation set on any of its fields.
 - persist
```
public I persist(E entity)
```
 Persist given entity. Any bean validation constraint violation will be logged separately.
 
 Parameters:
 
 entity - Entity to persist.
 
 Returns:
 
 Entity ID.
 
 Throws:
 
 IllegalEntityStateException - When entity is already persisted or its ID is not generated.
 - update
```
public E update(E entity)
```
 Update given entity. If javax.persistence.validation.mode property in persistence.xml is explicitly set to CALLBACK (and thus not to its default of AUTO), then any bean validation constraint violation will be logged separately. Due to technical limitations, this effectively means that bean validation is invoked twice. First in this method in order to be able to obtain the constraint violations and then once more while JTA is committing the transaction, but is executed beyond the scope of this method.
 
 Parameters:
 
 entity - Entity to update.
 
 Returns:
 
 Updated entity.
 
 Throws:
 
 IllegalEntityStateException - When entity is not persisted or its ID is not generated.
 - updateAndFlush
```
protected E updateAndFlush(E entity)
```
 Update given entity via update(BaseEntity) and immediately perform a flush so that all changes in managed entities so far in the current transaction are persisted. This is particularly useful when you intend to process the given entity further in an asynchronous service method.
 
 Parameters:
 
 entity - Entity to update.
 
 Returns:
 
 Updated entity.
 
 Throws:
 
 IllegalEntityStateException - When entity is not persisted or its ID is not generated.
 - update
```
public List<E> update(Iterable<E> entities)
```
 Update given entities.
 
 Parameters:
 
 entities - Entities to update.
 
 Returns:
 
 Updated entities.
 
 Throws:
 
 IllegalEntityStateException - When at least one entity has no ID.
 - update
```
protected int update(String jpql,
 Consumer<Map<String,Object>> parameters)
```
 Update or delete all entities matching the given query and query parameters.
 
 Parameters:
 
 jpql - The Java Persistence Query Language statement.
 
 parameters - To put the query parameters in.
 
 Returns:
 
 The number of entities updated or deleted.
 
 See Also:
 
 Query.executeUpdate()
 - save
```
public E save(E entity)
```
 Save given entity. This will automatically determine based on the presence of generated entity ID, or existence of an entity in the data store whether to persist(BaseEntity) or to update(BaseEntity).
 
 Parameters:
 
 entity - Entity to save.
 
 Returns:
 
 Saved entity.
 - reset
```
public void reset(E entity)
```
 Reset given entity. This will discard any changes in given entity. The given entity must be unmanaged/detached. The actual intent of this method is to have the opportunity to completely reset the state of a given entity which might have been edited in the client, without changing the reference. This is generally useful when the entity is in turn held in some collection and you'd rather not manually remove and reinsert it in the collection.
 
 Parameters:
 
 entity - Entity to reset.
 
 Throws:
 
 IllegalEntityStateException - When entity has no ID.
 
 EntityNotFoundException - When entity has in meanwhile been deleted.
 - delete
```
public void delete(E entity)
```
 Delete given entity.
 
 Parameters:
 
 entity - Entity to delete.
 
 Throws:
 
 NonDeletableEntityException - When entity has NonDeletable annotation set.
 
 IllegalEntityStateException - When entity has no ID.
 
 EntityNotFoundException - When entity has in meanwhile been deleted.
 - softDelete
```
public void softDelete(E entity)
```
 Soft delete given entity.
 
 Parameters:
 
 entity - Entity to soft delete.
 
 Throws:
 
 NonSoftDeletableEntityException - When entity doesn't have SoftDeletable annotation set on any of its fields.
 
 IllegalEntityStateException - When entity has no ID.
 
 EntityNotFoundException - When entity has in meanwhile been hard deleted.
 - softUndelete
```
public void softUndelete(E entity)
```
 Soft undelete given entity.
 
 Parameters:
 
 entity - Entity to soft undelete.
 
 Throws:
 
 NonSoftDeletableEntityException - When entity doesn't have SoftDeletable annotation set on any of its fields.
 
 IllegalEntityStateException - When entity has no ID.
 
 EntityNotFoundException - When entity has in meanwhile been hard deleted.
 - delete
```
public void delete(Iterable<E> entities)
```
 Delete given entities.
 
 Parameters:
 
 entities - Entities to delete.
 
 Throws:
 
 NonDeletableEntityException - When at least one entity has NonDeletable annotation set.
 
 IllegalEntityStateException - When at least one entity has no ID.
 
 EntityNotFoundException - When at least one entity has in meanwhile been deleted.
 - softDelete
```
public void softDelete(Iterable<E> entities)
```
 Soft delete given entities.
 
 Parameters:
 
 entities - Entities to soft delete.
 
 Throws:
 
 NonSoftDeletableEntityException - When entity doesn't have SoftDeletable annotation set on any of its fields.
 
 IllegalEntityStateException - When at least one entity has no ID.
 
 EntityNotFoundException - When at least one entity has in meanwhile been hard deleted.
 - softUndelete
```
public void softUndelete(Iterable<E> entities)
```
 Soft undelete given entities.
 
 Parameters:
 
 entities - Entities to soft undelete.
 
 Throws:
 
 NonSoftDeletableEntityException - When entity doesn't have SoftDeletable annotation set on any of its fields.
 
 IllegalEntityStateException - When at least one entity has no ID.
 
 EntityNotFoundException - When at least one entity has in meanwhile been hard deleted.
 - manage
```
protected E manage(E entity)
```
 Make given entity managed. NOTE: This will discard any changes in the given entity! This is particularly useful in case you intend to make sure that you have the most recent version at hands.
 
 Parameters:
 
 entity - Entity to manage.
 
 Returns:
 
 The managed entity.
 
 Throws:
 
 IllegalEntityStateException - When entity has no ID.
 
 EntityNotFoundException - When entity has in meanwhile been deleted.
 - countForeignKeyReferencesTo
```
protected long countForeignKeyReferencesTo(E entity)
```
 Returns count of all foreign key references to given entity. This is particularly useful in case you intend to check if the given entity is still referenced elsewhere in database.
 
 Parameters:
 
 entity - Entity to count all foreign key references for.
 
 Returns:
 
 Count of all foreign key references to given entity.
 - fetchLazyCollections
```
protected E fetchLazyCollections(E entity,
 Function<E,Collection<?>>... getters)
```
 Fetch lazy collections of given entity on given getters. If no getters are supplied, then it will fetch every single PluralAttribute not of type PluralAttribute.CollectionType.MAP. Note that the implementation does for simplicitly not check if those are actually lazy or eager.
 
 Parameters:
 
 entity - Entity instance to fetch lazy collections on.
 
 getters - Getters of those lazy collections.
 
 Returns:
 
 The same entity, useful if you want to continue using it immediately.
 - fetchLazyCollections
```
protected Optional<E> fetchLazyCollections(Optional<E> entity,
 Function<E,Collection<?>>... getters)
```
 Fetch lazy collections of given optional entity on given getters. If no getters are supplied, then it will fetch every single PluralAttribute not of type PluralAttribute.CollectionType.MAP. Note that the implementation does for simplicitly not check if those are actually lazy or eager.
 
 Parameters:
 
 entity - Optional entity instance to fetch lazy collections on.
 
 getters - Getters of those lazy collections.
 
 Returns:
 
 The same optional entity, useful if you want to continue using it immediately.
 - fetchLazyMaps
```
protected E fetchLazyMaps(E entity,
 Function<E,Map<?,?>>... getters)
```
 Fetch lazy maps of given entity on given getters. If no getters are supplied, then it will fetch every single PluralAttribute of type PluralAttribute.CollectionType.MAP. Note that the implementation does for simplicitly not check if those are actually lazy or eager.
 
 Parameters:
 
 entity - Entity instance to fetch lazy maps on.
 
 getters - Getters of those lazy collections.
 
 Returns:
 
 The same entity, useful if you want to continue using it immediately.
 - fetchLazyMaps
```
protected Optional<E> fetchLazyMaps(Optional<E> entity,
 Function<E,Map<?,?>>... getters)
```
 Fetch lazy maps of given optional entity on given getters. If no getters are supplied, then it will fetch every single PluralAttribute of type PluralAttribute.CollectionType.MAP. Note that the implementation does for simplicitly not check if those are actually lazy or eager.
 
 Parameters:
 
 entity - Optional entity instance to fetch lazy maps on.
 
 getters - Getters of those lazy collections.
 
 Returns:
 
 The same optional entity, useful if you want to continue using it immediately.
 - fetchLazyBlobs
```
protected E fetchLazyBlobs(E entity)
```
 Fetch all lazy blobs of given entity. Note that the implementation does for simplicitly not check if those are actually lazy or eager.
 
 Parameters:
 
 entity - Entity instance to fetch all blobs on.
 
 Returns:
 
 The same entity, useful if you want to continue using it immediately.
 - fetchLazyBlobs
```
protected Optional<E> fetchLazyBlobs(Optional<E> entity)
```
 Fetch all lazy blobs of given optional entity. Note that the implementation does for simplicitly not check if those are actually lazy or eager.
 
 Parameters:
 
 entity - Optional entity instance to fetch all blobs on.
 
 Returns:
 
 The same optional entity, useful if you want to continue using it immediately.
 - beforePage
```
protected Consumer<EntityManager> beforePage()
```
 Here you can in your BaseEntityService subclass define the callback method which needs to be invoked before any of getPage(Page, boolean) methods is called. For example, to set a vendor specific EntityManager hint. The default implementation returns a no-op callback.
 
 Returns:
 
 The callback method which is invoked before any of getPage(Page, boolean) methods is called.
 - onPage
```
protected Consumer<TypedQuery<?>> onPage(Page page,
 boolean cacheable)
```
 Here you can in your BaseEntityService subclass define the callback method which needs to be invoked when any query involved in getPage(Page, boolean) is about to be executed. For example, to set a vendor specific Query hint. The default implementation sets Hibernate, EclipseLink and JPA 2.0 cache-related hints. When cacheable argument is true, then it reads from cache where applicable, else it will read from DB and force a refresh of cache. Note that this is not supported by OpenJPA. Additionally, the default implementation sets Hibernate cache region identifier to Page.toString().
 
 Parameters:
 
 page - The page on which this query is based.
 
 cacheable - Whether the results should be cacheable.
 
 Returns:
 
 The callback method which is invoked when any query involved in getPage(Page, boolean) is about to be executed.
 - afterPage
```
protected Consumer<EntityManager> afterPage()
```
 Here you can in your BaseEntityService subclass define the callback method which needs to be invoked after any of getPage(Page, boolean) methods is called. For example, to remove a vendor specific EntityManager hint. The default implementation returns a no-op callback.
 
 Returns:
 
 The callback method which is invoked after any of getPage(Page, boolean) methods is called.
 - getPage
```
public org.omnifaces.utils.collection.PartialResultList<E> getPage(Page page,
 boolean count)
```
 Returns a partial result list based on given Page. This will by default cache the results.
 
 Parameters:
 
 page - The page to return a partial result list for.
 
 count - Whether to run the COUNT(id) query to estimate total number of results. This will be available by PartialResultList.getEstimatedTotalNumberOfResults().
 
 Returns:
 
 A partial result list based on given Page.
 - getPage
```
public org.omnifaces.utils.collection.PartialResultList<E> getPage(Page page,
 boolean count,
 String... fetchFields)
```
 Returns a partial result list based on given Page and fetch fields. This will by default cache the results.
 
 Parameters:
 
 page - The page to return a partial result list for.
 
 count - Whether to run the COUNT(id) query to estimate total number of results. This will be available by PartialResultList.getEstimatedTotalNumberOfResults().
 
 fetchFields - Optionally, all (lazy loaded) fields to be explicitly fetched during the query. Each field can represent a JavaBean path, like as you would do in EL, such as parent.child.subchild.
 
 Returns:
 
 A partial result list based on given Page.
 - getPage
```
protected org.omnifaces.utils.collection.PartialResultList<E> getPage(Page page,
 boolean count,
 boolean cacheable,
 String... fetchFields)
```
 Returns a partial result list based on given Page.
 
 Parameters:
 
 page - The page to return a partial result list for.
 
 count - Whether to run the COUNT(id) query to estimate total number of results. This will be available by PartialResultList.getEstimatedTotalNumberOfResults().
 
 cacheable - Whether the results should be cacheable.
 
 fetchFields - Optionally, all (lazy loaded) fields to be explicitly fetched during the query. Each field can represent a JavaBean path, like as you would do in EL, such as parent.child.subchild.
 
 Returns:
 
 A partial result list based on given Page.
 - getPage
```
protected org.omnifaces.utils.collection.PartialResultList<E> getPage(Page page,
 boolean count,
 BaseEntityService.QueryBuilder<E> queryBuilder)
```
 Returns a partial result list based on given Page and BaseEntityService.QueryBuilder. This will by default cache the results.
 
 Parameters:
 
 page - The page to return a partial result list for.
 
 count - Whether to run the COUNT(id) query to estimate total number of results. This will be available by PartialResultList.getEstimatedTotalNumberOfResults().
 
 queryBuilder - This allows fine-graining the JPA criteria query.
 
 Returns:
 
 A partial result list based on given Page and BaseEntityService.QueryBuilder.
 - getPage
```
protected org.omnifaces.utils.collection.PartialResultList<E> getPage(Page page,
 boolean count,
 boolean cacheable,
 BaseEntityService.QueryBuilder<E> queryBuilder)
```
 Returns a partial result list based on given Page, entity type and BaseEntityService.QueryBuilder.
 
 Parameters:
 
 page - The page to return a partial result list for.
 
 count - Whether to run the COUNT(id) query to estimate total number of results. This will be available by PartialResultList.getEstimatedTotalNumberOfResults().
 
 cacheable - Whether the results should be cacheable.
 
 queryBuilder - This allows fine-graining the JPA criteria query.
 
 Returns:
 
 A partial result list based on given Page and BaseEntityService.QueryBuilder.
 - getPage
```
protected <T extends E> org.omnifaces.utils.collection.PartialResultList<T> getPage(Page page,
 boolean count,
 Class<T> resultType,
 BaseEntityService.MappedQueryBuilder<T> mappedQueryBuilder)
```
 Returns a partial result list based on given Page, result type and BaseEntityService.MappedQueryBuilder. This will by default cache the results.
 
 Type Parameters:
 
 T - The generic type of the entity or a DTO subclass thereof.
 
 Parameters:
 
 page - The page to return a partial result list for.
 
 count - Whether to run the COUNT(id) query to estimate total number of results. This will be available by PartialResultList.getEstimatedTotalNumberOfResults().
 
 resultType - The result type which can be the entity type itself or a DTO subclass thereof.
 
 mappedQueryBuilder - This allows fine-graining the JPA criteria query and must return a mapping of getters-paths.
 
 Returns:
 
 A partial result list based on given Page and BaseEntityService.MappedQueryBuilder.
 
 Throws:
 
 IllegalArgumentException - When the result type does not equal entity type and mapping is empty.
 - getPage
```
protected <T extends E> org.omnifaces.utils.collection.PartialResultList<T> getPage(Page page,
 boolean count,
 boolean cacheable,
 Class<T> resultType,
 BaseEntityService.MappedQueryBuilder<T> queryBuilder)
```
 Returns a partial result list based on given Page, entity type and BaseEntityService.QueryBuilder.
 
 Type Parameters:
 
 T - The generic type of the entity or a DTO subclass thereof.
 
 Parameters:
 
 page - The page to return a partial result list for.
 
 count - Whether to run the COUNT(id) query to estimate total number of results. This will be available by PartialResultList.getEstimatedTotalNumberOfResults().
 
 cacheable - Whether the results should be cacheable.
 
 resultType - The result type which can be the entity type itself or a DTO subclass thereof.
 
 queryBuilder - This allows fine-graining the JPA criteria query and must return a mapping of getters-paths when result type does not equal entity type.
 
 Returns:
 
 A partial result list based on given Page and BaseEntityService.MappedQueryBuilder.
 
 Throws:
 
 IllegalArgumentException - When the result type does not equal entity type and mapping is empty.
 - getCurrentInstance
```
public static BaseEntityService<?,?> getCurrentInstance()
```
 Returns the currently active BaseEntityService from the SessionContext.
 
 Returns:
 
 The currently active BaseEntityService from the SessionContext.
 
 Throws:
 
 IllegalStateException - if there is none, which can happen if this method is called outside EJB context, or when currently invoked EJB service is not an instance of BaseEntityService.

Class BaseEntityService<I extends Comparable<I> & Serializable,E extends BaseEntity<I>>

Logging

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BaseEntityService

Method Detail

getProvider

getDatabase

getIdentifierType

getEntityType

isGeneratedId

getMetamodel

getMetamodel

getEntityManager

createNamedTypedQuery

createNamedQuery

find

findById

findById

findSoftDeletedById

getById

getById

getSoftDeletedById

exists

getList

getAll

getAll

getAllSoftDeleted

persist

update

updateAndFlush

update

update

save

reset

delete

softDelete

softUndelete

delete

softDelete

softUndelete

manage

countForeignKeyReferencesTo

fetchLazyCollections

fetchLazyCollections

fetchLazyMaps

fetchLazyMaps

fetchLazyBlobs

fetchLazyBlobs

beforePage

onPage

afterPage

getPage

getPage

getPage

getPage

getPage

getPage

getPage

getCurrentInstance