Package org.apache.syncope.core.persistence.jpa.dao

Class AbstractAnySearchDAO

java.lang.Object

org.apache.syncope.core.persistence.jpa.dao.AbstractDAO<Any<?>>

org.apache.syncope.core.persistence.jpa.dao.AbstractAnySearchDAO

All Implemented Interfaces:

AnySearchDAO, DAO<Any<?>>

Direct Known Subclasses:

ElasticsearchAnySearchDAO, JPAAnySearchDAO, OpenSearchAnySearchDAO

public abstract class AbstractAnySearchDAO
extends AbstractDAO<Any<?>>
implements AnySearchDAO

Field Summary

Fields

Modifier and Type	Field	Description
protected AnyObjectDAO	anyObjectDAO
protected AnyUtilsFactory	anyUtilsFactory
protected DynRealmDAO	dynRealmDAO
protected EntityFactory	entityFactory
protected GroupDAO	groupDAO
protected PlainSchemaDAO	plainSchemaDAO
protected RealmDAO	realmDAO
protected static String[]	RELATIONSHIP_FIELDS
protected UserDAO	userDAO
protected PlainAttrValidationManager	validator

Fields inherited from class org.apache.syncope.core.persistence.jpa.dao.AbstractDAO

LOG

Constructor Summary

Constructors

Constructor	Description
AbstractAnySearchDAO(RealmDAO realmDAO, DynRealmDAO dynRealmDAO, UserDAO userDAO, GroupDAO groupDAO, AnyObjectDAO anyObjectDAO, PlainSchemaDAO plainSchemaDAO, EntityFactory entityFactory, AnyUtilsFactory anyUtilsFactory, PlainAttrValidationManager validator)

Method Summary

Modifier and Type	Method	Description
protected static SearchCond	buildEffectiveCond(SearchCond cond, Set<String> dynRealmKeys, Set<String> groupOwners, AnyTypeKind kind)
protected <T extends Any<?>> List<T>	buildResult(List<Object> raw, AnyTypeKind kind)
protected Triple<PlainSchema,PlainAttrValue,AnyCond>	check(AnyCond cond, AnyTypeKind kind)
protected Pair<PlainSchema,PlainAttrValue>	check(AttrCond cond, AnyTypeKind kind)
protected Set<String>	check(MemberCond cond)
protected List<String>	check(MembershipCond cond)
protected Set<String>	check(RelationshipCond cond)
int	count(Realm base, boolean recursive, Set<String> adminRealms, SearchCond cond, AnyTypeKind kind)
protected abstract int	doCount(Realm base, boolean recursive, Set<String> adminRealms, SearchCond cond, AnyTypeKind kind)
protected abstract <T extends Any<?>> List<T>	doSearch(Realm base, boolean recursive, Set<String> adminRealms, SearchCond searchCondition, int page, int itemsPerPage, List<OrderByClause> orderBy, AnyTypeKind kind)
<T extends Any<?>> List<T>	search(SearchCond cond, List<OrderByClause> orderBy, AnyTypeKind kind)
<T extends Any<?>> List<T>	search(SearchCond cond, AnyTypeKind kind)
<T extends Any<?>> List<T>	search(Realm base, boolean recursive, Set<String> adminRealms, SearchCond cond, int page, int itemsPerPage, List<OrderByClause> orderBy, AnyTypeKind kind)

Methods inherited from class org.apache.syncope.core.persistence.jpa.dao.AbstractDAO

detach, entityManager, entityManagerFactory, isOracle, refresh

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.syncope.core.persistence.api.dao.DAO

detach, refresh

Field Detail

RELATIONSHIP_FIELDS

protected static final String[] RELATIONSHIP_FIELDS

realmDAO

protected final RealmDAO realmDAO

dynRealmDAO

protected final DynRealmDAO dynRealmDAO

userDAO

protected final UserDAO userDAO

groupDAO

protected final GroupDAO groupDAO

anyObjectDAO

