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

Class JPAGroupDAO

java.lang.Object

org.apache.syncope.core.persistence.jpa.dao.AbstractDAO<A>

org.apache.syncope.core.persistence.jpa.dao.AbstractAnyDAO<Group>

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

All Implemented Interfaces:

AnyDAO<Group>, DAO<Group>, GroupDAO

Direct Known Subclasses:

JPAJSONGroupDAO

public class JPAGroupDAO
extends AbstractAnyDAO<Group>
implements GroupDAO

Field Summary

Fields

Modifier and Type	Field	Description
static String	ADYNMEMB_TABLE
protected AnyMatchDAO	anyMatchDAO
protected AnyObjectDAO	anyObjectDAO
protected AnySearchDAO	anySearchDAO
protected PlainAttrDAO	plainAttrDAO
protected ApplicationEventPublisher	publisher
protected SearchCondVisitor	searchCondVisitor
static String	UDYNMEMB_TABLE
protected UserDAO	userDAO

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

anyUtilsFactory, derSchemaDAO, dynRealmDAO, plainSchemaDAO

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

LOG

Fields inherited from interface org.apache.syncope.core.persistence.api.dao.AnyDAO

DEFAULT_PAGE_SIZE

Constructor Summary

Constructors

Constructor	Description
JPAGroupDAO(AnyUtilsFactory anyUtilsFactory, ApplicationEventPublisher publisher, PlainSchemaDAO plainSchemaDAO, DerSchemaDAO derSchemaDAO, DynRealmDAO dynRealmDAO, AnyMatchDAO anyMatchDAO, PlainAttrDAO plainAttrDAO, UserDAO userDAO, AnyObjectDAO anyObjectDAO, AnySearchDAO searchDAO, SearchCondVisitor searchCondVisitor)

Method Summary

Modifier and Type	Method	Description
protected SearchCond	buildDynMembershipCond(String baseCondFIQL)
void	clearADynMembers(Group group)
void	clearUDynMembers(Group group)
int	count()
int	countADynMembers(Group group)
int	countAMembers(String groupKey)
Map<String,Integer>	countByRealm()
int	countUDynMembers(Group group)
int	countUMembers(String groupKey)
void	delete(Group group)
boolean	existsAMembership(String anyObjectKey, String groupKey)
boolean	existsUMembership(String userKey, String groupKey)
List<String>	findADynMembers(Group group)
List<Group>	findAll(int page, int itemsPerPage)	Find any objects without any limitation, according to given page and items per page.
List<String>	findAllKeys(int page, int itemsPerPage)	Find any objects' keys without any limitation, according to given page and items per page.
Collection<String>	findAllResourceKeys(String key)
List<String>	findAMembers(String groupKey)
List<AMembership>	findAMemberships(Group group)
Group	findByName(String name)
String	findKey(String name)
List<String>	findKeysByNamePattern(String pattern)
OffsetDateTime	findLastChange(String key)
List<Group>	findOwnedByGroup(String groupKey)
List<Group>	findOwnedByUser(String userKey)
List<TypeExtension>	findTypeExtensions(AnyTypeClass anyTypeClass)
List<String>	findUDynMembers(Group group)
List<String>	findUMembers(String groupKey)
List<UMembership>	findUMemberships(Group group)
List<UMembership>	findUMemberships(Group group, int page, int itemsPerPage)
protected List<ADynGroupMembership>	findWithADynMemberships(AnyType anyType)
protected List<UDynGroupMembership>	findWithUDynMemberships()
protected AnyUtils	init()
Pair<Set<String>,Set<String>>	refreshDynMemberships(AnyObject anyObject)	Evaluates all the dynamic group membership conditions against the given anyObject (invoked during save).
Pair<Set<String>,Set<String>>	refreshDynMemberships(User user)	Evaluates all the dynamic group membership conditions against the given user (invoked during save).
Set<String>	removeDynMemberships(AnyObject anyObject)	Removes the dynamic group memberships of the given anyObject (invoked during delete).
Set<String>	removeDynMemberships(User user)	Removes the dynamic group memberships of the given anyObject (invoked during delete).
Group	saveAndRefreshDynMemberships(Group group)	Saves the provided group and refreshes all User and AnyObject members.
void	securityChecks(Set<String> authRealms, String key, String realm)	Checks if the calling user is authorized to access the Group matching the provided key, under the given realm.
protected void	securityChecks(Group group)

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

