org.fryske_akademy.ejb

Class AbstractCrudService

java.lang.Object

org.fryske_akademy.ejb.AbstractCrudService

All Implemented Interfaces:

Serializable, CrudReadService, CrudWriteService

Direct Known Subclasses:

AbstractCrudServiceEnvers

@DeclareRoles(value="editor")
public abstract class AbstractCrudService
extends Object
implements CrudWriteService, CrudReadService

This base class enables you to create minimal crud service beans. All you have to do is override, implement getEntityManager and annotate with

Author:

eduard

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.fryske_akademy.ejb.CrudReadService

CrudReadService.SORTORDER

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PAGE_SIZE default page size (max results), used when no maximum is given.
static String	EDITORROLE

Constructor Summary

Constructors

Constructor and Description
AbstractCrudService()

Method Summary

Modifier and Type	Method and Description
int	batchDelete(Collection<? extends EntityInterface> t, Integer flushCount) save multiple entities, NOTE that normally only after commit or flush entitymanagers will reflect changes caused by saving all entities, this may cause entitylisteners to fail.
<T extends EntityInterface> Stream<T>	batchSave(Collection<T> entities, Integer flushCount) save multiple entities, NOTE that normally only after commit or flush entitymanagers will reflect changes caused by saving all entities, this may cause entitylisteners to fail.
int	count(String namedQuery, List<Param> params) Call this using the same parameters as in CrudReadService.find(java.lang.String, java.util.List, java.lang.Integer, java.lang.Integer, java.lang.Class) to get to know the total number of results
int	countDynamic(List<Param> params, Class type) Call this using the same parameters as in findDynamic to get to know the total number of results
<T extends Serializable> T	create(T t) When overriding look into roles to use, these are not inherited.
void	delete(EntityInterface t) When overriding look into roles to use, these are not inherited.
<T extends Serializable> T	find(Serializable id, Class<T> type)
<T extends Serializable> List<T>	find(String namedQuery, List<Param> params, Integer first, Integer max, Class<T> type)
<T extends Serializable> List<T>	findAll(Class<T> type)
<T extends Serializable> List<T>	findDynamic(Integer first, Integer max, Map<String,CrudReadService.SORTORDER> sort, List<Param> params, Class<T> type)
<T extends Serializable> List<T>	findNative(String namedNativeQuery, List<Param> params, Integer first, Integer max, Class<T> type)
<T extends Serializable> T	findOne(String namedQuery, List<Param> params, Class<T> type) return one result or null, multiple results throws an exception
int	getDefaultPageSize() Return a default page size when no max is given, negative value means no limit
protected abstract javax.persistence.EntityManager	getEntityManager()
<T extends EntityInterface> T	save(T t) When overriding look into roles to use, these are not inherited.
protected void	setJpqlBuilder(JpqlBuilder jpqlBuilder) override to inject your own version of JpqlBuilder
<T extends Serializable> Stream<T>	stream(String namedQuery, List<Param> params, Integer first, Integer max, Class<T> type)
<T extends Serializable> Stream<T>	streamAll(Class<T> type)
<T extends Serializable> Stream<T>	streamDynamic(Integer first, Integer max, Map<String,CrudReadService.SORTORDER> sort, List<Param> params, Class<T> type)
<T extends Serializable> Stream<T>	streamNative(String namedNativeQuery, List<Param> params, Integer first, Integer max, Class<T> type)
<T extends Serializable> T	update(T t) When overriding look into roles to use, these are not inherited.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PAGE_SIZE

public static final int DEFAULT_PAGE_SIZE

default page size (max results), used when no maximum is given.

See Also:

Constant Field Values

EDITORROLE

public static final String EDITORROLE

See Also:

Constant Field Values

Constructor Detail

AbstractCrudService

public AbstractCrudService()

Method Detail

getEntityManager

protected abstract javax.persistence.EntityManager getEntityManager()

find

public <T extends Serializable> T find(Serializable id,
                                       Class<T> type)

Specified by:

find in interface CrudReadService

findAll

public <T extends Serializable> List<T> findAll(Class<T> type)

Specified by:

findAll in interface CrudReadService

findDynamic

public <T extends Serializable> List<T> findDynamic(Integer first,
                                                    Integer max,
                                                    Map<String,CrudReadService.SORTORDER> sort,
                                                    List<Param> params,
                                                    Class<T> type)

Specified by:

findDynamic in interface CrudReadService

Parameters:

first - defaults to 0

max - defaults to CrudReadService.getDefaultPageSize()

Returns:

countDynamic

public int countDynamic(List<Param> params,
                        Class type)

Description copied from interface: CrudReadService

Call this using the same parameters as in findDynamic to get to know the total number of results

Specified by:

countDynamic in interface CrudReadService

Returns:

find

public <T extends Serializable> List<T> find(String namedQuery,
                                             List<Param> params,
                                             Integer first,
                                             Integer max,
                                             Class<T> type)

Specified by:

find in interface CrudReadService

first - defaults to 0

max - defaults to CrudReadService.getDefaultPageSize()

Returns:

findNative

public <T extends Serializable> List<T> findNative(String namedNativeQuery,
                                                   List<Param> params,
                                                   Integer first,
                                                   Integer max,
                                                   Class<T> type)

Specified by:

findNative in interface CrudReadService

first - defaults to 0

max - defaults to CrudReadService.getDefaultPageSize()

Returns:

count

public int count(String namedQuery,
                 List<Param> params)

