Package edu.internet2.middleware.grouper.app.ccure

Class CCureTargetDao

java.lang.Object

edu.internet2.middleware.grouper.app.provisioning.targetDao.GrouperProvisionerTargetDaoBase

edu.internet2.middleware.grouper.app.ccure.CCureTargetDao

public class CCureTargetDao
extends GrouperProvisionerTargetDaoBase

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	CCureTargetDao.CCureGroup
static final record	CCureTargetDao.CCureMembership
static final record	CCureTargetDao.CCureUser

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_BATCH_SIZE
static final int	INSERT_DELETE_MEMBERSHIP_BATCH_SIZE
static final int	RETRIEVE_ENTITIES_BATCH_SIZE
static final int	RETRIEVE_GROUPS_BATCH_SIZE
static final int	RETRIEVE_MEMBERSHIPS_BATCH_SIZE

Constructor Summary

Constructors

Constructor	Description
CCureTargetDao()

Method Summary

Modifier and Type	Method	Description
TargetDaoDeleteMembershipsResponse	deleteMemberships(TargetDaoDeleteMembershipsRequest targetDaoDeleteMembershipsRequest)	delete all these Memberships and either throw exception for all or mark each one with an exception set each provisioning object as "provisioned" after the insert/update/delete is done e.g. targetObject.setProvisioned(true)
void	finalize()
TargetDaoInsertMembershipsResponse	insertMemberships(TargetDaoInsertMembershipsRequest targetDaoInsertMembershipsRequest)	insert all these Memberships and either throw exception for all or mark each one with an exception set each provisioning object as "provisioned" after the insert/update/delete is done e.g. targetObject.setProvisioned(true)
boolean	loggingStart()	start logging the source low level actions
String	loggingStop()	stop logging and get the output only call this if you successfully started the logging
void	registerGrouperProvisionerDaoCapabilities(GrouperProvisionerDaoCapabilities grouperProvisionerDaoCapabilities)
TargetDaoRetrieveAllDataResponse	retrieveAllData(TargetDaoRetrieveAllDataRequest targetDaoRetrieveAllDataRequest)	retrieve all data from the target
TargetDaoRetrieveAllEntitiesResponse	retrieveAllEntities(TargetDaoRetrieveAllEntitiesRequest targetDaoRetrieveAllEntitiesRequest)	dont return null
TargetDaoRetrieveAllGroupsResponse	retrieveAllGroups(TargetDaoRetrieveAllGroupsRequest targetDaoRetrieveAllGroupsRequest)
TargetDaoRetrieveAllMembershipsResponse	retrieveAllMemberships(TargetDaoRetrieveAllMembershipsRequest targetDaoRetrieveAllMembershipsRequest)
CCureExternalSystem	retrieveCcureExternalSystem()
TargetDaoRetrieveEntityResponse	retrieveEntity(TargetDaoRetrieveEntityRequest targetDaoRetrieveEntityRequest)	return a Entity by matching id of grouper target Entity, or null if not found
TargetDaoRetrieveGroupResponse	retrieveGroup(TargetDaoRetrieveGroupRequest targetDaoRetrieveGroupRequest)	return a group by matching id of grouper target group, or null if not found
TargetDaoRetrieveMembershipsByEntityResponse	retrieveMembershipsByEntity(TargetDaoRetrieveMembershipsByEntityRequest targetDaoRetrieveMembershipsByEntityRequest)	bulk retrieve all target provisioning Memberships related to these entity
TargetDaoRetrieveMembershipsByGroupResponse	retrieveMembershipsByGroup(TargetDaoRetrieveMembershipsByGroupRequest targetDaoRetrieveMembershipsByGroupRequest)	bulk retrieve all target provisioning Memberships related to these group
void	setExceptionForMembershipsWhenEntityAttributes(ProvisioningEntity targetEntity, List<ProvisioningObjectChange> changes, Exception e)	This duplicates some of the functionality of the same method in the TargetDaoAdapter.
TargetDaoUpdateEntitiesResponse	updateEntities(TargetDaoUpdateEntitiesRequest targetDaoUpdateEntitiesRequest)	Deprecated.
TargetDaoUpdateEntityResponse	updateEntity(TargetDaoUpdateEntityRequest targetDaoUpdateEntityRequest)	set each provisioning object as "provisioned" after the insert/update/delete is done e.g. targetObject.setProvisioned(true)