anyUtils, authFind, delete, find, findAllKeys, findAllowedSchemas, findByDerAttrValue, findByKeys, findByPlainAttrUniqueValue, findByPlainAttrValue, findByResource, findDynRealms, findLastChange, getAllMatchingCond, save

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.AnyDAO

authFind, delete, find, findAllowedSchemas, findByDerAttrValue, findByKeys, findByPlainAttrUniqueValue, findByPlainAttrValue, findByResource, findDynRealms, getAllMatchingCond, save

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

detach, refresh

Field Detail

UDYNMEMB_TABLE

public static final String UDYNMEMB_TABLE

See Also:

Constant Field Values

ADYNMEMB_TABLE

public static final String ADYNMEMB_TABLE

See Also:

Constant Field Values

publisher

protected final ApplicationEventPublisher publisher

anyMatchDAO

protected final AnyMatchDAO anyMatchDAO

plainAttrDAO

protected final PlainAttrDAO plainAttrDAO

userDAO

protected final UserDAO userDAO

anyObjectDAO

protected final AnyObjectDAO anyObjectDAO

anySearchDAO

protected final AnySearchDAO anySearchDAO

searchCondVisitor

protected final SearchCondVisitor searchCondVisitor

Constructor Detail

JPAGroupDAO

public JPAGroupDAO(AnyUtilsFactory anyUtilsFactory,
                   ApplicationEventPublisher publisher,
                   PlainSchemaDAO plainSchemaDAO,
                   DerSchemaDAO derSchemaDAO,
                   DynRealmDAO dynRealmDAO,
                   AnyMatchDAO anyMatchDAO,
                   PlainAttrDAO plainAttrDAO,
                   UserDAO userDAO,
                   AnyObjectDAO anyObjectDAO,
                   AnySearchDAO searchDAO,
                   SearchCondVisitor searchCondVisitor)

Method Detail

init

protected AnyUtils init()

Specified by:

init in class AbstractAnyDAO<Group>

findKey

@Transactional(readOnly=true)
public String findKey(String name)

Specified by:

findKey in interface GroupDAO

findLastChange

@Transactional(readOnly=true)
public OffsetDateTime findLastChange(String key)

Specified by:

findLastChange in interface AnyDAO<Group>

count

public int count()

Specified by:

count in interface AnyDAO<Group>

Returns:

the total number of any objects of type AnyDAO

countByRealm

public Map<String,Integer> countByRealm()

Specified by:

countByRealm in interface GroupDAO

securityChecks

@Transactional(readOnly=true)
public void securityChecks(Set<String> authRealms,
                           String key,
                           String realm)

Description copied from interface: GroupDAO

Checks if the calling user is authorized to access the Group matching the provided key, under the given realm.

Specified by:

securityChecks in interface GroupDAO

Parameters:

authRealms - realms for which the calling user owns entitlement(s) to check

key - Group key

realm - Group's realm full path

securityChecks

protected void securityChecks(Group group)

Specified by:

securityChecks in class AbstractAnyDAO<Group>

findByName

public Group findByName(String name)

Specified by:

findByName in interface GroupDAO

findKeysByNamePattern

public List<String> findKeysByNamePattern(String pattern)

Specified by:

findKeysByNamePattern in interface GroupDAO

findOwnedByUser

@Transactional(readOnly=true)
public List<Group> findOwnedByUser(String userKey)

Specified by:

findOwnedByUser in interface GroupDAO

findOwnedByGroup

@Transactional(readOnly=true)
public List<Group> findOwnedByGroup(String groupKey)

Specified by:

findOwnedByGroup in interface GroupDAO

findAMemberships

public List<AMembership> findAMemberships(Group group)

Specified by:

findAMemberships in interface GroupDAO

findUMemberships

public List<UMembership> findUMemberships(Group group)

Specified by:

findUMemberships in interface GroupDAO

findUMemberships

public List<UMembership> findUMemberships(Group group,
                                          int page,
                                          int itemsPerPage)

Specified by:

findUMemberships in interface GroupDAO

findAll

public List<Group> findAll(int page,
                           int itemsPerPage)

Description copied from interface: AnyDAO

Find any objects without any limitation, according to given page and items per page.

Specified by:

findAll in interface AnyDAO<Group>

Parameters:

page - search result page

itemsPerPage - items per search result page

Returns:

any objects of type AnyDAO matching the provided conditions

findAllKeys

public List<String> findAllKeys(int page,
                                int itemsPerPage)

Description copied from interface: AnyDAO

