Package io.jans.orm
Interface PersistenceEntryManager
- All Superinterfaces:
jakarta.persistence.EntityManager
- All Known Implementing Classes:
BaseEntryManager
public interface PersistenceEntryManager
extends jakarta.persistence.EntityManager
Methods which Entry Manager must provide
- Author:
- Yuriy Movchan Date: 01/29/2018
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionvoidaddDeleteSubscriber(DeleteNotifier subscriber) <T> booleanauthenticate(String primaryKey, Class<T> entryClass, String password) <T> booleanauthenticate(String baseDN, Class<T> entryClass, String userName, String password) booleanauthenticate(String primaryKey, String password) Deprecated.default voidclear()default voidclose()booleanDeprecated.<T> boolean<T> boolean<T> intcountEntries(Object entry) <T> intcountEntries(String primaryKey, Class<T> entryClass, io.jans.orm.search.filter.Filter filter) <T> intcountEntries(String primaryKey, Class<T> entryClass, io.jans.orm.search.filter.Filter filter, SearchScope scope) <T> List<T>createEntities(Class<T> entryClass, Map<String, List<AttributeData>> entriesAttributes) default <T> jakarta.persistence.EntityGraph<T>createEntityGraph(Class<T> rootType) default jakarta.persistence.EntityGraph<?>createEntityGraph(String graphName) default jakarta.persistence.QuerycreateNamedQuery(String name) default <T> jakarta.persistence.TypedQuery<T>createNamedQuery(String name, Class<T> resultClass) default jakarta.persistence.StoredProcedureQuerydefault jakarta.persistence.QuerycreateNativeQuery(String sqlString) default jakarta.persistence.QuerycreateNativeQuery(String sqlString, Class resultClass) default jakarta.persistence.QuerycreateNativeQuery(String sqlString, String resultSetMapping) default jakarta.persistence.QuerycreateQuery(jakarta.persistence.criteria.CriteriaDelete deleteQuery) default <T> jakarta.persistence.TypedQuery<T>createQuery(jakarta.persistence.criteria.CriteriaQuery<T> criteriaQuery) default jakarta.persistence.QuerycreateQuery(jakarta.persistence.criteria.CriteriaUpdate updateQuery) default jakarta.persistence.QuerycreateQuery(String qlString) default <T> jakarta.persistence.TypedQuery<T>createQuery(String qlString, Class<T> resultClass) default jakarta.persistence.StoredProcedureQuerycreateStoredProcedureQuery(String procedureName) default jakarta.persistence.StoredProcedureQuerycreateStoredProcedureQuery(String procedureName, Class... resultClasses) default jakarta.persistence.StoredProcedureQuerycreateStoredProcedureQuery(String procedureName, String... resultSetMappings) decodeTime(String primaryKey, String date) booleandestroy()default voidencodeTime(String primaryKey, Date date) exportEntry(String dn) Deprecated.<T> List<AttributeData>exportEntry(String dn, String objectClass) default <T> Tdefault <T> Tfind(Class<T> entityClass, Object primaryKey, jakarta.persistence.LockModeType lockMode, Map<String, Object> properties) default <T> T<T> Tdefault <T> PagedResult<EntryData>findAggregatedEntries(String primaryKey, Class<T> entryClass, io.jans.orm.search.filter.Filter filter, SearchProjection projection, int start, int count) Server-side GROUP BY / DISTINCT search.default <T> List<T>findDistinctEntries(String primaryKey, Class<T> entryClass, io.jans.orm.search.filter.Filter filter, SearchProjection projection, int start, int count) SELECT DISTINCT over projection attributes, mapped to partial entity beans.<T> List<T>findEntries(Object entry) Search by sample<T> List<T>findEntries(Object entry, int count) <T> List<T>findEntries(String primaryKey, Class<T> entryClass, io.jans.orm.search.filter.Filter filter) <T> List<T>findEntries(String primaryKey, Class<T> entryClass, io.jans.orm.search.filter.Filter filter, int count) <T> List<T>findEntries(String primaryKey, Class<T> entryClass, io.jans.orm.search.filter.Filter filter, SearchScope scope, String[] ldapReturnAttributes, int start, int count, int chunkSize) <T> List<T>findEntries(String primaryKey, Class<T> entryClass, io.jans.orm.search.filter.Filter filter, SearchScope scope, String[] ldapReturnAttributes, BatchOperation<T> batchOperation, int start, int count, int chunkSize) <T> List<T>findEntries(String primaryKey, Class<T> entryClass, io.jans.orm.search.filter.Filter filter, String[] ldapReturnAttributes) <T> List<T>findEntries(String primaryKey, Class<T> entryClass, io.jans.orm.search.filter.Filter filter, String[] ldapReturnAttributes, int count) default <T> List<T>findEntries(String primaryKey, Class<T> entryClass, io.jans.orm.search.filter.Filter filter, String[] ldapReturnAttributes, String sortBy, SortOrder sortOrder, int start, int count, int chunkSize) Sorted search which returns at most count entries starting from start without calculating total entries count.<T> PagedResult<T>findPagedEntries(String primaryKey, Class<T> entryClass, io.jans.orm.search.filter.Filter filter, String[] ldapReturnAttributes, String sortBy, SortOrder sortOrder, int start, int count, int chunkSize) default voidflush()getAttributeDataListFromCustomAttributesList(Object entry, io.jans.orm.annotation.AttributesList attributesList, String propertyName) <T> AttributeTypegetAttributeType(String primaryKey, Class<T> entryClass, String propertyName) default jakarta.persistence.criteria.CriteriaBuildergetCustomAttributesListFromAttributeDataList(Object entry, io.jans.orm.annotation.AttributesList attributesList, String propertyName, Collection<AttributeData> attributes) Class<?>getCustomAttributesListItemType(Object entry, io.jans.orm.annotation.AttributesList attributesList, String propertyName) default Objectdefault jakarta.persistence.EntityGraph<?>getEntityGraph(String graphName) default <T> List<jakarta.persistence.EntityGraph<? super T>>getEntityGraphs(Class<T> entityClass) default jakarta.persistence.EntityManagerFactory<T> List<PropertyAnnotation>getEntryPropertyAnnotations(Class<T> entryClass) default jakarta.persistence.FlushModeTypeintgetHashCode(Object entry) default jakarta.persistence.LockModeTypegetLockMode(Object entity) default jakarta.persistence.metamodel.MetamodelString[]getObjectClasses(Object entry, Class<?> entryClass) getPersistenceEntryManager(String persistenceType) getPersistenceMetadata(String primaryKey) getPersistenceType(String primaryKey) default <T> TgetReference(Class<T> entryClass, Object primaryKey) default jakarta.persistence.EntityTransactiongroupListByProperties(Class<T> entryClass, List<T> entries, boolean caseSensetive, String groupByProperties, String sumByProperties) booleanhasBranchesSupport(String primaryKey) booleanhasExpirationSupport(String primaryKey) <T> voidimportEntry(String dn, Class<T> entryClass, List<AttributeData> data) default booleandefault booleanisOpen()default voiddefault voiddefault voidvoiddefault voiddefault voiddefault voiddefault voidvoidvoidDeprecated.<T> void<T> int<T> voidremoveByDn(String dn, String[] objectClasses) voidremoveDeleteSubscriber(DeleteNotifier subscriber) voidremoveRecursively(String primaryKey) Deprecated.<T> voidremoveRecursively(String primaryKey, Class<T> entryClass) <T> voidremoveRecursivelyFromDn(String primaryKey, String[] objectClasses) default voidsetFlushMode(jakarta.persistence.FlushModeType flushMode) voidsetPersistenceExtension(PersistenceExtension persistenceExtension) default voidsetProperty(String propertyName, Object value) <T> voidsortListByProperties(Class<T> entryClass, List<T> entries, boolean caseSensetive, String... sortByProperties) default <T> TupdateWithVersion(Object entry) Conditionally updatesentry, succeeding only if the entry's currently stored@Versionvalue still equals the value held onentryat call time.Methods inherited from interface jakarta.persistence.EntityManager
find
-
Method Details
-
authenticate
Deprecated. -
authenticate
-
authenticate
-
persist
- Specified by:
persistin interfacejakarta.persistence.EntityManager
-
merge
- Specified by:
mergein interfacejakarta.persistence.EntityManager
-
updateWithVersion
Conditionally updatesentry, succeeding only if the entry's currently stored@Versionvalue still equals the value held onentryat call time. On success, increments the stored version and writes the same new value back ontoentry.Like
merge(Object), this call pre-reads the entry's current attributes to build the diff. If the entry does not exist at all when the call begins, the backend's normal not-found behavior formerge()applies (e.g.EntryPersistenceException), notVersionMismatchException-- a backend cannot cheaply tell "never existed" apart from "deleted before this call" without an extra round trip, and this method does not add one.VersionMismatchExceptionis reserved for a version that no longer matches at the final compare-and-swap, which also covers the entry being deleted in the race window between this call's own pre-read and its write.- Throws:
MappingException- if entry's class has more than one@Versionfield, or that field's current value onentryis nullVersionMismatchException- if the stored version no longer matches at the compare-and-swap (another writer updated first, or the entry was deleted after this call's own pre-read)UnsupportedOperationException- if the active persistence backend does not implement versioned updates, orentry's class has zero@Versionfields
-
contains
Deprecated.- Specified by:
containsin interfacejakarta.persistence.EntityManager
-
contains
-
contains
-
countEntries
-
countEntries
-
countEntries
<T> int countEntries(String primaryKey, Class<T> entryClass, io.jans.orm.search.filter.Filter filter, SearchScope scope) -
createEntities
-
find
-
findEntries
Search by sample- Parameters:
entry- Sample- Returns:
- Result entries
-
findEntries
-
findEntries
-
findEntries
-
findEntries
-
findEntries
-
findEntries
<T> List<T> findEntries(String primaryKey, Class<T> entryClass, io.jans.orm.search.filter.Filter filter, SearchScope scope, String[] ldapReturnAttributes, int start, int count, int chunkSize) -
findEntries
<T> List<T> findEntries(String primaryKey, Class<T> entryClass, io.jans.orm.search.filter.Filter filter, SearchScope scope, String[] ldapReturnAttributes, BatchOperation<T> batchOperation, int start, int count, int chunkSize) -
findEntries
default <T> List<T> findEntries(String primaryKey, Class<T> entryClass, io.jans.orm.search.filter.Filter filter, String[] ldapReturnAttributes, String sortBy, SortOrder sortOrder, int start, int count, int chunkSize) Sorted search which returns at most count entries starting from start without calculating total entries count. Prefer it over findPagedEntries when total count is not needed. When sortBy is specified it replaces the entity default sort (@DataEntry sortBy) where the backend supports it, so the database can read rows in index order. Backends which can't skip the count fall back to findPagedEntries. -
findPagedEntries
-
findAggregatedEntries
default <T> PagedResult<EntryData> findAggregatedEntries(String primaryKey, Class<T> entryClass, io.jans.orm.search.filter.Filter filter, SearchProjection projection, int start, int count) Server-side GROUP BY / DISTINCT search. Returned rows are raw projections without DN (they represent groups, not entries). PagedResult.totalEntriesCount is the total number of groups (or distinct rows) matching the filter; start/count page over groups. -
findDistinctEntries
default <T> List<T> findDistinctEntries(String primaryKey, Class<T> entryClass, io.jans.orm.search.filter.Filter filter, SearchProjection projection, int start, int count) SELECT DISTINCT over projection attributes, mapped to partial entity beans. Only projected properties are populated and the DN property is null — returned beans must not be passed to merge/remove. Projection must be distinct-only (no aggregates). -
remove
- Specified by:
removein interfacejakarta.persistence.EntityManager
-
remove
Deprecated. -
removeByDn
-
remove
-
remove
-
removeRecursively
Deprecated. -
removeRecursively
-
removeRecursivelyFromDn
-
hasBranchesSupport
-
hasExpirationSupport
-
getPersistenceType
String getPersistenceType() -
getPersistenceType
-
getPersistenceMetadata
-
getTableColumnsMap
Map<String,Map<String, getTableColumnsMap()AttributeType>> -
decodeTime
-
encodeTime
-
getHashCode
-
getObjectClasses
-
groupListByProperties
-
addDeleteSubscriber
-
removeDeleteSubscriber
-
sortListByProperties
-
exportEntry
Deprecated. -
exportEntry
-
importEntry
-
getOperationService
PersistenceOperationService getOperationService() -
getPersistenceEntryManager
-
setPersistenceExtension
-
getAttributeType
-
getCustomAttributesListItemType
-
getAttributeDataListFromCustomAttributesList
List<AttributeData> getAttributeDataListFromCustomAttributesList(Object entry, io.jans.orm.annotation.AttributesList attributesList, String propertyName) -
getCustomAttributesListFromAttributeDataList
List<Object> getCustomAttributesListFromAttributeDataList(Object entry, io.jans.orm.annotation.AttributesList attributesList, String propertyName, Collection<AttributeData> attributes) -
getEntryPropertyAnnotations
-
destroy
boolean destroy() -
clear
default void clear()- Specified by:
clearin interfacejakarta.persistence.EntityManager
-
close
default void close()- Specified by:
closein interfacejakarta.persistence.EntityManager
-
createNamedQuery
- Specified by:
createNamedQueryin interfacejakarta.persistence.EntityManager
-
createNamedQuery
- Specified by:
createNamedQueryin interfacejakarta.persistence.EntityManager
-
createNativeQuery
- Specified by:
createNativeQueryin interfacejakarta.persistence.EntityManager
-
createNativeQuery
- Specified by:
createNativeQueryin interfacejakarta.persistence.EntityManager
-
createNativeQuery
- Specified by:
createNativeQueryin interfacejakarta.persistence.EntityManager
-
createQuery
- Specified by:
createQueryin interfacejakarta.persistence.EntityManager
-
createQuery
default <T> jakarta.persistence.TypedQuery<T> createQuery(jakarta.persistence.criteria.CriteriaQuery<T> criteriaQuery) - Specified by:
createQueryin interfacejakarta.persistence.EntityManager
-
createQuery
default jakarta.persistence.Query createQuery(jakarta.persistence.criteria.CriteriaUpdate updateQuery) - Specified by:
createQueryin interfacejakarta.persistence.EntityManager
-
createQuery
default jakarta.persistence.Query createQuery(jakarta.persistence.criteria.CriteriaDelete deleteQuery) - Specified by:
createQueryin interfacejakarta.persistence.EntityManager
-
createQuery
- Specified by:
createQueryin interfacejakarta.persistence.EntityManager
-
flush
default void flush()- Specified by:
flushin interfacejakarta.persistence.EntityManager
-
getDelegate
- Specified by:
getDelegatein interfacejakarta.persistence.EntityManager
-
getFlushMode
default jakarta.persistence.FlushModeType getFlushMode()- Specified by:
getFlushModein interfacejakarta.persistence.EntityManager
-
getReference
- Specified by:
getReferencein interfacejakarta.persistence.EntityManager
-
getTransaction
default jakarta.persistence.EntityTransaction getTransaction()- Specified by:
getTransactionin interfacejakarta.persistence.EntityManager
-
isOpen
default boolean isOpen()- Specified by:
isOpenin interfacejakarta.persistence.EntityManager
-
joinTransaction
default void joinTransaction()- Specified by:
joinTransactionin interfacejakarta.persistence.EntityManager
-
lock
- Specified by:
lockin interfacejakarta.persistence.EntityManager
-
lock
default void lock(Object entity, jakarta.persistence.LockModeType lockMode, Map<String, Object> properties) - Specified by:
lockin interfacejakarta.persistence.EntityManager
-
refresh
- Specified by:
refreshin interfacejakarta.persistence.EntityManager
-
refresh
- Specified by:
refreshin interfacejakarta.persistence.EntityManager
-
refresh
- Specified by:
refreshin interfacejakarta.persistence.EntityManager
-
refresh
default void refresh(Object entity, jakarta.persistence.LockModeType lockMode, Map<String, Object> properties) - Specified by:
refreshin interfacejakarta.persistence.EntityManager
-
setFlushMode
default void setFlushMode(jakarta.persistence.FlushModeType flushMode) - Specified by:
setFlushModein interfacejakarta.persistence.EntityManager
-
createNamedStoredProcedureQuery
- Specified by:
createNamedStoredProcedureQueryin interfacejakarta.persistence.EntityManager
-
createStoredProcedureQuery
- Specified by:
createStoredProcedureQueryin interfacejakarta.persistence.EntityManager
-
createStoredProcedureQuery
default jakarta.persistence.StoredProcedureQuery createStoredProcedureQuery(String procedureName, Class... resultClasses) - Specified by:
createStoredProcedureQueryin interfacejakarta.persistence.EntityManager
-
createStoredProcedureQuery
default jakarta.persistence.StoredProcedureQuery createStoredProcedureQuery(String procedureName, String... resultSetMappings) - Specified by:
createStoredProcedureQueryin interfacejakarta.persistence.EntityManager
-
isJoinedToTransaction
default boolean isJoinedToTransaction()- Specified by:
isJoinedToTransactionin interfacejakarta.persistence.EntityManager
-
unwrap
- Specified by:
unwrapin interfacejakarta.persistence.EntityManager
-
getEntityManagerFactory
default jakarta.persistence.EntityManagerFactory getEntityManagerFactory()- Specified by:
getEntityManagerFactoryin interfacejakarta.persistence.EntityManager
-
getCriteriaBuilder
default jakarta.persistence.criteria.CriteriaBuilder getCriteriaBuilder()- Specified by:
getCriteriaBuilderin interfacejakarta.persistence.EntityManager
-
getMetamodel
default jakarta.persistence.metamodel.Metamodel getMetamodel()- Specified by:
getMetamodelin interfacejakarta.persistence.EntityManager
-
createEntityGraph
- Specified by:
createEntityGraphin interfacejakarta.persistence.EntityManager
-
createEntityGraph
- Specified by:
createEntityGraphin interfacejakarta.persistence.EntityManager
-
getEntityGraph
- Specified by:
getEntityGraphin interfacejakarta.persistence.EntityManager
-
getEntityGraphs
- Specified by:
getEntityGraphsin interfacejakarta.persistence.EntityManager
-
getProperties
- Specified by:
getPropertiesin interfacejakarta.persistence.EntityManager
-
setProperty
- Specified by:
setPropertyin interfacejakarta.persistence.EntityManager
-
getLockMode
- Specified by:
getLockModein interfacejakarta.persistence.EntityManager
-
detach
- Specified by:
detachin interfacejakarta.persistence.EntityManager
-
find
default <T> T find(Class<T> entityClass, Object primaryKey, jakarta.persistence.LockModeType lockMode) - Specified by:
findin interfacejakarta.persistence.EntityManager
-
find
- Specified by:
findin interfacejakarta.persistence.EntityManager
-
find
default <T> T find(Class<T> entityClass, Object primaryKey, jakarta.persistence.LockModeType lockMode, Map<String, Object> properties) - Specified by:
findin interfacejakarta.persistence.EntityManager
-