Description copied from interface: CrudReadService

Call this using the same parameters as in CrudReadService.find(java.lang.String, java.util.List, java.lang.Integer, java.lang.Integer, java.lang.Class) to get to know the total number of results

Specified by:

count in interface CrudReadService

Returns:

getDefaultPageSize

public int getDefaultPageSize()

Description copied from interface: CrudReadService

Return a default page size when no max is given, negative value means no limit

Specified by:

getDefaultPageSize in interface CrudReadService

Returns:

DEFAULT_PAGE_SIZE

findOne

public <T extends Serializable> T findOne(String namedQuery,
                                          List<Param> params,
                                          Class<T> type)

Description copied from interface: CrudReadService

return one result or null, multiple results throws an exception

Specified by:

findOne in interface CrudReadService

Returns:

create

@RolesAllowed(value="editor")
public <T extends Serializable> T create(T t)

When overriding look into roles to use, these are not inherited. If you don't need security, override and use PermitAll.

Specified by:

create in interface CrudWriteService

Type Parameters:

T -

Parameters:

t -

Returns:

save

@RolesAllowed(value="editor")
public <T extends EntityInterface> T save(T t)

When overriding look into roles to use, these are not inherited. If you don't need security, override and use PermitAll.

Specified by:

save in interface CrudWriteService

Type Parameters:

T -

Parameters:

t -

Returns:

update

@RolesAllowed(value="editor")
public <T extends Serializable> T update(T t)

When overriding look into roles to use, these are not inherited. If you don't need security, override and use PermitAll.

Specified by:

update in interface CrudWriteService

Type Parameters:

T -

Parameters:

t -

Returns:

delete

@RolesAllowed(value="editor")
public void delete(EntityInterface t)

When overriding look into roles to use, these are not inherited. If you don't need security, override and use PermitAll.

Specified by:

delete in interface CrudWriteService

Parameters:

t -

batchSave

@RolesAllowed(value="editor")
public <T extends EntityInterface> Stream<T> batchSave(Collection<T> entities,
                                                                                     Integer flushCount)

Description copied from interface: CrudWriteService

save multiple entities, NOTE that normally only after commit or flush entitymanagers will reflect changes caused by saving all entities, this may cause entitylisteners to fail. You may need to perform checks on the collection before calling this method. Also note that entitylisteners will execute within the batch transaction, you may need to specify Transactional.TxType on the bean that you use in your listeners, use isolation level 0 (not recommended) or use XA when you need to access resources from your listeners. When flushCount != null flushes and clears the entitymanager every flushCount entities. NOTE that this method executes in one (possibly big) sql transaction! You can use EntityException in for example your listeners to find out in case of failure which enitity caused it.

Specified by:

batchSave in interface CrudWriteService

flushCount - when not null try to optimize (flush/clear) every so many entities

Returns:

the saved entities

See Also:

Util#getBean(java.lang.Class, javax.enterprise.inject.spi.BeanManager, java.lang.annotation.Annotation...)

batchDelete

@RolesAllowed(value="editor")
public int batchDelete(Collection<? extends EntityInterface> t,
                                                     Integer flushCount)

Description copied from interface: CrudWriteService

save multiple entities, NOTE that normally only after commit or flush entitymanagers will reflect changes caused by saving all entities, this may cause entitylisteners to fail. You may need to perform checks on the collection before calling this method. Also note that entitylisteners will execute within the batch transaction, you may need to specify Transactional.TxType on the bean that you use in your listeners, use isolation level 0 (not recommended) or use XA when you need to access resources from your listeners. When flushCount != null flushes and clears the entitymanager every flushCount entities. NOTE that this method executes in one (possibly big) sql transaction! You can use EntityException in for example your listeners to find out in case of failure which enitity caused it.

Specified by:

batchDelete in interface CrudWriteService

flushCount - when not null try to optimize (flush/clear) every so many entities

Returns:

number of entities deleted

See Also:

Util#getBean(java.lang.Class, javax.enterprise.inject.spi.BeanManager, java.lang.annotation.Annotation...)

streamAll

public <T extends Serializable> Stream<T> streamAll(Class<T> type)

Specified by:

streamAll in interface CrudReadService

streamDynamic

public <T extends Serializable> Stream<T> streamDynamic(Integer first,
                                                        Integer max,
                                                        Map<String,CrudReadService.SORTORDER> sort,
                                                        List<Param> params,
                                                        Class<T> type)

Specified by:

streamDynamic in interface CrudReadService

Parameters:

first - defaults to 0

max - defaults to CrudReadService.getDefaultPageSize()

Returns:

stream

public <T extends Serializable> Stream<T> stream(String namedQuery,
                                                 List<Param> params,
                                                 Integer first,
                                                 Integer max,
                                                 Class<T> type)

Specified by:

stream in interface CrudReadService

first - defaults to 0

max - defaults to CrudReadService.getDefaultPageSize()

Returns:

streamNative

public <T extends Serializable> Stream<T> streamNative(String namedNativeQuery,
                                                       List<Param> params,
                                                       Integer first,
                                                       Integer max,
                                                       Class<T> type)

Specified by:

streamNative in interface CrudReadService

first - defaults to 0

max - defaults to CrudReadService.getDefaultPageSize()

Returns:

setJpqlBuilder

@Inject
protected void setJpqlBuilder(JpqlBuilder jpqlBuilder)

override to inject your own version of JpqlBuilder

Parameters:

jpqlBuilder -