Methods inherited from class edu.internet2.middleware.grouper.app.provisioning.targetDao.GrouperProvisionerTargetDaoBase

addTargetDaoTimingInfo, deleteEntities, deleteEntity, deleteGroup, deleteGroups, deleteMembership, getGrouperProvisioner, getGrouperProvisionerDaoCapabilities, getTargetDaoTimingInfos, insertEntities, insertEntity, insertGroup, insertGroups, insertMembership, replaceGroupMemberships, retrieveEntities, retrieveGroups, retrieveIncrementalData, retrieveMembership, retrieveMemberships, retrieveMembershipsByEntities, retrieveMembershipsByGroups, retrievePerItemInParallel, sendChangesToTarget, sendEntityChangesToTarget, sendGroupChangesToTarget, sendMembershipChangesToTarget, setGrouperProvisioner, setGrouperProvisionerDaoCapabilities, setTargetDaoTimingInfos, updateGroup, updateGroups, updateMembership, updateMemberships

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_BATCH_SIZE

public static final int DEFAULT_BATCH_SIZE

See Also:

• Constant Field Values

RETRIEVE_ENTITIES_BATCH_SIZE

public static final int RETRIEVE_ENTITIES_BATCH_SIZE

See Also:

• Constant Field Values

RETRIEVE_GROUPS_BATCH_SIZE

public static final int RETRIEVE_GROUPS_BATCH_SIZE

See Also:

• Constant Field Values

RETRIEVE_MEMBERSHIPS_BATCH_SIZE

public static final int RETRIEVE_MEMBERSHIPS_BATCH_SIZE

See Also:

• Constant Field Values

INSERT_DELETE_MEMBERSHIP_BATCH_SIZE

public static final int INSERT_DELETE_MEMBERSHIP_BATCH_SIZE

See Also:

• Constant Field Values

Constructor Details

CCureTargetDao

public CCureTargetDao()

Method Details

finalize

public void finalize()

Overrides:

finalize in class Object

retrieveCcureExternalSystem

public CCureExternalSystem retrieveCcureExternalSystem()

loggingStart

public boolean loggingStart()

Description copied from class: GrouperProvisionerTargetDaoBase

start logging the source low level actions

Overrides:

loggingStart in class GrouperProvisionerTargetDaoBase

Returns:

true if the logging was started (i.e. can be stopped), or false if already started (in which case somewhere up the stack with stop it so dont stop it)

loggingStop

public String loggingStop()

Description copied from class: GrouperProvisionerTargetDaoBase

stop logging and get the output only call this if you successfully started the logging

Overrides:

loggingStop in class GrouperProvisionerTargetDaoBase

registerGrouperProvisionerDaoCapabilities

public void registerGrouperProvisionerDaoCapabilities(GrouperProvisionerDaoCapabilities grouperProvisionerDaoCapabilities)

Specified by:

registerGrouperProvisionerDaoCapabilities in class GrouperProvisionerTargetDaoBase

retrieveAllData

public TargetDaoRetrieveAllDataResponse retrieveAllData(TargetDaoRetrieveAllDataRequest targetDaoRetrieveAllDataRequest)

Description copied from class: GrouperProvisionerTargetDaoBase

retrieve all data from the target

Overrides:

retrieveAllData in class GrouperProvisionerTargetDaoBase

retrieveAllGroups

public TargetDaoRetrieveAllGroupsResponse retrieveAllGroups(TargetDaoRetrieveAllGroupsRequest targetDaoRetrieveAllGroupsRequest)

Overrides:

retrieveAllGroups in class GrouperProvisionerTargetDaoBase

retrieveAllEntities

public TargetDaoRetrieveAllEntitiesResponse retrieveAllEntities(TargetDaoRetrieveAllEntitiesRequest targetDaoRetrieveAllEntitiesRequest)

Description copied from class: GrouperProvisionerTargetDaoBase

dont return null

Overrides:

retrieveAllEntities in class GrouperProvisionerTargetDaoBase

Returns:

retrieveEntity

public TargetDaoRetrieveEntityResponse retrieveEntity(TargetDaoRetrieveEntityRequest targetDaoRetrieveEntityRequest)