Find any objects' keys without any limitation, according to given page and items per page.

Specified by:

findAllKeys in interface AnyDAO<Group>

Parameters:

page - search result page

itemsPerPage - items per search result page

Returns:

any objects' keys matching the provided conditions

buildDynMembershipCond

protected SearchCond buildDynMembershipCond(String baseCondFIQL)

saveAndRefreshDynMemberships

public Group saveAndRefreshDynMemberships(Group group)

Description copied from interface: GroupDAO

Saves the provided group and refreshes all User and AnyObject members.

Specified by:

saveAndRefreshDynMemberships in interface GroupDAO

Parameters:

group - group to save

Returns:

merged group

delete

public void delete(Group group)

Specified by:

delete in interface AnyDAO<Group>

findTypeExtensions

public List<TypeExtension> findTypeExtensions(AnyTypeClass anyTypeClass)

Specified by:

findTypeExtensions in interface GroupDAO

existsAMembership

@Transactional(readOnly=true)
public boolean existsAMembership(String anyObjectKey,
                                 String groupKey)

Specified by:

existsAMembership in interface GroupDAO

existsUMembership

@Transactional(readOnly=true)
public boolean existsUMembership(String userKey,
                                 String groupKey)

Specified by:

existsUMembership in interface GroupDAO

findAMembers

@Transactional(readOnly=true)
public List<String> findAMembers(String groupKey)

Specified by:

findAMembers in interface GroupDAO

findUMembers

@Transactional(readOnly=true)
public List<String> findUMembers(String groupKey)

Specified by:

findUMembers in interface GroupDAO

findADynMembers

public List<String> findADynMembers(Group group)

Specified by:

findADynMembers in interface GroupDAO

countAMembers

public int countAMembers(String groupKey)

Specified by:

countAMembers in interface GroupDAO

countUMembers

public int countUMembers(String groupKey)

Specified by:

countUMembers in interface GroupDAO

countADynMembers

public int countADynMembers(Group group)

Specified by:

countADynMembers in interface GroupDAO

countUDynMembers

public int countUDynMembers(Group group)

Specified by:

countUDynMembers in interface GroupDAO

clearADynMembers

public void clearADynMembers(Group group)

Specified by:

clearADynMembers in interface GroupDAO

findWithADynMemberships

protected List<ADynGroupMembership> findWithADynMemberships(AnyType anyType)

refreshDynMemberships

@Transactional
public Pair<Set<String>,Set<String>> refreshDynMemberships(AnyObject anyObject)

Description copied from interface: GroupDAO

Evaluates all the dynamic group membership conditions against the given anyObject (invoked during save).

Specified by:

refreshDynMemberships in interface GroupDAO

Parameters:

anyObject - anyObject being saved

Returns:

pair of groups dynamically assigned before and after refresh

removeDynMemberships

public Set<String> removeDynMemberships(AnyObject anyObject)

Description copied from interface: GroupDAO

Removes the dynamic group memberships of the given anyObject (invoked during delete).

Specified by:

removeDynMemberships in interface GroupDAO

Parameters:

anyObject - anyObject being deleted

Returns:

groups dynamically assigned before refresh

findUDynMembers

public List<String> findUDynMembers(Group group)

Specified by:

findUDynMembers in interface GroupDAO

clearUDynMembers

public void clearUDynMembers(Group group)

Specified by:

clearUDynMembers in interface GroupDAO

findWithUDynMemberships

protected List<UDynGroupMembership> findWithUDynMemberships()

refreshDynMemberships

@Transactional
public Pair<Set<String>,Set<String>> refreshDynMemberships(User user)

Description copied from interface: GroupDAO

Evaluates all the dynamic group membership conditions against the given user (invoked during save).

Specified by:

refreshDynMemberships in interface GroupDAO

Parameters:

user - user being saved

Returns:

pair of groups dynamically assigned before and after refresh

removeDynMemberships

public Set<String> removeDynMemberships(User user)

Description copied from interface: GroupDAO

Removes the dynamic group memberships of the given anyObject (invoked during delete).

Specified by:

removeDynMemberships in interface GroupDAO

Parameters:

user - user being deleted

Returns:

groups dynamically assigned before refresh

findAllResourceKeys

@Transactional(readOnly=true)
public Collection<String> findAllResourceKeys(String key)

Specified by:

findAllResourceKeys in interface AnyDAO<Group>

Specified by:

findAllResourceKeys in interface GroupDAO