protected final AnyObjectDAO anyObjectDAO

plainSchemaDAO

protected final PlainSchemaDAO plainSchemaDAO

entityFactory

protected final EntityFactory entityFactory

anyUtilsFactory

protected final AnyUtilsFactory anyUtilsFactory

validator

protected final PlainAttrValidationManager validator

Constructor Detail

AbstractAnySearchDAO

public AbstractAnySearchDAO(RealmDAO realmDAO,
                            DynRealmDAO dynRealmDAO,
                            UserDAO userDAO,
                            GroupDAO groupDAO,
                            AnyObjectDAO anyObjectDAO,
                            PlainSchemaDAO plainSchemaDAO,
                            EntityFactory entityFactory,
                            AnyUtilsFactory anyUtilsFactory,
                            PlainAttrValidationManager validator)

Method Detail

buildEffectiveCond

protected static SearchCond buildEffectiveCond(SearchCond cond,
                                               Set<String> dynRealmKeys,
                                               Set<String> groupOwners,
                                               AnyTypeKind kind)

doCount

protected abstract int doCount(Realm base,
                               boolean recursive,
                               Set<String> adminRealms,
                               SearchCond cond,
                               AnyTypeKind kind)

count

public int count(Realm base,
                 boolean recursive,
                 Set<String> adminRealms,
                 SearchCond cond,
                 AnyTypeKind kind)

Specified by:

count in interface AnySearchDAO

Parameters:

base - Realm to start searching from

recursive - whether search should recursively include results from child Realms

adminRealms - realms for which the caller owns the proper entitlement(s)

cond - the search condition

kind - any object

Returns:

size of search result

search

public <T extends Any<?>> List<T> search(SearchCond cond,
                                         AnyTypeKind kind)

Specified by:

search in interface AnySearchDAO

Type Parameters:

T - any

Parameters:

cond - the search condition

kind - any object

Returns:

the list of any objects matching the given search condition

search

public <T extends Any<?>> List<T> search(SearchCond cond,
                                         List<OrderByClause> orderBy,
                                         AnyTypeKind kind)

Specified by:

search in interface AnySearchDAO

Type Parameters:

T - any

Parameters:

cond - the search condition

orderBy - list of ordering clauses

kind - any object

Returns:

the list of any objects matching the given search condition

doSearch

protected abstract <T extends Any<?>> List<T> doSearch(Realm base,
                                                       boolean recursive,
                                                       Set<String> adminRealms,
                                                       SearchCond searchCondition,
                                                       int page,
                                                       int itemsPerPage,
                                                       List<OrderByClause> orderBy,
                                                       AnyTypeKind kind)

check

protected Pair<PlainSchema,PlainAttrValue> check(AttrCond cond,
                                                       AnyTypeKind kind)

check

protected Triple<PlainSchema,PlainAttrValue,AnyCond> check(AnyCond cond,
                                                                       AnyTypeKind kind)

check

protected List<String> check(MembershipCond cond)

check

protected Set<String> check(RelationshipCond cond)

check

protected Set<String> check(MemberCond cond)

buildResult

protected <T extends Any<?>> List<T> buildResult(List<Object> raw,
                                                 AnyTypeKind kind)

search

public <T extends Any<?>> List<T> search(Realm base,
                                         boolean recursive,
                                         Set<String> adminRealms,
                                         SearchCond cond,
                                         int page,
                                         int itemsPerPage,
                                         List<OrderByClause> orderBy,
                                         AnyTypeKind kind)

Specified by:

search in interface AnySearchDAO

Type Parameters:

T - any

Parameters:

base - Realm to start searching from

recursive - whether search should recursively include results from child Realms

adminRealms - realms for which the caller owns the proper entitlement(s)

cond - the search condition

page - position of the first result, start from 1

itemsPerPage - number of results per page

orderBy - list of ordering clauses

kind - any object

Returns:

the list of any objects matching the given search condition (in the given page)