Description copied from class: GrouperProvisionerTargetDaoBase

return a Entity by matching id of grouper target Entity, or null if not found

Overrides:

retrieveEntity in class GrouperProvisionerTargetDaoBase

Returns:

the target provisioning Entity or null if not found

retrieveGroup

public TargetDaoRetrieveGroupResponse retrieveGroup(TargetDaoRetrieveGroupRequest targetDaoRetrieveGroupRequest)

Description copied from class: GrouperProvisionerTargetDaoBase

return a group by matching id of grouper target group, or null if not found

Overrides:

retrieveGroup in class GrouperProvisionerTargetDaoBase

Returns:

the target provisioning group or null if not found

retrieveAllMemberships

public TargetDaoRetrieveAllMembershipsResponse retrieveAllMemberships(TargetDaoRetrieveAllMembershipsRequest targetDaoRetrieveAllMembershipsRequest)

Overrides:

retrieveAllMemberships in class GrouperProvisionerTargetDaoBase

retrieveMembershipsByEntity

public TargetDaoRetrieveMembershipsByEntityResponse retrieveMembershipsByEntity(TargetDaoRetrieveMembershipsByEntityRequest targetDaoRetrieveMembershipsByEntityRequest)

Description copied from class: GrouperProvisionerTargetDaoBase

bulk retrieve all target provisioning Memberships related to these entity

Overrides:

retrieveMembershipsByEntity in class GrouperProvisionerTargetDaoBase

Returns:

the memberships

retrieveMembershipsByGroup

public TargetDaoRetrieveMembershipsByGroupResponse retrieveMembershipsByGroup(TargetDaoRetrieveMembershipsByGroupRequest targetDaoRetrieveMembershipsByGroupRequest)

Description copied from class: GrouperProvisionerTargetDaoBase

bulk retrieve all target provisioning Memberships related to these group

Overrides:

retrieveMembershipsByGroup in class GrouperProvisionerTargetDaoBase

Returns:

the memberships

updateEntity

public TargetDaoUpdateEntityResponse updateEntity(TargetDaoUpdateEntityRequest targetDaoUpdateEntityRequest)

Description copied from class: GrouperProvisionerTargetDaoBase

set each provisioning object as "provisioned" after the insert/update/delete is done e.g. targetObject.setProvisioned(true)

Overrides:

updateEntity in class GrouperProvisionerTargetDaoBase

updateEntities

@Deprecated
public TargetDaoUpdateEntitiesResponse updateEntities(TargetDaoUpdateEntitiesRequest targetDaoUpdateEntitiesRequest)

Deprecated.

Description copied from class: GrouperProvisionerTargetDaoBase

insert all these Entities and either throw exception for all or mark each one with an exception set each provisioning object as "provisioned" after the insert/update/delete is done e.g. targetObject.setProvisioned(true)

Overrides:

updateEntities in class GrouperProvisionerTargetDaoBase

deleteMemberships

public TargetDaoDeleteMembershipsResponse deleteMemberships(TargetDaoDeleteMembershipsRequest targetDaoDeleteMembershipsRequest)

Description copied from class: GrouperProvisionerTargetDaoBase

delete all these Memberships and either throw exception for all or mark each one with an exception set each provisioning object as "provisioned" after the insert/update/delete is done e.g. targetObject.setProvisioned(true)

Overrides:

deleteMemberships in class GrouperProvisionerTargetDaoBase

insertMemberships

public TargetDaoInsertMembershipsResponse insertMemberships(TargetDaoInsertMembershipsRequest targetDaoInsertMembershipsRequest)

Description copied from class: GrouperProvisionerTargetDaoBase

insert all these Memberships and either throw exception for all or mark each one with an exception set each provisioning object as "provisioned" after the insert/update/delete is done e.g. targetObject.setProvisioned(true)

Overrides:

insertMemberships in class GrouperProvisionerTargetDaoBase

setExceptionForMembershipsWhenEntityAttributes

public void setExceptionForMembershipsWhenEntityAttributes(ProvisioningEntity targetEntity,
 List<ProvisioningObjectChange> changes,
 Exception e)

This duplicates some of the functionality of the same method in the TargetDaoAdapter. However, that method sets the error message but not the error code (GRP-6173), so membership errors get missed