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
  • Method Details

    • authenticate

      @Deprecated boolean authenticate(String primaryKey, String password)
      Deprecated.
    • authenticate

      <T> boolean authenticate(String primaryKey, Class<T> entryClass, String password)
    • authenticate

      <T> boolean authenticate(String baseDN, Class<T> entryClass, String userName, String password)
    • persist

      void persist(Object entry)
      Specified by:
      persist in interface jakarta.persistence.EntityManager
    • merge

      Void merge(Object entry)
      Specified by:
      merge in interface jakarta.persistence.EntityManager
    • updateWithVersion

      Void updateWithVersion(Object entry)
      Conditionally updates entry, succeeding only if the entry's currently stored @Version value still equals the value held on entry at call time. On success, increments the stored version and writes the same new value back onto entry.

      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 for merge() applies (e.g. EntryPersistenceException), not VersionMismatchException -- 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. VersionMismatchException is 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 @Version field, or that field's current value on entry is null
      VersionMismatchException - 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, or entry's class has zero @Version fields
    • contains

      @Deprecated boolean contains(Object entity)
      Deprecated.
      Specified by:
      contains in interface jakarta.persistence.EntityManager
    • contains

      <T> boolean contains(String primaryKey, Class<T> entryClass)
    • contains

      <T> boolean contains(String primaryKey, Class<T> entryClass, io.jans.orm.search.filter.Filter filter)
    • countEntries

      <T> int countEntries(Object entry)
    • countEntries

      <T> int countEntries(String primaryKey, Class<T> entryClass, io.jans.orm.search.filter.Filter filter)
    • countEntries

      <T> int countEntries(String primaryKey, Class<T> entryClass, io.jans.orm.search.filter.Filter filter, SearchScope scope)
    • createEntities

      <T> List<T> createEntities(Class<T> entryClass, Map<String,List<AttributeData>> entriesAttributes)
    • find

      <T> T find(Object primaryKey, Class<T> entryClass, String[] ldapReturnAttributes)
    • findEntries

      <T> List<T> findEntries(Object entry)
      Search by sample
      Parameters:
      entry - Sample
      Returns:
      Result entries
    • findEntries

      <T> List<T> findEntries(Object entry, int count)
    • findEntries

      <T> List<T> findEntries(String primaryKey, Class<T> entryClass, io.jans.orm.search.filter.Filter filter)
    • findEntries

      <T> List<T> findEntries(String primaryKey, Class<T> entryClass, io.jans.orm.search.filter.Filter filter, int count)
    • findEntries

      <T> List<T> findEntries(String primaryKey, Class<T> entryClass, io.jans.orm.search.filter.Filter filter, String[] ldapReturnAttributes)
    • findEntries

      <T> List<T> findEntries(String primaryKey, Class<T> entryClass, io.jans.orm.search.filter.Filter filter, String[] ldapReturnAttributes, int count)
    • 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

      <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)
    • 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

      void remove(Object entry)
      Specified by:
      remove in interface jakarta.persistence.EntityManager
    • remove

      @Deprecated void remove(String dn)
      Deprecated.
    • removeByDn

      <T> void removeByDn(String dn, String[] objectClasses)
    • remove

      <T> void remove(String primaryKey, Class<T> entryClass)
    • remove

      <T> int remove(String primaryKey, Class<T> entryClass, io.jans.orm.search.filter.Filter filter, int count)
    • removeRecursively

      @Deprecated void removeRecursively(String primaryKey)
      Deprecated.
    • removeRecursively

      <T> void removeRecursively(String primaryKey, Class<T> entryClass)
    • removeRecursivelyFromDn

      <T> void removeRecursivelyFromDn(String primaryKey, String[] objectClasses)
    • hasBranchesSupport

      boolean hasBranchesSupport(String primaryKey)
    • hasExpirationSupport

      boolean hasExpirationSupport(String primaryKey)
    • getPersistenceType

      String getPersistenceType()
    • getPersistenceType

      String getPersistenceType(String primaryKey)
    • getPersistenceMetadata

      PersistenceMetadata getPersistenceMetadata(String primaryKey)
    • getTableColumnsMap

      Map<String,Map<String,AttributeType>> getTableColumnsMap()
    • decodeTime

      Date decodeTime(String primaryKey, String date)
    • encodeTime

      String encodeTime(String primaryKey, Date date)
    • getHashCode

      int getHashCode(Object entry)
    • getObjectClasses

      String[] getObjectClasses(Object entry, Class<?> entryClass)
    • groupListByProperties

      <T> Map<T,List<T>> groupListByProperties(Class<T> entryClass, List<T> entries, boolean caseSensetive, String groupByProperties, String sumByProperties)
    • addDeleteSubscriber

      void addDeleteSubscriber(DeleteNotifier subscriber)
    • removeDeleteSubscriber

      void removeDeleteSubscriber(DeleteNotifier subscriber)
    • sortListByProperties

      <T> void sortListByProperties(Class<T> entryClass, List<T> entries, boolean caseSensetive, String... sortByProperties)
    • exportEntry

      Deprecated.
    • exportEntry

      <T> List<AttributeData> exportEntry(String dn, String objectClass)
    • importEntry

      <T> void importEntry(String dn, Class<T> entryClass, List<AttributeData> data)
    • getOperationService

      PersistenceOperationService getOperationService()
    • getPersistenceEntryManager

      PersistenceEntryManager getPersistenceEntryManager(String persistenceType)
    • setPersistenceExtension

      void setPersistenceExtension(PersistenceExtension persistenceExtension)
    • getAttributeType

      <T> AttributeType getAttributeType(String primaryKey, Class<T> entryClass, String propertyName)
    • getCustomAttributesListItemType

      Class<?> getCustomAttributesListItemType(Object entry, io.jans.orm.annotation.AttributesList attributesList, String propertyName)
    • 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

      <T> List<PropertyAnnotation> getEntryPropertyAnnotations(Class<T> entryClass)
    • destroy

      boolean destroy()
    • clear

      default void clear()
      Specified by:
      clear in interface jakarta.persistence.EntityManager
    • close

      default void close()
      Specified by:
      close in interface jakarta.persistence.EntityManager
    • createNamedQuery

      default jakarta.persistence.Query createNamedQuery(String name)
      Specified by:
      createNamedQuery in interface jakarta.persistence.EntityManager
    • createNamedQuery

      default <T> jakarta.persistence.TypedQuery<T> createNamedQuery(String name, Class<T> resultClass)
      Specified by:
      createNamedQuery in interface jakarta.persistence.EntityManager
    • createNativeQuery

      default jakarta.persistence.Query createNativeQuery(String sqlString)
      Specified by:
      createNativeQuery in interface jakarta.persistence.EntityManager
    • createNativeQuery

      default jakarta.persistence.Query createNativeQuery(String sqlString, Class resultClass)
      Specified by:
      createNativeQuery in interface jakarta.persistence.EntityManager
    • createNativeQuery

      default jakarta.persistence.Query createNativeQuery(String sqlString, String resultSetMapping)
      Specified by:
      createNativeQuery in interface jakarta.persistence.EntityManager
    • createQuery

      default jakarta.persistence.Query createQuery(String qlString)
      Specified by:
      createQuery in interface jakarta.persistence.EntityManager
    • createQuery

      default <T> jakarta.persistence.TypedQuery<T> createQuery(jakarta.persistence.criteria.CriteriaQuery<T> criteriaQuery)
      Specified by:
      createQuery in interface jakarta.persistence.EntityManager
    • createQuery

      default jakarta.persistence.Query createQuery(jakarta.persistence.criteria.CriteriaUpdate updateQuery)
      Specified by:
      createQuery in interface jakarta.persistence.EntityManager
    • createQuery

      default jakarta.persistence.Query createQuery(jakarta.persistence.criteria.CriteriaDelete deleteQuery)
      Specified by:
      createQuery in interface jakarta.persistence.EntityManager
    • createQuery

      default <T> jakarta.persistence.TypedQuery<T> createQuery(String qlString, Class<T> resultClass)
      Specified by:
      createQuery in interface jakarta.persistence.EntityManager
    • flush

      default void flush()
      Specified by:
      flush in interface jakarta.persistence.EntityManager
    • getDelegate

      default Object getDelegate()
      Specified by:
      getDelegate in interface jakarta.persistence.EntityManager
    • getFlushMode

      default jakarta.persistence.FlushModeType getFlushMode()
      Specified by:
      getFlushMode in interface jakarta.persistence.EntityManager
    • getReference

      default <T> T getReference(Class<T> entryClass, Object primaryKey)
      Specified by:
      getReference in interface jakarta.persistence.EntityManager
    • getTransaction

      default jakarta.persistence.EntityTransaction getTransaction()
      Specified by:
      getTransaction in interface jakarta.persistence.EntityManager
    • isOpen

      default boolean isOpen()
      Specified by:
      isOpen in interface jakarta.persistence.EntityManager
    • joinTransaction

      default void joinTransaction()
      Specified by:
      joinTransaction in interface jakarta.persistence.EntityManager
    • lock

      default void lock(Object entry, jakarta.persistence.LockModeType lockMode)
      Specified by:
      lock in interface jakarta.persistence.EntityManager
    • lock

      default void lock(Object entity, jakarta.persistence.LockModeType lockMode, Map<String,Object> properties)
      Specified by:
      lock in interface jakarta.persistence.EntityManager
    • refresh

      default void refresh(Object entry)
      Specified by:
      refresh in interface jakarta.persistence.EntityManager
    • refresh

      default void refresh(Object entity, Map<String,Object> properties)
      Specified by:
      refresh in interface jakarta.persistence.EntityManager
    • refresh

      default void refresh(Object entity, jakarta.persistence.LockModeType lockMode)
      Specified by:
      refresh in interface jakarta.persistence.EntityManager
    • refresh

      default void refresh(Object entity, jakarta.persistence.LockModeType lockMode, Map<String,Object> properties)
      Specified by:
      refresh in interface jakarta.persistence.EntityManager
    • setFlushMode

      default void setFlushMode(jakarta.persistence.FlushModeType flushMode)
      Specified by:
      setFlushMode in interface jakarta.persistence.EntityManager
    • createNamedStoredProcedureQuery

      default jakarta.persistence.StoredProcedureQuery createNamedStoredProcedureQuery(String name)
      Specified by:
      createNamedStoredProcedureQuery in interface jakarta.persistence.EntityManager
    • createStoredProcedureQuery

      default jakarta.persistence.StoredProcedureQuery createStoredProcedureQuery(String procedureName)
      Specified by:
      createStoredProcedureQuery in interface jakarta.persistence.EntityManager
    • createStoredProcedureQuery

      default jakarta.persistence.StoredProcedureQuery createStoredProcedureQuery(String procedureName, Class... resultClasses)
      Specified by:
      createStoredProcedureQuery in interface jakarta.persistence.EntityManager
    • createStoredProcedureQuery

      default jakarta.persistence.StoredProcedureQuery createStoredProcedureQuery(String procedureName, String... resultSetMappings)
      Specified by:
      createStoredProcedureQuery in interface jakarta.persistence.EntityManager
    • isJoinedToTransaction

      default boolean isJoinedToTransaction()
      Specified by:
      isJoinedToTransaction in interface jakarta.persistence.EntityManager
    • unwrap

      default <T> T unwrap(Class<T> cls)
      Specified by:
      unwrap in interface jakarta.persistence.EntityManager
    • getEntityManagerFactory

      default jakarta.persistence.EntityManagerFactory getEntityManagerFactory()
      Specified by:
      getEntityManagerFactory in interface jakarta.persistence.EntityManager
    • getCriteriaBuilder

      default jakarta.persistence.criteria.CriteriaBuilder getCriteriaBuilder()
      Specified by:
      getCriteriaBuilder in interface jakarta.persistence.EntityManager
    • getMetamodel

      default jakarta.persistence.metamodel.Metamodel getMetamodel()
      Specified by:
      getMetamodel in interface jakarta.persistence.EntityManager
    • createEntityGraph

      default <T> jakarta.persistence.EntityGraph<T> createEntityGraph(Class<T> rootType)
      Specified by:
      createEntityGraph in interface jakarta.persistence.EntityManager
    • createEntityGraph

      default jakarta.persistence.EntityGraph<?> createEntityGraph(String graphName)
      Specified by:
      createEntityGraph in interface jakarta.persistence.EntityManager
    • getEntityGraph

      default jakarta.persistence.EntityGraph<?> getEntityGraph(String graphName)
      Specified by:
      getEntityGraph in interface jakarta.persistence.EntityManager
    • getEntityGraphs

      default <T> List<jakarta.persistence.EntityGraph<? super T>> getEntityGraphs(Class<T> entityClass)
      Specified by:
      getEntityGraphs in interface jakarta.persistence.EntityManager
    • getProperties

      default Map<String,Object> getProperties()
      Specified by:
      getProperties in interface jakarta.persistence.EntityManager
    • setProperty

      default void setProperty(String propertyName, Object value)
      Specified by:
      setProperty in interface jakarta.persistence.EntityManager
    • getLockMode

      default jakarta.persistence.LockModeType getLockMode(Object entity)
      Specified by:
      getLockMode in interface jakarta.persistence.EntityManager
    • detach

      default void detach(Object entity)
      Specified by:
      detach in interface jakarta.persistence.EntityManager
    • find

      default <T> T find(Class<T> entityClass, Object primaryKey, jakarta.persistence.LockModeType lockMode)
      Specified by:
      find in interface jakarta.persistence.EntityManager
    • find

      default <T> T find(Class<T> entityClass, Object primaryKey, Map<String,Object> properties)
      Specified by:
      find in interface jakarta.persistence.EntityManager
    • find

      default <T> T find(Class<T> entityClass, Object primaryKey, jakarta.persistence.LockModeType lockMode, Map<String,Object> properties)
      Specified by:
      find in interface jakarta.persistence.EntityManager